Class: Google::Apis::ContentV2::OrdersCancelLineItemRequest

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

Returns a new instance of OrdersCancelLineItemRequest



5013
5014
5015
 
# File 'generated/google/apis/content_v2/classes.rb', line 5013

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

Instance Attribute Details

#amount ⇒ Google::Apis::ContentV2::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 amount

Returns:



4968
4969
4970
 
# File 'generated/google/apis/content_v2/classes.rb', line 4968

def amount
  @amount
end

#amount_pretax ⇒ Google::Apis::ContentV2::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:



4975
4976
4977
 
# File 'generated/google/apis/content_v2/classes.rb', line 4975

def amount_pretax
  @amount_pretax
end

#amount_tax ⇒ Google::Apis::ContentV2::Price

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

Returns:



4980
4981
4982
 
# File 'generated/google/apis/content_v2/classes.rb', line 4980

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) 


4985
4986
4987
 
# File 'generated/google/apis/content_v2/classes.rb', line 4985

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) 


4990
4991
4992
 
# File 'generated/google/apis/content_v2/classes.rb', line 4990

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) 


4996
4997
4998
 
# File 'generated/google/apis/content_v2/classes.rb', line 4996

def product_id
  @product_id
end

#quantity ⇒ Fixnum

The quantity to cancel. Corresponds to the JSON property quantity

Returns:

  • (Fixnum) 


5001
5002
5003
 
# File 'generated/google/apis/content_v2/classes.rb', line 5001

def quantity
  @quantity
end

#reason ⇒ String

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

Returns:

  • (String) 


5006
5007
5008
 
# File 'generated/google/apis/content_v2/classes.rb', line 5006

def reason
  @reason
end

#reason_text ⇒ String

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

Returns:

  • (String) 


5011
5012
5013
 
# File 'generated/google/apis/content_v2/classes.rb', line 5011

def reason_text
  @reason_text
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
 
# File 'generated/google/apis/content_v2/classes.rb', line 5018

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