google-api-client 0.40.0 → 0.41.0

data/generated/google/apis/content_v2_1/classes.rb

@@ -4012,6 +4012,11 @@ module Google
         attr_accessor :acknowledged
         alias_method :acknowledged?, :acknowledged
       
+        # List of key-value pairs that are attached to a given order.
+        # Corresponds to the JSON property `annotations`
+        # @return [Array<Google::Apis::ContentV2_1::OrderOrderAnnotation>]
+        attr_accessor :annotations
+      
         # The billing address.
         # Corresponds to the JSON property `billingAddress`
         # @return [Google::Apis::ContentV2_1::OrderAddress]
@@ -4160,6 +4165,7 @@ module Google
         # Update properties of this object
         def update!(**args)
           @acknowledged = args[:acknowledged] if args.key?(:acknowledged)
+          @annotations = args[:annotations] if args.key?(:annotations)
           @billing_address = args[:billing_address] if args.key?(:billing_address)
           @customer = args[:customer] if args.key?(:customer)
           @delivery_details = args[:delivery_details] if args.key?(:delivery_details)
@@ -4830,6 +4836,12 @@ module Google
         # @return [Google::Apis::ContentV2_1::OrderLineItemShippingDetailsMethod]
         attr_accessor :method_prop
       
+        # The promised time in minutes in which the order will be ready for pickup. This
+        # only applies to buy-online-pickup-in-store same-day order.
+        # Corresponds to the JSON property `pickupPromiseInMinutes`
+        # @return [Fixnum]
+        attr_accessor :pickup_promise_in_minutes
+      
         # Required. The ship by date, in ISO 8601 format.
         # Corresponds to the JSON property `shipByDate`
         # @return [String]
@@ -4852,6 +4864,7 @@ module Google
         def update!(**args)
           @deliver_by_date = args[:deliver_by_date] if args.key?(:deliver_by_date)
           @method_prop = args[:method_prop] if args.key?(:method_prop)
+          @pickup_promise_in_minutes = args[:pickup_promise_in_minutes] if args.key?(:pickup_promise_in_minutes)
           @ship_by_date = args[:ship_by_date] if args.key?(:ship_by_date)
           @type = args[:type] if args.key?(:type)
         end
@@ -4922,6 +4935,31 @@ module Google
         end
       end
       
+      # 
+      class OrderOrderAnnotation
+        include Google::Apis::Core::Hashable
+      
+        # Key for additional google provided (as key-value pairs) annotation.
+        # Corresponds to the JSON property `key`
+        # @return [String]
+        attr_accessor :key
+      
+        # Value for additional google provided (as key-value pairs) annotation.
+        # Corresponds to the JSON property `value`
+        # @return [String]
+        attr_accessor :value
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @key = args[:key] if args.key?(:key)
+          @value = args[:value] if args.key?(:value)
+        end
+      end
+      
       # 
       class OrderPickupDetails
         include Google::Apis::Core::Hashable
@@ -4943,6 +4981,17 @@ module Google
         # @return [String]
         attr_accessor :location_id
       
+        # The pickup type of this order.
+        # Acceptable values are:
+        # - "`merchantStore`"
+        # - "`merchantStoreCurbside`"
+        # - "`merchantStoreLocker`"
+        # - "`thirdPartyPickupPoint`"
+        # - "`thirdPartyLocker`"
+        # Corresponds to the JSON property `pickupType`
+        # @return [String]
+        attr_accessor :pickup_type
+      
         def initialize(**args)
            update!(**args)
         end
@@ -4952,6 +5001,7 @@ module Google
           @address = args[:address] if args.key?(:address)
           @collectors = args[:collectors] if args.key?(:collectors)
           @location_id = args[:location_id] if args.key?(:location_id)
+          @pickup_type = args[:pickup_type] if args.key?(:pickup_type)
         end
       end
       
@@ -4984,14 +5034,16 @@ module Google
       class OrderPromotion
         include Google::Apis::Core::Hashable
       
-        # Items which this promotion may be applied to. If empty, there are no
-        # restrictions on applicable items and quantity.
+        # Items that this promotion may be applied to. If empty, there are no
+        # restrictions on applicable items and quantity. This field will also be empty
+        # for shipping promotions because shipping is not tied to any specific item.
         # Corresponds to the JSON property `applicableItems`
         # @return [Array<Google::Apis::ContentV2_1::OrderPromotionItem>]
         attr_accessor :applicable_items
       
-        # Items which this promotion have been applied to. Do not provide for `orders.
-        # createtestorder`.
+        # Items that this promotion have been applied to. Do not provide for `orders.
+        # createtestorder`. This field will be empty for shipping promotions because
+        # shipping is not tied to any specific item.
         # Corresponds to the JSON property `appliedItems`
         # @return [Array<Google::Apis::ContentV2_1::OrderPromotionItem>]
         attr_accessor :applied_items
@@ -5478,6 +5530,11 @@ module Google
         # @return [Array<Google::Apis::ContentV2_1::OrderShipmentLineItemShipment>]
         attr_accessor :line_items
       
+        # Delivery details of the shipment if scheduling is needed.
+        # Corresponds to the JSON property `scheduledDeliveryDetails`
+        # @return [Google::Apis::ContentV2_1::OrderShipmentScheduledDeliveryDetails]
+        attr_accessor :scheduled_delivery_details
+      
         # The shipment group ID of the shipment. This is set in shiplineitems request.
         # Corresponds to the JSON property `shipmentGroupId`
         # @return [String]
@@ -5509,6 +5566,7 @@ module Google
           @delivery_date = args[:delivery_date] if args.key?(:delivery_date)
           @id = args[:id] if args.key?(:id)
           @line_items = args[:line_items] if args.key?(:line_items)
+          @scheduled_delivery_details = args[:scheduled_delivery_details] if args.key?(:scheduled_delivery_details)
           @shipment_group_id = args[:shipment_group_id] if args.key?(:shipment_group_id)
           @status = args[:status] if args.key?(:status)
           @tracking_id = args[:tracking_id] if args.key?(:tracking_id)
@@ -5548,6 +5606,31 @@ module Google
         end
       end
       
+      # 
+      class OrderShipmentScheduledDeliveryDetails
+        include Google::Apis::Core::Hashable
+      
+        # The phone number of the carrier fulfilling the delivery.
+        # Corresponds to the JSON property `carrierPhoneNumber`
+        # @return [String]
+        attr_accessor :carrier_phone_number
+      
+        # The date a shipment is scheduled for delivery, in ISO 8601 format.
+        # Corresponds to the JSON property `scheduledDate`
+        # @return [String]
+        attr_accessor :scheduled_date
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @carrier_phone_number = args[:carrier_phone_number] if args.key?(:carrier_phone_number)
+          @scheduled_date = args[:scheduled_date] if args.key?(:scheduled_date)
+        end
+      end
+      
       # 
       class OrderinvoicesCreateChargeInvoiceRequest
         include Google::Apis::Core::Hashable
@@ -6555,6 +6638,83 @@ module Google
         end
       end
       
+      # 
+      class OrdersCustomBatchRequestEntryRefundItemItem
+        include Google::Apis::Core::Hashable
+      
+        # The total amount that is refunded. (e.g. refunding $5 each for 2 products
+        # should be done by setting quantity to 2 and amount to 10$) In case of multiple
+        # refunds, this should be the amount you currently want to refund to the
+        # customer.
+        # Corresponds to the JSON property `amount`
+        # @return [Google::Apis::ContentV2_1::MonetaryAmount]
+        attr_accessor :amount
+      
+        # If true, the full item will be refunded. If this is true, amount should not be
+        # provided and will be ignored.
+        # Corresponds to the JSON property `fullRefund`
+        # @return [Boolean]
+        attr_accessor :full_refund
+        alias_method :full_refund?, :full_refund
+      
+        # The ID of the line item. Either lineItemId or productId is required.
+        # Corresponds to the JSON property `lineItemId`
+        # @return [String]
+        attr_accessor :line_item_id
+      
+        # The ID of the product. This is the REST ID used in the products service.
+        # Either lineItemId or productId is required.
+        # Corresponds to the JSON property `productId`
+        # @return [String]
+        attr_accessor :product_id
+      
+        # The number of products that are refunded.
+        # Corresponds to the JSON property `quantity`
+        # @return [Fixnum]
+        attr_accessor :quantity
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @amount = args[:amount] if args.key?(:amount)
+          @full_refund = args[:full_refund] if args.key?(:full_refund)
+          @line_item_id = args[:line_item_id] if args.key?(:line_item_id)
+          @product_id = args[:product_id] if args.key?(:product_id)
+          @quantity = args[:quantity] if args.key?(:quantity)
+        end
+      end
+      
+      # 
+      class OrdersCustomBatchRequestEntryRefundItemShipping
+        include Google::Apis::Core::Hashable
+      
+        # The amount that is refunded. If this is not the first refund for the shipment,
+        # this should be the newly refunded amount.
+        # Corresponds to the JSON property `amount`
+        # @return [Google::Apis::ContentV2_1::Price]
+        attr_accessor :amount
+      
+        # If set to true, all shipping costs for the order will be refunded. If this is
+        # true, amount should not be provided and will be ignored.
+        # Corresponds to the JSON property `fullRefund`
+        # @return [Boolean]
+        attr_accessor :full_refund
+        alias_method :full_refund?, :full_refund
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @amount = args[:amount] if args.key?(:amount)
+          @full_refund = args[:full_refund] if args.key?(:full_refund)
+        end
+      end
+      
       # 
       class OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo
         include Google::Apis::Core::Hashable
@@ -6780,6 +6940,173 @@ module Google
         end
       end
       
+      # 
+      class OrdersRefundItemRequest
+        include Google::Apis::Core::Hashable
+      
+        # The items that are refunded. Either Item or Shipping must be provided in the
+        # request.
+        # Corresponds to the JSON property `items`
+        # @return [Array<Google::Apis::ContentV2_1::OrdersCustomBatchRequestEntryRefundItemItem>]
+        attr_accessor :items
+      
+        # The ID of the operation. Unique across all operations for a given order.
+        # Corresponds to the JSON property `operationId`
+        # @return [String]
+        attr_accessor :operation_id
+      
+        # The reason for the refund.
+        # Acceptable values are:
+        # - "`shippingCostAdjustment`"
+        # - "`priceAdjustment`"
+        # - "`taxAdjustment`"
+        # - "`feeAdjustment`"
+        # - "`courtesyAdjustment`"
+        # - "`adjustment`"
+        # - "`customerCancelled`"
+        # - "`noInventory`"
+        # - "`productNotAsDescribed`"
+        # - "`undeliverableShippingAddress`"
+        # - "`wrongProductShipped`"
+        # - "`lateShipmentCredit`"
+        # - "`deliveredLateByCarrier`"
+        # - "`productArrivedDamaged`"
+        # Corresponds to the JSON property `reason`
+        # @return [String]
+        attr_accessor :reason
+      
+        # The explanation of the reason.
+        # Corresponds to the JSON property `reasonText`
+        # @return [String]
+        attr_accessor :reason_text
+      
+        # The refund on shipping. Optional, but either Item or Shipping must be provided
+        # in the request.
+        # Corresponds to the JSON property `shipping`
+        # @return [Google::Apis::ContentV2_1::OrdersCustomBatchRequestEntryRefundItemShipping]
+        attr_accessor :shipping
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @items = args[:items] if args.key?(:items)
+          @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)
+          @shipping = args[:shipping] if args.key?(:shipping)
+        end
+      end
+      
+      # 
+      class OrdersRefundItemResponse
+        include Google::Apis::Core::Hashable
+      
+        # The status of the execution.
+        # Acceptable values are:
+        # - "`duplicate`"
+        # - "`executed`"
+        # Corresponds to the JSON property `executionStatus`
+        # @return [String]
+        attr_accessor :execution_status
+      
+        # Identifies what kind of resource this is. Value: the fixed string "content#
+        # ordersRefundItemResponse".
+        # Corresponds to the JSON property `kind`
+        # @return [String]
+        attr_accessor :kind
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @execution_status = args[:execution_status] if args.key?(:execution_status)
+          @kind = args[:kind] if args.key?(:kind)
+        end
+      end
+      
+      # 
+      class OrdersRefundOrderRequest
+        include Google::Apis::Core::Hashable
+      
+        # 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`
+        # @return [Google::Apis::ContentV2_1::MonetaryAmount]
+        attr_accessor :amount
+      
+        # 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`
+        # @return [Boolean]
+        attr_accessor :full_refund
+        alias_method :full_refund?, :full_refund
+      
+        # The ID of the operation. Unique across all operations for a given order.
+        # Corresponds to the JSON property `operationId`
+        # @return [String]
+        attr_accessor :operation_id
+      
+        # The reason for the refund.
+        # Acceptable values are:
+        # - "`courtesyAdjustment`"
+        # - "`other`"
+        # Corresponds to the JSON property `reason`
+        # @return [String]
+        attr_accessor :reason
+      
+        # The explanation of the reason.
+        # Corresponds to the JSON property `reasonText`
+        # @return [String]
+        attr_accessor :reason_text
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        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
+      end
+      
+      # 
+      class OrdersRefundOrderResponse
+        include Google::Apis::Core::Hashable
+      
+        # The status of the execution.
+        # Acceptable values are:
+        # - "`duplicate`"
+        # - "`executed`"
+        # Corresponds to the JSON property `executionStatus`
+        # @return [String]
+        attr_accessor :execution_status
+      
+        # Identifies what kind of resource this is. Value: the fixed string "content#
+        # ordersRefundOrderResponse".
+        # Corresponds to the JSON property `kind`
+        # @return [String]
+        attr_accessor :kind
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @execution_status = args[:execution_status] if args.key?(:execution_status)
+          @kind = args[:kind] if args.key?(:kind)
+        end
+      end
+      
       # 
       class OrdersRejectReturnLineItemRequest
         include Google::Apis::Core::Hashable
@@ -7259,11 +7586,24 @@ module Google
         # @return [String]
         attr_accessor :delivery_date
       
+        # Date after which the pickup will expire, in ISO 8601 format. Required only
+        # when order is buy-online-pickup-in-store(BOPIS) and `status` is `ready for
+        # pickup`.
+        # Corresponds to the JSON property `lastPickupDate`
+        # @return [String]
+        attr_accessor :last_pickup_date
+      
         # The ID of the operation. Unique across all operations for a given order.
         # Corresponds to the JSON property `operationId`
         # @return [String]
         attr_accessor :operation_id
       
+        # Date on which the shipment has been ready for pickup, in ISO 8601 format.
+        # Optional and can be provided only if `status` is `ready for pickup`.
+        # Corresponds to the JSON property `readyPickupDate`
+        # @return [String]
+        attr_accessor :ready_pickup_date
+      
         # The ID of the shipment.
         # Corresponds to the JSON property `shipmentId`
         # @return [String]
@@ -7273,6 +7613,7 @@ module Google
         # Acceptable values are:
         # - "`delivered`"
         # - "`undeliverable`"
+        # - "`readyForPickup`"
         # Corresponds to the JSON property `status`
         # @return [String]
         attr_accessor :status
@@ -7282,6 +7623,12 @@ module Google
         # @return [String]
         attr_accessor :tracking_id
       
+        # Date on which the shipment has been undeliverable, in ISO 8601 format.
+        # Optional and can be provided only if `status` is `undeliverable`.
+        # Corresponds to the JSON property `undeliveredDate`
+        # @return [String]
+        attr_accessor :undelivered_date
+      
         def initialize(**args)
            update!(**args)
         end
@@ -7290,10 +7637,13 @@ module Google
         def update!(**args)
           @carrier = args[:carrier] if args.key?(:carrier)
           @delivery_date = args[:delivery_date] if args.key?(:delivery_date)
+          @last_pickup_date = args[:last_pickup_date] if args.key?(:last_pickup_date)
           @operation_id = args[:operation_id] if args.key?(:operation_id)
+          @ready_pickup_date = args[:ready_pickup_date] if args.key?(:ready_pickup_date)
           @shipment_id = args[:shipment_id] if args.key?(:shipment_id)
           @status = args[:status] if args.key?(:status)
           @tracking_id = args[:tracking_id] if args.key?(:tracking_id)
+          @undelivered_date = args[:undelivered_date] if args.key?(:undelivered_date)
         end
       end
       
@@ -8227,6 +8577,11 @@ module Google
         # @return [String]
         attr_accessor :brand
       
+        # Link to the canonical version of the landing page.
+        # Corresponds to the JSON property `canonicalLink`
+        # @return [String]
+        attr_accessor :canonical_link
+      
         # Required. The item's channel (online or local).
         # Acceptable values are:
         # - "`local`"
@@ -8381,7 +8736,7 @@ module Google
         # @return [Array<String>]
         attr_accessor :included_destinations
       
-        # Number and amount of installments to pay for an item. Brazil only.
+        # Number and amount of installments to pay for an item.
         # Corresponds to the JSON property `installment`
         # @return [Google::Apis::ContentV2_1::Installment]
         attr_accessor :installment
@@ -8474,6 +8829,16 @@ module Google
         # @return [Google::Apis::ContentV2_1::Price]
         attr_accessor :price
       
+        # Technical specification or additional product details
+        # Corresponds to the JSON property `productDetails`
+        # @return [Array<Google::Apis::ContentV2_1::ProductProductDetail>]
+        attr_accessor :product_details
+      
+        # List of important bullet points describing the product
+        # Corresponds to the JSON property `productHighlights`
+        # @return [Array<String>]
+        attr_accessor :product_highlights
+      
         # Categories of the item (formatted as in products data specification).
         # Corresponds to the JSON property `productTypes`
         # @return [Array<String>]
@@ -8557,6 +8922,12 @@ module Google
         # @return [String]
         attr_accessor :source
       
+        # Number of periods (months or years) and amount of payment per period for an
+        # item with an associated subscription contract.
+        # Corresponds to the JSON property `subscriptionCost`
+        # @return [Google::Apis::ContentV2_1::ProductSubscriptionCost]
+        attr_accessor :subscription_cost
+      
         # Required. The CLDR territory code for the item.
         # Corresponds to the JSON property `targetCountry`
         # @return [String]
@@ -8609,6 +8980,7 @@ module Google
           @availability = args[:availability] if args.key?(:availability)
           @availability_date = args[:availability_date] if args.key?(:availability_date)
           @brand = args[:brand] if args.key?(:brand)
+          @canonical_link = args[:canonical_link] if args.key?(:canonical_link)
           @channel = args[:channel] if args.key?(:channel)
           @color = args[:color] if args.key?(:color)
           @condition = args[:condition] if args.key?(:condition)
@@ -8653,6 +9025,8 @@ module Google
           @offer_id = args[:offer_id] if args.key?(:offer_id)
           @pattern = args[:pattern] if args.key?(:pattern)
           @price = args[:price] if args.key?(:price)
+          @product_details = args[:product_details] if args.key?(:product_details)
+          @product_highlights = args[:product_highlights] if args.key?(:product_highlights)
           @product_types = args[:product_types] if args.key?(:product_types)
           @promotion_ids = args[:promotion_ids] if args.key?(:promotion_ids)
           @sale_price = args[:sale_price] if args.key?(:sale_price)
@@ -8668,6 +9042,7 @@ module Google
           @size_type = args[:size_type] if args.key?(:size_type)
           @sizes = args[:sizes] if args.key?(:sizes)
           @source = args[:source] if args.key?(:source)
+          @subscription_cost = args[:subscription_cost] if args.key?(:subscription_cost)
           @target_country = args[:target_country] if args.key?(:target_country)
           @tax_category = args[:tax_category] if args.key?(:tax_category)
           @taxes = args[:taxes] if args.key?(:taxes)
@@ -8709,6 +9084,37 @@ module Google
         end
       end
       
+      # 
+      class ProductProductDetail
+        include Google::Apis::Core::Hashable
+      
+        # The name of the product detail.
+        # Corresponds to the JSON property `attributeName`
+        # @return [String]
+        attr_accessor :attribute_name
+      
+        # The value of the product detail.
+        # Corresponds to the JSON property `attributeValue`
+        # @return [String]
+        attr_accessor :attribute_value
+      
+        # The section header used to group a set of product details.
+        # Corresponds to the JSON property `sectionName`
+        # @return [String]
+        attr_accessor :section_name
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @attribute_name = args[:attribute_name] if args.key?(:attribute_name)
+          @attribute_value = args[:attribute_value] if args.key?(:attribute_value)
+          @section_name = args[:section_name] if args.key?(:section_name)
+        end
+      end
+      
       # 
       class ProductShipping
         include Google::Apis::Core::Hashable
@@ -8896,7 +9302,7 @@ module Google
         # @return [String]
         attr_accessor :destination
       
-        # 
+        # Destination approval status in `targetCountry` of the offer.
         # Corresponds to the JSON property `status`
         # @return [String]
         attr_accessor :status
@@ -8973,6 +9379,37 @@ module Google
         end
       end
       
+      # 
+      class ProductSubscriptionCost
+        include Google::Apis::Core::Hashable
+      
+        # The amount the buyer has to pay per subscription period.
+        # Corresponds to the JSON property `amount`
+        # @return [Google::Apis::ContentV2_1::Price]
+        attr_accessor :amount
+      
+        # The type of subscription period.
+        # Corresponds to the JSON property `period`
+        # @return [String]
+        attr_accessor :period
+      
+        # The number of subscription periods the buyer has to pay.
+        # Corresponds to the JSON property `periodLength`
+        # @return [Fixnum]
+        attr_accessor :period_length
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @amount = args[:amount] if args.key?(:amount)
+          @period = args[:period] if args.key?(:period)
+          @period_length = args[:period_length] if args.key?(:period_length)
+        end
+      end
+      
       # 
       class ProductTax
         include Google::Apis::Core::Hashable
@@ -10128,6 +10565,7 @@ module Google
         # - "`new`"
         # - "`shipped`"
         # - "`undeliverable`"
+        # - "`pending`"
         # Corresponds to the JSON property `state`
         # @return [String]
         attr_accessor :state