Class: Google::Apis::ContentV2::OrdersCustomBatchRequestEntryCancelLineItem

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

Returns a new instance of OrdersCustomBatchRequestEntryCancelLineItem.



6251
6252
6253
 
# File 'generated/google/apis/content_v2/classes.rb', line 6251

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

Instance Attribute Details

#amount ⇒ Google::Apis::ContentV2::Price

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

Returns:



6209
6210
6211
 
# File 'generated/google/apis/content_v2/classes.rb', line 6209

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:



6216
6217
6218
 
# File 'generated/google/apis/content_v2/classes.rb', line 6216

def amount_pretax
  @amount_pretax
end

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

Tax amount that corresponds to cancellation amount in amountPretax. Optional, but if filled, then amountPretax must be set. Calculated automatically if not provided. Corresponds to the JSON property amountTax

Returns:



6223
6224
6225
 
# File 'generated/google/apis/content_v2/classes.rb', line 6223

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) 


6228
6229
6230
 
# File 'generated/google/apis/content_v2/classes.rb', line 6228

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


6234
6235
6236
 
# File 'generated/google/apis/content_v2/classes.rb', line 6234

def product_id
  @product_id
end

#quantity ⇒ Fixnum

The quantity to cancel. Corresponds to the JSON property quantity

Returns:

  • (Fixnum) 


6239
6240
6241
 
# File 'generated/google/apis/content_v2/classes.rb', line 6239

def quantity
  @quantity
end

#reason ⇒ String

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

Returns:

  • (String) 


6244
6245
6246
 
# File 'generated/google/apis/content_v2/classes.rb', line 6244

def reason
  @reason
end

#reason_text ⇒ String

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

Returns:

  • (String) 


6249
6250
6251
 
# File 'generated/google/apis/content_v2/classes.rb', line 6249

def reason_text
  @reason_text
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
 
# File 'generated/google/apis/content_v2/classes.rb', line 6256

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