com.paypal.sdk.models.OrdersCaptureInput Maven / Gradle / Ivy
/*
* PaypalServerSdkLib
*
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
*/
package com.paypal.sdk.models;
import com.fasterxml.jackson.annotation.JsonGetter;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonSetter;
/**
* This is a model class for OrdersCaptureInput type.
*/
public class OrdersCaptureInput {
private String id;
private String contentType;
private String paypalRequestId;
private String prefer;
private String paypalClientMetadataId;
private String paypalAuthAssertion;
private OrderCaptureRequest body;
/**
* Default constructor.
*/
public OrdersCaptureInput() {
contentType = "application/json";
prefer = "return=minimal";
}
/**
* Initialization constructor.
* @param id String value for id.
* @param contentType String value for contentType.
* @param paypalRequestId String value for paypalRequestId.
* @param prefer String value for prefer.
* @param paypalClientMetadataId String value for paypalClientMetadataId.
* @param paypalAuthAssertion String value for paypalAuthAssertion.
* @param body OrderCaptureRequest value for body.
*/
public OrdersCaptureInput(
String id,
String contentType,
String paypalRequestId,
String prefer,
String paypalClientMetadataId,
String paypalAuthAssertion,
OrderCaptureRequest body) {
this.id = id;
this.contentType = contentType;
this.paypalRequestId = paypalRequestId;
this.prefer = prefer;
this.paypalClientMetadataId = paypalClientMetadataId;
this.paypalAuthAssertion = paypalAuthAssertion;
this.body = body;
}
/**
* Getter for Id.
* The ID of the order for which to capture a payment.
* @return Returns the String
*/
@JsonGetter("id")
public String getId() {
return id;
}
/**
* Setter for Id.
* The ID of the order for which to capture a payment.
* @param id Value for String
*/
@JsonSetter("id")
public void setId(String id) {
this.id = id;
}
/**
* Getter for ContentType.
* @return Returns the String
*/
@JsonGetter("Content-Type")
public String getContentType() {
return contentType;
}
/**
* Setter for ContentType.
* @param contentType Value for String
*/
@JsonSetter("Content-Type")
private void setContentType(String contentType) {
this.contentType = contentType;
}
/**
* Getter for PaypalRequestId.
* The server stores keys for 6 hours. The API callers can request the times to up to 72 hours
* by speaking to their Account Manager. It is mandatory for all single-step create order calls
* (E.g. Create Order Request with payment source information like Card, PayPal.vault_id,
* PayPal.billing_agreement_id, etc).
* @return Returns the String
*/
@JsonGetter("PayPal-Request-Id")
@JsonInclude(JsonInclude.Include.NON_NULL)
public String getPaypalRequestId() {
return paypalRequestId;
}
/**
* Setter for PaypalRequestId.
* The server stores keys for 6 hours. The API callers can request the times to up to 72 hours
* by speaking to their Account Manager. It is mandatory for all single-step create order calls
* (E.g. Create Order Request with payment source information like Card, PayPal.vault_id,
* PayPal.billing_agreement_id, etc).
* @param paypalRequestId Value for String
*/
@JsonSetter("PayPal-Request-Id")
public void setPaypalRequestId(String paypalRequestId) {
this.paypalRequestId = paypalRequestId;
}
/**
* Getter for Prefer.
* The preferred server response upon successful completion of the request. Value
* is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize
* communication between the API caller and the server. A minimal response includes the
* <code>id</code>, <code>status</code> and HATEOAS
* links.</li><li><code>return=representation</code>. The server returns a complete resource
* representation, including the current state of the resource.</li></ul>
* @return Returns the String
*/
@JsonGetter("Prefer")
@JsonInclude(JsonInclude.Include.NON_NULL)
public String getPrefer() {
return prefer;
}
/**
* Setter for Prefer.
* The preferred server response upon successful completion of the request. Value
* is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize
* communication between the API caller and the server. A minimal response includes the
* <code>id</code>, <code>status</code> and HATEOAS
* links.</li><li><code>return=representation</code>. The server returns a complete resource
* representation, including the current state of the resource.</li></ul>
* @param prefer Value for String
*/
@JsonSetter("Prefer")
public void setPrefer(String prefer) {
this.prefer = prefer;
}
/**
* Getter for PaypalClientMetadataId.
* @return Returns the String
*/
@JsonGetter("PayPal-Client-Metadata-Id")
@JsonInclude(JsonInclude.Include.NON_NULL)
public String getPaypalClientMetadataId() {
return paypalClientMetadataId;
}
/**
* Setter for PaypalClientMetadataId.
* @param paypalClientMetadataId Value for String
*/
@JsonSetter("PayPal-Client-Metadata-Id")
public void setPaypalClientMetadataId(String paypalClientMetadataId) {
this.paypalClientMetadataId = paypalClientMetadataId;
}
/**
* Getter for PaypalAuthAssertion.
* An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For
* details, see <a
* href="https://developer.paypal.com/api/rest/requests/#paypal-auth-assertion">PayPal-Auth-Assertion</a>.
* @return Returns the String
*/
@JsonGetter("PayPal-Auth-Assertion")
@JsonInclude(JsonInclude.Include.NON_NULL)
public String getPaypalAuthAssertion() {
return paypalAuthAssertion;
}
/**
* Setter for PaypalAuthAssertion.
* An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For
* details, see <a
* href="https://developer.paypal.com/api/rest/requests/#paypal-auth-assertion">PayPal-Auth-Assertion</a>.
* @param paypalAuthAssertion Value for String
*/
@JsonSetter("PayPal-Auth-Assertion")
public void setPaypalAuthAssertion(String paypalAuthAssertion) {
this.paypalAuthAssertion = paypalAuthAssertion;
}
/**
* Getter for Body.
* @return Returns the OrderCaptureRequest
*/
@JsonGetter("body")
@JsonInclude(JsonInclude.Include.NON_NULL)
public OrderCaptureRequest getBody() {
return body;
}
/**
* Setter for Body.
* @param body Value for OrderCaptureRequest
*/
@JsonSetter("body")
public void setBody(OrderCaptureRequest body) {
this.body = body;
}
/**
* Converts this OrdersCaptureInput into string format.
* @return String representation of this class
*/
@Override
public String toString() {
return "OrdersCaptureInput [" + "id=" + id + ", contentType=" + contentType
+ ", paypalRequestId=" + paypalRequestId + ", prefer=" + prefer
+ ", paypalClientMetadataId=" + paypalClientMetadataId + ", paypalAuthAssertion="
+ paypalAuthAssertion + ", body=" + body + "]";
}
/**
* Builds a new {@link OrdersCaptureInput.Builder} object.
* Creates the instance with the state of the current model.
* @return a new {@link OrdersCaptureInput.Builder} object
*/
public Builder toBuilder() {
Builder builder = new Builder(id, contentType)
.paypalRequestId(getPaypalRequestId())
.prefer(getPrefer())
.paypalClientMetadataId(getPaypalClientMetadataId())
.paypalAuthAssertion(getPaypalAuthAssertion())
.body(getBody());
return builder;
}
/**
* Class to build instances of {@link OrdersCaptureInput}.
*/
public static class Builder {
private String id;
private String contentType = "application/json";
private String paypalRequestId;
private String prefer = "return=minimal";
private String paypalClientMetadataId;
private String paypalAuthAssertion;
private OrderCaptureRequest body;
/**
* Initialization constructor.
*/
public Builder() {
}
/**
* Initialization constructor.
* @param id String value for id.
* @param contentType String value for contentType.
*/
public Builder(String id, String contentType) {
this.id = id;
this.contentType = contentType;
}
/**
* Setter for id.
* @param id String value for id.
* @return Builder
*/
public Builder id(String id) {
this.id = id;
return this;
}
/**
* Setter for contentType.
* @param contentType String value for contentType.
* @return Builder
*/
public Builder contentType(String contentType) {
this.contentType = contentType;
return this;
}
/**
* Setter for paypalRequestId.
* @param paypalRequestId String value for paypalRequestId.
* @return Builder
*/
public Builder paypalRequestId(String paypalRequestId) {
this.paypalRequestId = paypalRequestId;
return this;
}
/**
* Setter for prefer.
* @param prefer String value for prefer.
* @return Builder
*/
public Builder prefer(String prefer) {
this.prefer = prefer;
return this;
}
/**
* Setter for paypalClientMetadataId.
* @param paypalClientMetadataId String value for paypalClientMetadataId.
* @return Builder
*/
public Builder paypalClientMetadataId(String paypalClientMetadataId) {
this.paypalClientMetadataId = paypalClientMetadataId;
return this;
}
/**
* Setter for paypalAuthAssertion.
* @param paypalAuthAssertion String value for paypalAuthAssertion.
* @return Builder
*/
public Builder paypalAuthAssertion(String paypalAuthAssertion) {
this.paypalAuthAssertion = paypalAuthAssertion;
return this;
}
/**
* Setter for body.
* @param body OrderCaptureRequest value for body.
* @return Builder
*/
public Builder body(OrderCaptureRequest body) {
this.body = body;
return this;
}
/**
* Builds a new {@link OrdersCaptureInput} object using the set fields.
* @return {@link OrdersCaptureInput}
*/
public OrdersCaptureInput build() {
return new OrdersCaptureInput(id, contentType, paypalRequestId, prefer,
paypalClientMetadataId, paypalAuthAssertion, body);
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy