Class: Google::Apis::ContentV2_1::OrdersCancelLineItemRequest

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/content_v2_1/classes.rb,
generated/google/apis/content_v2_1/representations.rb,
generated/google/apis/content_v2_1/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.



6260
6261
6262
# File 'generated/google/apis/content_v2_1/classes.rb', line 6260

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

Instance Attribute Details

#line_item_idString

The ID of the line item to cancel. Either lineItemId or productId is required. Corresponds to the JSON property lineItemId

Returns:

  • (String)


6221
6222
6223
# File 'generated/google/apis/content_v2_1/classes.rb', line 6221

def line_item_id
  @line_item_id
end

#operation_idString

The ID of the operation. Unique across all operations for a given order. Corresponds to the JSON property operationId

Returns:

  • (String)


6226
6227
6228
# File 'generated/google/apis/content_v2_1/classes.rb', line 6226

def operation_id
  @operation_id
end

#product_idString

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)


6232
6233
6234
# File 'generated/google/apis/content_v2_1/classes.rb', line 6232

def product_id
  @product_id
end

#quantityFixnum

The quantity to cancel. Corresponds to the JSON property quantity

Returns:

  • (Fixnum)


6237
6238
6239
# File 'generated/google/apis/content_v2_1/classes.rb', line 6237

def quantity
  @quantity
end

#reasonString

The reason for the cancellation. Acceptable values are:

  • "customerInitiatedCancel"
  • "invalidCoupon"
  • "malformedShippingAddress"
  • "noInventory"
  • "other"
  • "priceError"
  • "shippingPriceError"
  • "taxError"
  • "undeliverableShippingAddress"
  • "unsupportedPoBoxAddress" Corresponds to the JSON property reason

Returns:

  • (String)


6253
6254
6255
# File 'generated/google/apis/content_v2_1/classes.rb', line 6253

def reason
  @reason
end

#reason_textString

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

Returns:

  • (String)


6258
6259
6260
# File 'generated/google/apis/content_v2_1/classes.rb', line 6258

def reason_text
  @reason_text
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6265
6266
6267
6268
6269
6270
6271
6272
# File 'generated/google/apis/content_v2_1/classes.rb', line 6265

def update!(**args)
  @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