com.stripe.service.CustomerCashBalanceTransactionService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of stripe-java Show documentation
Stripe Java Bindings
There is a newer version: 28.2.0
// File generated from our OpenAPI spec
package com.stripe.service;

import com.google.gson.reflect.TypeToken;
import com.stripe.exception.StripeException;
import com.stripe.model.CustomerCashBalanceTransaction;
import com.stripe.model.StripeCollection;
import com.stripe.net.ApiRequest;
import com.stripe.net.ApiRequestParams;
import com.stripe.net.ApiResource;
import com.stripe.net.ApiService;
import com.stripe.net.BaseAddress;
import com.stripe.net.RequestOptions;
import com.stripe.net.StripeResponseGetter;
import com.stripe.param.CustomerCashBalanceTransactionListParams;
import com.stripe.param.CustomerCashBalanceTransactionRetrieveParams;

public final class CustomerCashBalanceTransactionService extends ApiService {
  public CustomerCashBalanceTransactionService(StripeResponseGetter responseGetter) {
    super(responseGetter);
  }

  /**
   * Returns a list of transactions that modified the customer’s cash balance.
   */
  public StripeCollection list(
      String customer, CustomerCashBalanceTransactionListParams params) throws StripeException {
    return list(customer, params, (RequestOptions) null);
  }
  /**
   * Returns a list of transactions that modified the customer’s cash balance.
   */
  public StripeCollection list(
      String customer, RequestOptions options) throws StripeException {
    return list(customer, (CustomerCashBalanceTransactionListParams) null, options);
  }
  /**
   * Returns a list of transactions that modified the customer’s cash balance.
   */
  public StripeCollection list(String customer)
      throws StripeException {
    return list(customer, (CustomerCashBalanceTransactionListParams) null, (RequestOptions) null);
  }
  /**
   * Returns a list of transactions that modified the customer’s cash balance.
   */
  public StripeCollection list(
      String customer, CustomerCashBalanceTransactionListParams params, RequestOptions options)
      throws StripeException {
    String path =
        String.format(
            "/v1/customers/%s/cash_balance_transactions", ApiResource.urlEncodeId(customer));
    ApiRequest request =
        new ApiRequest(
            BaseAddress.API,
            ApiResource.RequestMethod.GET,
            path,
            ApiRequestParams.paramsToMap(params),
            options);
    return this.request(
        request, new TypeToken>() {}.getType());
  }
  /**
   * Retrieves a specific cash balance transaction, which updated the customer’s cash balance.
   */
  public CustomerCashBalanceTransaction retrieve(
      String customer, String transaction, CustomerCashBalanceTransactionRetrieveParams params)
      throws StripeException {
    return retrieve(customer, transaction, params, (RequestOptions) null);
  }
  /**
   * Retrieves a specific cash balance transaction, which updated the customer’s cash balance.
   */
  public CustomerCashBalanceTransaction retrieve(
      String customer, String transaction, RequestOptions options) throws StripeException {
    return retrieve(
        customer, transaction, (CustomerCashBalanceTransactionRetrieveParams) null, options);
  }
  /**
   * Retrieves a specific cash balance transaction, which updated the customer’s cash balance.
   */
  public CustomerCashBalanceTransaction retrieve(String customer, String transaction)
      throws StripeException {
    return retrieve(
        customer,
        transaction,
        (CustomerCashBalanceTransactionRetrieveParams) null,
        (RequestOptions) null);
  }
  /**
   * Retrieves a specific cash balance transaction, which updated the customer’s cash balance.
   */
  public CustomerCashBalanceTransaction retrieve(
      String customer,
      String transaction,
      CustomerCashBalanceTransactionRetrieveParams params,
      RequestOptions options)
      throws StripeException {
    String path =
        String.format(
            "/v1/customers/%s/cash_balance_transactions/%s",
            ApiResource.urlEncodeId(customer), ApiResource.urlEncodeId(transaction));
    ApiRequest request =
        new ApiRequest(
            BaseAddress.API,
            ApiResource.RequestMethod.GET,
            path,
            ApiRequestParams.paramsToMap(params),
            options);
    return this.request(request, CustomerCashBalanceTransaction.class);
  }
}