|
| 1 | +// File generated from our OpenAPI spec |
| 2 | +package com.stripe.model.delegatedcheckout; |
| 3 | + |
| 4 | +import com.google.gson.annotations.SerializedName; |
| 5 | +import com.stripe.exception.StripeException; |
| 6 | +import com.stripe.model.HasId; |
| 7 | +import com.stripe.model.StripeObject; |
| 8 | +import com.stripe.net.ApiRequest; |
| 9 | +import com.stripe.net.ApiRequestParams; |
| 10 | +import com.stripe.net.ApiResource; |
| 11 | +import com.stripe.net.BaseAddress; |
| 12 | +import com.stripe.net.RequestOptions; |
| 13 | +import com.stripe.net.StripeResponseGetter; |
| 14 | +import com.stripe.param.delegatedcheckout.RequestedSessionConfirmParams; |
| 15 | +import com.stripe.param.delegatedcheckout.RequestedSessionCreateParams; |
| 16 | +import com.stripe.param.delegatedcheckout.RequestedSessionExpireParams; |
| 17 | +import com.stripe.param.delegatedcheckout.RequestedSessionRetrieveParams; |
| 18 | +import com.stripe.param.delegatedcheckout.RequestedSessionUpdateParams; |
| 19 | +import java.util.Map; |
| 20 | +import lombok.EqualsAndHashCode; |
| 21 | +import lombok.Getter; |
| 22 | +import lombok.Setter; |
| 23 | + |
| 24 | +/** A requested session is a session that has been requested by a customer. */ |
| 25 | +@Getter |
| 26 | +@Setter |
| 27 | +@EqualsAndHashCode(callSuper = false) |
| 28 | +public class RequestedSession extends ApiResource implements HasId { |
| 29 | + /** |
| 30 | + * Three-letter <a href="https://www.iso.org/iso-4217-currency-codes.html">ISO currency code</a>, |
| 31 | + * in lowercase. Must be a <a href="https://stripe.com/docs/currencies">supported currency</a>. |
| 32 | + */ |
| 33 | + @SerializedName("currency") |
| 34 | + String currency; |
| 35 | + |
| 36 | + /** The customer for this requested session. */ |
| 37 | + @SerializedName("customer") |
| 38 | + String customer; |
| 39 | + |
| 40 | + @SerializedName("fulfillment_details") |
| 41 | + FulfillmentDetails fulfillmentDetails; |
| 42 | + |
| 43 | + /** Unique identifier for the object. */ |
| 44 | + @Getter(onMethod_ = {@Override}) |
| 45 | + @SerializedName("id") |
| 46 | + String id; |
| 47 | + |
| 48 | + /** |
| 49 | + * Has the value {@code true} if the object exists in live mode or the value {@code false} if the |
| 50 | + * object exists in test mode. |
| 51 | + */ |
| 52 | + @SerializedName("livemode") |
| 53 | + Boolean livemode; |
| 54 | + |
| 55 | + /** |
| 56 | + * String representing the object's type. Objects of the same type share the same value. |
| 57 | + * |
| 58 | + * <p>Equal to {@code delegated_checkout.requested_session}. |
| 59 | + */ |
| 60 | + @SerializedName("object") |
| 61 | + String object; |
| 62 | + |
| 63 | + /** Confirms a requested session. */ |
| 64 | + public RequestedSession confirm() throws StripeException { |
| 65 | + return confirm((Map<String, Object>) null, (RequestOptions) null); |
| 66 | + } |
| 67 | + |
| 68 | + /** Confirms a requested session. */ |
| 69 | + public RequestedSession confirm(RequestOptions options) throws StripeException { |
| 70 | + return confirm((Map<String, Object>) null, options); |
| 71 | + } |
| 72 | + |
| 73 | + /** Confirms a requested session. */ |
| 74 | + public RequestedSession confirm(Map<String, Object> params) throws StripeException { |
| 75 | + return confirm(params, (RequestOptions) null); |
| 76 | + } |
| 77 | + |
| 78 | + /** Confirms a requested session. */ |
| 79 | + public RequestedSession confirm(Map<String, Object> params, RequestOptions options) |
| 80 | + throws StripeException { |
| 81 | + String path = |
| 82 | + String.format( |
| 83 | + "/v1/delegated_checkout/requested_sessions/%s/confirm", |
| 84 | + ApiResource.urlEncodeId(this.getId())); |
| 85 | + ApiRequest request = |
| 86 | + new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.POST, path, params, options); |
| 87 | + return getResponseGetter().request(request, RequestedSession.class); |
| 88 | + } |
| 89 | + |
| 90 | + /** Confirms a requested session. */ |
| 91 | + public RequestedSession confirm(RequestedSessionConfirmParams params) throws StripeException { |
| 92 | + return confirm(params, (RequestOptions) null); |
| 93 | + } |
| 94 | + |
| 95 | + /** Confirms a requested session. */ |
| 96 | + public RequestedSession confirm(RequestedSessionConfirmParams params, RequestOptions options) |
| 97 | + throws StripeException { |
| 98 | + String path = |
| 99 | + String.format( |
| 100 | + "/v1/delegated_checkout/requested_sessions/%s/confirm", |
| 101 | + ApiResource.urlEncodeId(this.getId())); |
| 102 | + ApiResource.checkNullTypedParams(path, params); |
| 103 | + ApiRequest request = |
| 104 | + new ApiRequest( |
| 105 | + BaseAddress.API, |
| 106 | + ApiResource.RequestMethod.POST, |
| 107 | + path, |
| 108 | + ApiRequestParams.paramsToMap(params), |
| 109 | + options); |
| 110 | + return getResponseGetter().request(request, RequestedSession.class); |
| 111 | + } |
| 112 | + |
| 113 | + /** Creates a requested session. */ |
| 114 | + public static RequestedSession create(Map<String, Object> params) throws StripeException { |
| 115 | + return create(params, (RequestOptions) null); |
| 116 | + } |
| 117 | + |
| 118 | + /** Creates a requested session. */ |
| 119 | + public static RequestedSession create(Map<String, Object> params, RequestOptions options) |
| 120 | + throws StripeException { |
| 121 | + String path = "/v1/delegated_checkout/requested_sessions"; |
| 122 | + ApiRequest request = |
| 123 | + new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.POST, path, params, options); |
| 124 | + return getGlobalResponseGetter().request(request, RequestedSession.class); |
| 125 | + } |
| 126 | + |
| 127 | + /** Creates a requested session. */ |
| 128 | + public static RequestedSession create(RequestedSessionCreateParams params) |
| 129 | + throws StripeException { |
| 130 | + return create(params, (RequestOptions) null); |
| 131 | + } |
| 132 | + |
| 133 | + /** Creates a requested session. */ |
| 134 | + public static RequestedSession create(RequestedSessionCreateParams params, RequestOptions options) |
| 135 | + throws StripeException { |
| 136 | + String path = "/v1/delegated_checkout/requested_sessions"; |
| 137 | + ApiResource.checkNullTypedParams(path, params); |
| 138 | + ApiRequest request = |
| 139 | + new ApiRequest( |
| 140 | + BaseAddress.API, |
| 141 | + ApiResource.RequestMethod.POST, |
| 142 | + path, |
| 143 | + ApiRequestParams.paramsToMap(params), |
| 144 | + options); |
| 145 | + return getGlobalResponseGetter().request(request, RequestedSession.class); |
| 146 | + } |
| 147 | + |
| 148 | + /** Expires a requested session. */ |
| 149 | + public RequestedSession expire() throws StripeException { |
| 150 | + return expire((Map<String, Object>) null, (RequestOptions) null); |
| 151 | + } |
| 152 | + |
| 153 | + /** Expires a requested session. */ |
| 154 | + public RequestedSession expire(RequestOptions options) throws StripeException { |
| 155 | + return expire((Map<String, Object>) null, options); |
| 156 | + } |
| 157 | + |
| 158 | + /** Expires a requested session. */ |
| 159 | + public RequestedSession expire(Map<String, Object> params) throws StripeException { |
| 160 | + return expire(params, (RequestOptions) null); |
| 161 | + } |
| 162 | + |
| 163 | + /** Expires a requested session. */ |
| 164 | + public RequestedSession expire(Map<String, Object> params, RequestOptions options) |
| 165 | + throws StripeException { |
| 166 | + String path = |
| 167 | + String.format( |
| 168 | + "/v1/delegated_checkout/requested_sessions/%s/expire", |
| 169 | + ApiResource.urlEncodeId(this.getId())); |
| 170 | + ApiRequest request = |
| 171 | + new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.POST, path, params, options); |
| 172 | + return getResponseGetter().request(request, RequestedSession.class); |
| 173 | + } |
| 174 | + |
| 175 | + /** Expires a requested session. */ |
| 176 | + public RequestedSession expire(RequestedSessionExpireParams params) throws StripeException { |
| 177 | + return expire(params, (RequestOptions) null); |
| 178 | + } |
| 179 | + |
| 180 | + /** Expires a requested session. */ |
| 181 | + public RequestedSession expire(RequestedSessionExpireParams params, RequestOptions options) |
| 182 | + throws StripeException { |
| 183 | + String path = |
| 184 | + String.format( |
| 185 | + "/v1/delegated_checkout/requested_sessions/%s/expire", |
| 186 | + ApiResource.urlEncodeId(this.getId())); |
| 187 | + ApiResource.checkNullTypedParams(path, params); |
| 188 | + ApiRequest request = |
| 189 | + new ApiRequest( |
| 190 | + BaseAddress.API, |
| 191 | + ApiResource.RequestMethod.POST, |
| 192 | + path, |
| 193 | + ApiRequestParams.paramsToMap(params), |
| 194 | + options); |
| 195 | + return getResponseGetter().request(request, RequestedSession.class); |
| 196 | + } |
| 197 | + |
| 198 | + /** Retrieves a requested session. */ |
| 199 | + public static RequestedSession retrieve(String requestedSession) throws StripeException { |
| 200 | + return retrieve(requestedSession, (Map<String, Object>) null, (RequestOptions) null); |
| 201 | + } |
| 202 | + |
| 203 | + /** Retrieves a requested session. */ |
| 204 | + public static RequestedSession retrieve(String requestedSession, RequestOptions options) |
| 205 | + throws StripeException { |
| 206 | + return retrieve(requestedSession, (Map<String, Object>) null, options); |
| 207 | + } |
| 208 | + |
| 209 | + /** Retrieves a requested session. */ |
| 210 | + public static RequestedSession retrieve( |
| 211 | + String requestedSession, Map<String, Object> params, RequestOptions options) |
| 212 | + throws StripeException { |
| 213 | + String path = |
| 214 | + String.format( |
| 215 | + "/v1/delegated_checkout/requested_sessions/%s", |
| 216 | + ApiResource.urlEncodeId(requestedSession)); |
| 217 | + ApiRequest request = |
| 218 | + new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.GET, path, params, options); |
| 219 | + return getGlobalResponseGetter().request(request, RequestedSession.class); |
| 220 | + } |
| 221 | + |
| 222 | + /** Retrieves a requested session. */ |
| 223 | + public static RequestedSession retrieve( |
| 224 | + String requestedSession, RequestedSessionRetrieveParams params, RequestOptions options) |
| 225 | + throws StripeException { |
| 226 | + String path = |
| 227 | + String.format( |
| 228 | + "/v1/delegated_checkout/requested_sessions/%s", |
| 229 | + ApiResource.urlEncodeId(requestedSession)); |
| 230 | + ApiResource.checkNullTypedParams(path, params); |
| 231 | + ApiRequest request = |
| 232 | + new ApiRequest( |
| 233 | + BaseAddress.API, |
| 234 | + ApiResource.RequestMethod.GET, |
| 235 | + path, |
| 236 | + ApiRequestParams.paramsToMap(params), |
| 237 | + options); |
| 238 | + return getGlobalResponseGetter().request(request, RequestedSession.class); |
| 239 | + } |
| 240 | + |
| 241 | + /** Updates a requested session. */ |
| 242 | + public RequestedSession update(Map<String, Object> params) throws StripeException { |
| 243 | + return update(params, (RequestOptions) null); |
| 244 | + } |
| 245 | + |
| 246 | + /** Updates a requested session. */ |
| 247 | + public RequestedSession update(Map<String, Object> params, RequestOptions options) |
| 248 | + throws StripeException { |
| 249 | + String path = |
| 250 | + String.format( |
| 251 | + "/v1/delegated_checkout/requested_sessions/%s", ApiResource.urlEncodeId(this.getId())); |
| 252 | + ApiRequest request = |
| 253 | + new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.POST, path, params, options); |
| 254 | + return getResponseGetter().request(request, RequestedSession.class); |
| 255 | + } |
| 256 | + |
| 257 | + /** Updates a requested session. */ |
| 258 | + public RequestedSession update(RequestedSessionUpdateParams params) throws StripeException { |
| 259 | + return update(params, (RequestOptions) null); |
| 260 | + } |
| 261 | + |
| 262 | + /** Updates a requested session. */ |
| 263 | + public RequestedSession update(RequestedSessionUpdateParams params, RequestOptions options) |
| 264 | + throws StripeException { |
| 265 | + String path = |
| 266 | + String.format( |
| 267 | + "/v1/delegated_checkout/requested_sessions/%s", ApiResource.urlEncodeId(this.getId())); |
| 268 | + ApiResource.checkNullTypedParams(path, params); |
| 269 | + ApiRequest request = |
| 270 | + new ApiRequest( |
| 271 | + BaseAddress.API, |
| 272 | + ApiResource.RequestMethod.POST, |
| 273 | + path, |
| 274 | + ApiRequestParams.paramsToMap(params), |
| 275 | + options); |
| 276 | + return getResponseGetter().request(request, RequestedSession.class); |
| 277 | + } |
| 278 | + |
| 279 | + /** |
| 280 | + * For more details about FulfillmentDetails, please refer to the <a |
| 281 | + * href="https://docs.stripe.com/api">API Reference.</a> |
| 282 | + */ |
| 283 | + @Getter |
| 284 | + @Setter |
| 285 | + @EqualsAndHashCode(callSuper = false) |
| 286 | + public static class FulfillmentDetails extends StripeObject {} |
| 287 | + |
| 288 | + @Override |
| 289 | + public void setResponseGetter(StripeResponseGetter responseGetter) { |
| 290 | + super.setResponseGetter(responseGetter); |
| 291 | + trySetResponseGetter(fulfillmentDetails, responseGetter); |
| 292 | + } |
| 293 | +} |
0 commit comments