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

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



6027
6028
6029
 
# File 'lib/google/apis/content_v2/classes.rb', line 6027

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) 


5938
5939
5940
 
# File 'lib/google/apis/content_v2/classes.rb', line 5938

def batch_id
  @batch_id
end

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

Required for cancel method. Corresponds to the JSON property cancel

Returns:



5943
5944
5945
 
# File 'lib/google/apis/content_v2/classes.rb', line 5943

def cancel
  @cancel
end

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

Required for cancelLineItem method. Corresponds to the JSON property cancelLineItem

Returns:



5948
5949
5950
 
# File 'lib/google/apis/content_v2/classes.rb', line 5948

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:



5953
5954
5955
 
# File 'lib/google/apis/content_v2/classes.rb', line 5953

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) 


5958
5959
5960
 
# File 'lib/google/apis/content_v2/classes.rb', line 5958

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) 


5964
5965
5966
 
# File 'lib/google/apis/content_v2/classes.rb', line 5964

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) 


5974
5975
5976
 
# File 'lib/google/apis/content_v2/classes.rb', line 5974

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) 


5980
5981
5982
 
# File 'lib/google/apis/content_v2/classes.rb', line 5980

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) 


5985
5986
5987
 
# File 'lib/google/apis/content_v2/classes.rb', line 5985

def order_id
  @order_id
end

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

Required for refund method. Corresponds to the JSON property refund

Returns:



5990
5991
5992
 
# File 'lib/google/apis/content_v2/classes.rb', line 5990

def refund
  @refund
end

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

Required for rejectReturnLineItem method. Corresponds to the JSON property rejectReturnLineItem

Returns:



5995
5996
5997
 
# File 'lib/google/apis/content_v2/classes.rb', line 5995

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:



6000
6001
6002
 
# File 'lib/google/apis/content_v2/classes.rb', line 6000

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:



6005
6006
6007
 
# File 'lib/google/apis/content_v2/classes.rb', line 6005

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:



6010
6011
6012
 
# File 'lib/google/apis/content_v2/classes.rb', line 6010

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:



6015
6016
6017
 
# File 'lib/google/apis/content_v2/classes.rb', line 6015

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:



6020
6021
6022
 
# File 'lib/google/apis/content_v2/classes.rb', line 6020

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:



6025
6026
6027
 
# File 'lib/google/apis/content_v2/classes.rb', line 6025

def update_shipment
  @update_shipment
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
 
# File 'lib/google/apis/content_v2/classes.rb', line 6032

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