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



4196
4197
4198
 
# File 'generated/google/apis/content_v2/classes.rb', line 4196

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:



4151
4152
4153
 
# File 'generated/google/apis/content_v2/classes.rb', line 4151

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:



4158
4159
4160
 
# File 'generated/google/apis/content_v2/classes.rb', line 4158

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:



4163
4164
4165
 
# File 'generated/google/apis/content_v2/classes.rb', line 4163

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) 


4168
4169
4170
 
# File 'generated/google/apis/content_v2/classes.rb', line 4168

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) 


4173
4174
4175
 
# File 'generated/google/apis/content_v2/classes.rb', line 4173

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) 


4179
4180
4181
 
# File 'generated/google/apis/content_v2/classes.rb', line 4179

def product_id
  @product_id
end

#quantity ⇒ Fixnum

The quantity to cancel. Corresponds to the JSON property quantity

Returns:

  • (Fixnum) 


4184
4185
4186
 
# File 'generated/google/apis/content_v2/classes.rb', line 4184

def quantity
  @quantity
end

#reason ⇒ String

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

Returns:

  • (String) 


4189
4190
4191
 
# File 'generated/google/apis/content_v2/classes.rb', line 4189

def reason
  @reason
end

#reason_text ⇒ String

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

Returns:

  • (String) 


4194
4195
4196
 
# File 'generated/google/apis/content_v2/classes.rb', line 4194

def reason_text
  @reason_text
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
 
# File 'generated/google/apis/content_v2/classes.rb', line 4201

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