com.google.api.services.content.model.OrdersRefundRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-content Show documentation
There is a newer version: v2.1-rev20241217-2.0.0
Show newest version
/*
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */
/*
 * This code was generated by https://github.com/googleapis/google-api-java-client-services/
 * Modify at your own risk.
 */

package com.google.api.services.content.model;

/**
 * Model definition for OrdersRefundRequest.
 *
 *  This is the Java data model class that specifies how to parse/serialize into the JSON that is
 * transmitted over HTTP when working with the Content API for Shopping. For a detailed explanation
 * see:
 * https://developers.google.com/api-client-library/java/google-http-java-client/json
 * 
 *
 * @author Google, Inc.
 */
@SuppressWarnings("javadoc")
public final class OrdersRefundRequest extends com.google.api.client.json.GenericJson {

  /**
   * Deprecated. Please use amountPretax and amountTax instead.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private Price amount;

  /**
   * The amount that is refunded. Either amount or amountPretax should be filled.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private Price amountPretax;

  /**
   * Tax amount that corresponds to refund amount in amountPretax. Optional, but if filled,
   * amountPretax must be set. Calculated automatically if not provided.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private Price amountTax;

  /**
   * The ID of the operation. Unique across all operations for a given order.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String operationId;

  /**
   * The reason for the refund. Acceptable values are: - "`adjustment`" - "`courtesyAdjustment`" -
   * "`customerCanceled`" - "`customerDiscretionaryReturn`" - "`deliveredLateByCarrier`" -
   * "`feeAdjustment`" - "`lateShipmentCredit`" - "`noInventory`" - "`other`" - "`priceError`" -
   * "`productArrivedDamaged`" - "`productNotAsDescribed`" - "`shippingCostAdjustment`" -
   * "`taxAdjustment`" - "`undeliverableShippingAddress`" - "`wrongProductShipped`"
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String reason;

  /**
   * The explanation of the reason.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String reasonText;

  /**
   * Deprecated. Please use amountPretax and amountTax instead.
   * @return value or {@code null} for none
   */
  public Price getAmount() {
    return amount;
  }

  /**
   * Deprecated. Please use amountPretax and amountTax instead.
   * @param amount amount or {@code null} for none
   */
  public OrdersRefundRequest setAmount(Price amount) {
    this.amount = amount;
    return this;
  }

  /**
   * The amount that is refunded. Either amount or amountPretax should be filled.
   * @return value or {@code null} for none
   */
  public Price getAmountPretax() {
    return amountPretax;
  }

  /**
   * The amount that is refunded. Either amount or amountPretax should be filled.
   * @param amountPretax amountPretax or {@code null} for none
   */
  public OrdersRefundRequest setAmountPretax(Price amountPretax) {
    this.amountPretax = amountPretax;
    return this;
  }

  /**
   * Tax amount that corresponds to refund amount in amountPretax. Optional, but if filled,
   * amountPretax must be set. Calculated automatically if not provided.
   * @return value or {@code null} for none
   */
  public Price getAmountTax() {
    return amountTax;
  }

  /**
   * Tax amount that corresponds to refund amount in amountPretax. Optional, but if filled,
   * amountPretax must be set. Calculated automatically if not provided.
   * @param amountTax amountTax or {@code null} for none
   */
  public OrdersRefundRequest setAmountTax(Price amountTax) {
    this.amountTax = amountTax;
    return this;
  }

  /**
   * The ID of the operation. Unique across all operations for a given order.
   * @return value or {@code null} for none
   */
  public java.lang.String getOperationId() {
    return operationId;
  }

  /**
   * The ID of the operation. Unique across all operations for a given order.
   * @param operationId operationId or {@code null} for none
   */
  public OrdersRefundRequest setOperationId(java.lang.String operationId) {
    this.operationId = operationId;
    return this;
  }

  /**
   * The reason for the refund. Acceptable values are: - "`adjustment`" - "`courtesyAdjustment`" -
   * "`customerCanceled`" - "`customerDiscretionaryReturn`" - "`deliveredLateByCarrier`" -
   * "`feeAdjustment`" - "`lateShipmentCredit`" - "`noInventory`" - "`other`" - "`priceError`" -
   * "`productArrivedDamaged`" - "`productNotAsDescribed`" - "`shippingCostAdjustment`" -
   * "`taxAdjustment`" - "`undeliverableShippingAddress`" - "`wrongProductShipped`"
   * @return value or {@code null} for none
   */
  public java.lang.String getReason() {
    return reason;
  }

  /**
   * The reason for the refund. Acceptable values are: - "`adjustment`" - "`courtesyAdjustment`" -
   * "`customerCanceled`" - "`customerDiscretionaryReturn`" - "`deliveredLateByCarrier`" -
   * "`feeAdjustment`" - "`lateShipmentCredit`" - "`noInventory`" - "`other`" - "`priceError`" -
   * "`productArrivedDamaged`" - "`productNotAsDescribed`" - "`shippingCostAdjustment`" -
   * "`taxAdjustment`" - "`undeliverableShippingAddress`" - "`wrongProductShipped`"
   * @param reason reason or {@code null} for none
   */
  public OrdersRefundRequest setReason(java.lang.String reason) {
    this.reason = reason;
    return this;
  }

  /**
   * The explanation of the reason.
   * @return value or {@code null} for none
   */
  public java.lang.String getReasonText() {
    return reasonText;
  }

  /**
   * The explanation of the reason.
   * @param reasonText reasonText or {@code null} for none
   */
  public OrdersRefundRequest setReasonText(java.lang.String reasonText) {
    this.reasonText = reasonText;
    return this;
  }

  @Override
  public OrdersRefundRequest set(String fieldName, Object value) {
    return (OrdersRefundRequest) super.set(fieldName, value);
  }

  @Override
  public OrdersRefundRequest clone() {
    return (OrdersRefundRequest) super.clone();
  }

}