Class: Google::Apis::ContentV2_1::OrdersRefundOrderRequest

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ OrdersRefundOrderRequest

Returns a new instance of OrdersRefundOrderRequest.



8673
8674
8675
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8673

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

Instance Attribute Details

#amount ⇒ Google::Apis::ContentV2_1::MonetaryAmount

The amount that is refunded. If this is not the first refund for the order, this should be the newly refunded amount. Corresponds to the JSON property amount

Returns:



8648
8649
8650
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8648

def amount
  @amount
end

#full_refund ⇒ Boolean Also known as: full_refund?

If true, the full order will be refunded, including shipping. If this is true, amount should not be provided and will be ignored. Corresponds to the JSON property fullRefund

Returns:

  • (Boolean) 


8654
8655
8656
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8654

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


8660
8661
8662
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8660

def operation_id
  @operation_id
end

#reason ⇒ String

The reason for the refund. Acceptable values are: - "courtesyAdjustment" - " other" Corresponds to the JSON property reason

Returns:

  • (String) 


8666
8667
8668
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8666

def reason
  @reason
end

#reason_text ⇒ String

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

Returns:

  • (String) 


8671
8672
8673
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8671

def reason_text
  @reason_text
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8678
8679
8680
8681
8682
8683
8684
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8678

def update!(**args)
  @amount = args[:amount] if args.key?(:amount)
  @full_refund = args[:full_refund] if args.key?(:full_refund)
  @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