Class: Google::Apis::ContentV2::OrderLineItem

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/content_v2/classes.rb,
generated/google/apis/content_v2/representations.rb,
generated/google/apis/content_v2/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) ⇒ OrderLineItem

Returns a new instance of OrderLineItem



3532
3533
3534
 
# File 'generated/google/apis/content_v2/classes.rb', line 3532

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

Instance Attribute Details

#annotations ⇒ Array<Google::Apis::ContentV2::OrderMerchantProvidedAnnotation>

Annotations that are attached to the line item. Corresponds to the JSON property annotations

Returns:



3458
3459
3460
 
# File 'generated/google/apis/content_v2/classes.rb', line 3458

def annotations
  @annotations
end

#cancellations ⇒ Array<Google::Apis::ContentV2::OrderCancellation>

Cancellations of the line item. Corresponds to the JSON property cancellations

Returns:



3463
3464
3465
 
# File 'generated/google/apis/content_v2/classes.rb', line 3463

def cancellations
  @cancellations
end

#id ⇒ String

The id of the line item. Corresponds to the JSON property id

Returns:

  • (String) 


3468
3469
3470
 
# File 'generated/google/apis/content_v2/classes.rb', line 3468

def id
  @id
end

#price ⇒ Google::Apis::ContentV2::Price

Total price for the line item. For example, if two items for $10 are purchased, the total price will be $20. Corresponds to the JSON property price

Returns:



3474
3475
3476
 
# File 'generated/google/apis/content_v2/classes.rb', line 3474

def price
  @price
end

#product ⇒ Google::Apis::ContentV2::OrderLineItemProduct

Product data from the time of the order placement. Corresponds to the JSON property product

Returns:



3479
3480
3481
 
# File 'generated/google/apis/content_v2/classes.rb', line 3479

def product
  @product
end

#quantity_canceled ⇒ Fixnum

Number of items canceled. Corresponds to the JSON property quantityCanceled

Returns:

  • (Fixnum) 


3484
3485
3486
 
# File 'generated/google/apis/content_v2/classes.rb', line 3484

def quantity_canceled
  @quantity_canceled
end

#quantity_delivered ⇒ Fixnum

Number of items delivered. Corresponds to the JSON property quantityDelivered

Returns:

  • (Fixnum) 


3489
3490
3491
 
# File 'generated/google/apis/content_v2/classes.rb', line 3489

def quantity_delivered
  @quantity_delivered
end

#quantity_ordered ⇒ Fixnum

Number of items ordered. Corresponds to the JSON property quantityOrdered

Returns:

  • (Fixnum) 


3494
3495
3496
 
# File 'generated/google/apis/content_v2/classes.rb', line 3494

def quantity_ordered
  @quantity_ordered
end

#quantity_pending ⇒ Fixnum

Number of items pending. Corresponds to the JSON property quantityPending

Returns:

  • (Fixnum) 


3499
3500
3501
 
# File 'generated/google/apis/content_v2/classes.rb', line 3499

def quantity_pending
  @quantity_pending
end

#quantity_returned ⇒ Fixnum

Number of items returned. Corresponds to the JSON property quantityReturned

Returns:

  • (Fixnum) 


3504
3505
3506
 
# File 'generated/google/apis/content_v2/classes.rb', line 3504

def quantity_returned
  @quantity_returned
end

#quantity_shipped ⇒ Fixnum

Number of items shipped. Corresponds to the JSON property quantityShipped

Returns:

  • (Fixnum) 


3509
3510
3511
 
# File 'generated/google/apis/content_v2/classes.rb', line 3509

def quantity_shipped
  @quantity_shipped
end

#return_info ⇒ Google::Apis::ContentV2::OrderLineItemReturnInfo

Details of the return policy for the line item. Corresponds to the JSON property returnInfo

Returns:



3514
3515
3516
 
# File 'generated/google/apis/content_v2/classes.rb', line 3514

def return_info
  @return_info
end

#returns ⇒ Array<Google::Apis::ContentV2::OrderReturn>

Returns of the line item. Corresponds to the JSON property returns

Returns:



3519
3520
3521
 
# File 'generated/google/apis/content_v2/classes.rb', line 3519

def returns
  @returns
end

#shipping_details ⇒ Google::Apis::ContentV2::OrderLineItemShippingDetails

Details of the requested shipping for the line item. Corresponds to the JSON property shippingDetails

Returns:



3524
3525
3526
 
# File 'generated/google/apis/content_v2/classes.rb', line 3524

def shipping_details
  @shipping_details
end

#tax ⇒ Google::Apis::ContentV2::Price

Total tax amount for the line item. For example, if two items are purchased, and each have a cost tax of $2, the total tax amount will be $4. Corresponds to the JSON property tax

Returns:



3530
3531
3532
 
# File 'generated/google/apis/content_v2/classes.rb', line 3530

def tax
  @tax
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
 
# File 'generated/google/apis/content_v2/classes.rb', line 3537

def update!(**args)
  @annotations = args[:annotations] if args.key?(:annotations)
  @cancellations = args[:cancellations] if args.key?(:cancellations)
  @id = args[:id] if args.key?(:id)
  @price = args[:price] if args.key?(:price)
  @product = args[:product] if args.key?(:product)
  @quantity_canceled = args[:quantity_canceled] if args.key?(:quantity_canceled)
  @quantity_delivered = args[:quantity_delivered] if args.key?(:quantity_delivered)
  @quantity_ordered = args[:quantity_ordered] if args.key?(:quantity_ordered)
  @quantity_pending = args[:quantity_pending] if args.key?(:quantity_pending)
  @quantity_returned = args[:quantity_returned] if args.key?(:quantity_returned)
  @quantity_shipped = args[:quantity_shipped] if args.key?(:quantity_shipped)
  @return_info = args[:return_info] if args.key?(:return_info)
  @returns = args[:returns] if args.key?(:returns)
  @shipping_details = args[:shipping_details] if args.key?(:shipping_details)
  @tax = args[:tax] if args.key?(:tax)
end