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.



8559
8560
8561
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8559

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:



8534
8535
8536
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8534

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) 


8540
8541
8542
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8540

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) 


8546
8547
8548
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8546

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) 


8552
8553
8554
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8552

def reason
  @reason
end

#reason_text ⇒ String

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

Returns:

  • (String) 


8557
8558
8559
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8557

def reason_text
  @reason_text
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8564
8565
8566
8567
8568
8569
8570
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8564

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