Class: Google::Apis::ContentV2::OrdersRefundRequest

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/content_v2/classes.rb,
lib/google/apis/content_v2/representations.rb,
lib/google/apis/content_v2/representations.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ OrdersRefundRequest

Returns a new instance of OrdersRefundRequest.



6947
6948
6949
 
# File 'lib/google/apis/content_v2/classes.rb', line 6947

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:



6914
6915
6916
 
# File 'lib/google/apis/content_v2/classes.rb', line 6914

def amount
  @amount
end

#amount_pretax ⇒ Google::Apis::ContentV2::Price

The amount that is refunded. Either amount or amountPretax should be filled. Corresponds to the JSON property amountPretax

Returns:



6919
6920
6921
 
# File 'lib/google/apis/content_v2/classes.rb', line 6919

def amount_pretax
  @amount_pretax
end

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

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

Returns:



6925
6926
6927
 
# File 'lib/google/apis/content_v2/classes.rb', line 6925

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


6930
6931
6932
 
# File 'lib/google/apis/content_v2/classes.rb', line 6930

def operation_id
  @operation_id
end

#reason ⇒ String

The reason for the refund. Acceptable values are: - "adjustment" - " courtesyAdjustment" - "customerCanceled" - "customerDiscretionaryReturn" - "deliveredLateByCarrier" - "feeAdjustment" - "lateShipmentCredit" - " noInventory" - "other" - "priceError" - "productArrivedDamaged" - " productNotAsDescribed" - "shippingCostAdjustment" - "taxAdjustment" - " undeliverableShippingAddress" - "wrongProductShipped" Corresponds to the JSON property reason

Returns:

  • (String) 


6940
6941
6942
 
# File 'lib/google/apis/content_v2/classes.rb', line 6940

def reason
  @reason
end

#reason_text ⇒ String

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

Returns:

  • (String) 


6945
6946
6947
 
# File 'lib/google/apis/content_v2/classes.rb', line 6945

def reason_text
  @reason_text
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6952
6953
6954
6955
6956
6957
6958
6959
 
# File 'lib/google/apis/content_v2/classes.rb', line 6952

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)
  @operation_id = args[:operation_id] if args.key?(:operation_id)
  @reason = args[:reason] if args.key?(:reason)
  @reason_text = args[:reason_text] if args.key?(:reason_text)
end