Class: Google::Apis::ContentV2::OrdersCustomBatchRequestEntry

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

Constructor Details

#initialize(**args) ⇒ OrdersCustomBatchRequestEntry

Returns a new instance of OrdersCustomBatchRequestEntry.



6370
6371
6372
 
# File 'generated/google/apis/content_v2/classes.rb', line 6370

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

Instance Attribute Details

#batch_id ⇒ Fixnum

An entry ID, unique within the batch request. Corresponds to the JSON property batchId

Returns:

  • (Fixnum) 


6281
6282
6283
 
# File 'generated/google/apis/content_v2/classes.rb', line 6281

def batch_id
  @batch_id
end

#cancel ⇒ Google::Apis::ContentV2::OrdersCustomBatchRequestEntryCancel

Required for cancel method. Corresponds to the JSON property cancel

Returns:



6286
6287
6288
 
# File 'generated/google/apis/content_v2/classes.rb', line 6286

def cancel
  @cancel
end

#cancel_line_item ⇒ Google::Apis::ContentV2::OrdersCustomBatchRequestEntryCancelLineItem

Required for cancelLineItem method. Corresponds to the JSON property cancelLineItem

Returns:



6291
6292
6293
 
# File 'generated/google/apis/content_v2/classes.rb', line 6291

def cancel_line_item
  @cancel_line_item
end

#in_store_refund_line_item ⇒ Google::Apis::ContentV2::OrdersCustomBatchRequestEntryInStoreRefundLineItem

Required for inStoreReturnLineItem method. Corresponds to the JSON property inStoreRefundLineItem

Returns:



6296
6297
6298
 
# File 'generated/google/apis/content_v2/classes.rb', line 6296

def in_store_refund_line_item
  @in_store_refund_line_item
end

#merchant_id ⇒ Fixnum

The ID of the managing account. Corresponds to the JSON property merchantId

Returns:

  • (Fixnum) 


6301
6302
6303
 
# File 'generated/google/apis/content_v2/classes.rb', line 6301

def merchant_id
  @merchant_id
end

#merchant_order_id ⇒ String

The merchant order ID. Required for updateMerchantOrderId and getByMerchantOrderId methods. Corresponds to the JSON property merchantOrderId

Returns:

  • (String) 


6307
6308
6309
 
# File 'generated/google/apis/content_v2/classes.rb', line 6307

def merchant_order_id
  @merchant_order_id
end

#method_prop ⇒ String

The method of the batch entry. Acceptable values are: - "acknowledge" - " cancel" - "cancelLineItem" - "get" - "getByMerchantOrderId" - " inStoreRefundLineItem" - "refund" - "rejectReturnLineItem" - " returnLineItem" - "returnRefundLineItem" - "setLineItemMetadata" - " shipLineItems" - "updateLineItemShippingDetails" - "updateMerchantOrderId"

  • "updateShipment" Corresponds to the JSON property method

Returns:

  • (String) 


6317
6318
6319
 
# File 'generated/google/apis/content_v2/classes.rb', line 6317

def method_prop
  @method_prop
end

#operation_id ⇒ String

The ID of the operation. Unique across all operations for a given order. Required for all methods beside get and getByMerchantOrderId. Corresponds to the JSON property operationId

Returns:

  • (String) 


6323
6324
6325
 
# File 'generated/google/apis/content_v2/classes.rb', line 6323

def operation_id
  @operation_id
end

#order_id ⇒ String

The ID of the order. Required for all methods beside getByMerchantOrderId. Corresponds to the JSON property orderId

Returns:

  • (String) 


6328
6329
6330
 
# File 'generated/google/apis/content_v2/classes.rb', line 6328

def order_id
  @order_id
end

#refund ⇒ Google::Apis::ContentV2::OrdersCustomBatchRequestEntryRefund

Required for refund method. Corresponds to the JSON property refund

Returns:



6333
6334
6335
 
# File 'generated/google/apis/content_v2/classes.rb', line 6333

def refund
  @refund
end

#reject_return_line_item ⇒ Google::Apis::ContentV2::OrdersCustomBatchRequestEntryRejectReturnLineItem

Required for rejectReturnLineItem method. Corresponds to the JSON property rejectReturnLineItem

Returns:



6338
6339
6340
 
# File 'generated/google/apis/content_v2/classes.rb', line 6338

def reject_return_line_item
  @reject_return_line_item
end

#return_line_item ⇒ Google::Apis::ContentV2::OrdersCustomBatchRequestEntryReturnLineItem

Required for returnLineItem method. Corresponds to the JSON property returnLineItem

Returns:



6343
6344
6345
 
# File 'generated/google/apis/content_v2/classes.rb', line 6343

def return_line_item
  @return_line_item
end

#return_refund_line_item ⇒ Google::Apis::ContentV2::OrdersCustomBatchRequestEntryReturnRefundLineItem

Required for returnRefundLineItem method. Corresponds to the JSON property returnRefundLineItem

Returns:



6348
6349
6350
 
# File 'generated/google/apis/content_v2/classes.rb', line 6348

def return_refund_line_item
  @return_refund_line_item
end

#set_line_item_metadata ⇒ Google::Apis::ContentV2::OrdersCustomBatchRequestEntrySetLineItemMetadata

Required for setLineItemMetadata method. Corresponds to the JSON property setLineItemMetadata

Returns:



6353
6354
6355
 
# File 'generated/google/apis/content_v2/classes.rb', line 6353

def set_line_item_metadata
  @set_line_item_metadata
end

#ship_line_items ⇒ Google::Apis::ContentV2::OrdersCustomBatchRequestEntryShipLineItems

Required for shipLineItems method. Corresponds to the JSON property shipLineItems

Returns:



6358
6359
6360
 
# File 'generated/google/apis/content_v2/classes.rb', line 6358

def ship_line_items
  @ship_line_items
end

#update_line_item_shipping_details ⇒ Google::Apis::ContentV2::OrdersCustomBatchRequestEntryUpdateLineItemShippingDetails

Required for updateLineItemShippingDate method. Corresponds to the JSON property updateLineItemShippingDetails

Returns:



6363
6364
6365
 
# File 'generated/google/apis/content_v2/classes.rb', line 6363

def update_line_item_shipping_details
  @update_line_item_shipping_details
end

#update_shipment ⇒ Google::Apis::ContentV2::OrdersCustomBatchRequestEntryUpdateShipment

Required for updateShipment method. Corresponds to the JSON property updateShipment

Returns:



6368
6369
6370
 
# File 'generated/google/apis/content_v2/classes.rb', line 6368

def update_shipment
  @update_shipment
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
 
# File 'generated/google/apis/content_v2/classes.rb', line 6375

def update!(**args)
  @batch_id = args[:batch_id] if args.key?(:batch_id)
  @cancel = args[:cancel] if args.key?(:cancel)
  @cancel_line_item = args[:cancel_line_item] if args.key?(:cancel_line_item)
  @in_store_refund_line_item = args[:in_store_refund_line_item] if args.key?(:in_store_refund_line_item)
  @merchant_id = args[:merchant_id] if args.key?(:merchant_id)
  @merchant_order_id = args[:merchant_order_id] if args.key?(:merchant_order_id)
  @method_prop = args[:method_prop] if args.key?(:method_prop)
  @operation_id = args[:operation_id] if args.key?(:operation_id)
  @order_id = args[:order_id] if args.key?(:order_id)
  @refund = args[:refund] if args.key?(:refund)
  @reject_return_line_item = args[:reject_return_line_item] if args.key?(:reject_return_line_item)
  @return_line_item = args[:return_line_item] if args.key?(:return_line_item)
  @return_refund_line_item = args[:return_refund_line_item] if args.key?(:return_refund_line_item)
  @set_line_item_metadata = args[:set_line_item_metadata] if args.key?(:set_line_item_metadata)
  @ship_line_items = args[:ship_line_items] if args.key?(:ship_line_items)
  @update_line_item_shipping_details = args[:update_line_item_shipping_details] if args.key?(:update_line_item_shipping_details)
  @update_shipment = args[:update_shipment] if args.key?(:update_shipment)
end