Class: Google::Apis::ContentV2sandbox::OrdersCancelLineItemRequest

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

Returns a new instance of OrdersCancelLineItemRequest



1773
1774
1775
 
# File 'generated/google/apis/content_v2sandbox/classes.rb', line 1773

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

Instance Attribute Details

#amount ⇒ Google::Apis::ContentV2sandbox::Price

Deprecated. Please use amountPretax and amountTax instead. Corresponds to the JSON property amount

Returns:



1728
1729
1730
 
# File 'generated/google/apis/content_v2sandbox/classes.rb', line 1728

def amount
  @amount
end

#amount_pretax ⇒ Google::Apis::ContentV2sandbox::Price

Amount to refund for the cancelation. Optional. If not set, Google will calculate the default based on the price and tax of the items involved. The amount must not be larger than the net amount left on the order. Corresponds to the JSON property amountPretax

Returns:



1735
1736
1737
 
# File 'generated/google/apis/content_v2sandbox/classes.rb', line 1735

def amount_pretax
  @amount_pretax
end

#amount_tax ⇒ Google::Apis::ContentV2sandbox::Price

Tax amount that correspond to cancellation amount in amountPretax. Corresponds to the JSON property amountTax

Returns:



1740
1741
1742
 
# File 'generated/google/apis/content_v2sandbox/classes.rb', line 1740

def amount_tax
  @amount_tax
end

#line_item_id ⇒ String

The ID of the line item to cancel. Either lineItemId or productId is required. Corresponds to the JSON property lineItemId

Returns:

  • (String) 


1745
1746
1747
 
# File 'generated/google/apis/content_v2sandbox/classes.rb', line 1745

def line_item_id
  @line_item_id
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) 


1750
1751
1752
 
# File 'generated/google/apis/content_v2sandbox/classes.rb', line 1750

def operation_id
  @operation_id
end

#product_id ⇒ String

The ID of the product to cancel. This is the REST ID used in the products service. Either lineItemId or productId is required. Corresponds to the JSON property productId

Returns:

  • (String) 


1756
1757
1758
 
# File 'generated/google/apis/content_v2sandbox/classes.rb', line 1756

def product_id
  @product_id
end

#quantity ⇒ Fixnum

The quantity to cancel. Corresponds to the JSON property quantity

Returns:

  • (Fixnum) 


1761
1762
1763
 
# File 'generated/google/apis/content_v2sandbox/classes.rb', line 1761

def quantity
  @quantity
end

#reason ⇒ String

The reason for the cancellation. Corresponds to the JSON property reason

Returns:

  • (String) 


1766
1767
1768
 
# File 'generated/google/apis/content_v2sandbox/classes.rb', line 1766

def reason
  @reason
end

#reason_text ⇒ String

The explanation of the reason. Corresponds to the JSON property reasonText

Returns:

  • (String) 


1771
1772
1773
 
# File 'generated/google/apis/content_v2sandbox/classes.rb', line 1771

def reason_text
  @reason_text
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
 
# File 'generated/google/apis/content_v2sandbox/classes.rb', line 1778

def update!(**args)
  @amount = args[:amount] if args.key?(:amount)
  @amount_pretax = args[:amount_pretax] if args.key?(:amount_pretax)
  @amount_tax = args[:amount_tax] if args.key?(:amount_tax)
  @line_item_id = args[:line_item_id] if args.key?(:line_item_id)
  @operation_id = args[:operation_id] if args.key?(:operation_id)
  @product_id = args[:product_id] if args.key?(:product_id)
  @quantity = args[:quantity] if args.key?(:quantity)
  @reason = args[:reason] if args.key?(:reason)
  @reason_text = args[:reason_text] if args.key?(:reason_text)
end