@getopenpay/client/apis/CustomersApi.d.ts

OpenPay API TypeScript SDK

/**
 * OpenPay API
 * super charge your subscription management.
 *
 * The version of the OpenAPI document: 1.2.1
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import * as runtime from '../runtime';
import type { ActiveSubResponse, CreateCustomerBalanceTransactionRequest, CreateCustomerRequest, CustomerBalanceTransactionExternal, CustomerExternal, CustomerPaymentMethodQueryParams, CustomerQueryParams, ListActiveSubParams, ListResponseCustomerExternal, ListResponseUnionTokenizedCreditCardExternalPaymentMethodExternal, UpdateCustomerRequest } from '../models/index';
export interface CreateCustomerOperationRequest {
    createCustomerRequest: CreateCustomerRequest;
}
export interface CreateCustomerBalanceTransactionOperationRequest {
    customerId: string;
    createCustomerBalanceTransactionRequest: CreateCustomerBalanceTransactionRequest;
}
export interface DeleteCustomerDiscountRequest {
    customerId: string;
}
export interface GetCustomerRequest {
    customerId: string;
    expand?: Array<string>;
}
export interface GetCustomerBalanceTransactionRequest {
    customerId: string;
    transactionId: string;
}
export interface GetCustomerBalanceTransactionsRequest {
    customerId: string;
}
export interface ListCustomerPaymentMethodsRequest {
    customerId: string;
    customerPaymentMethodQueryParams: CustomerPaymentMethodQueryParams;
}
export interface ListCustomersRequest {
    customerQueryParams: CustomerQueryParams;
}
export interface ListValidSubscriptionsRequest {
    customerId: string;
    listActiveSubParams?: ListActiveSubParams;
}
export interface UpdateCustomerOperationRequest {
    customerExternalId: string;
    updateCustomerRequest: UpdateCustomerRequest;
}
/**
 *
 */
export declare class CustomersApi extends runtime.BaseAPI {
    /**
     * Create Customer
     */
    createCustomerRaw(requestParameters: CreateCustomerOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomerExternal>>;
    /**
     * Create Customer
     */
    createCustomer(requestParameters: CreateCustomerOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomerExternal>;
    /**
     * Each customer has a Balance value, which denotes a debit or credit that\'s automatically applied to their next invoice upon finalization. Creates an immutable transaction that updates the customer\'s credit balance.
     * Create Customer Balance Transaction
     */
    createCustomerBalanceTransactionRaw(requestParameters: CreateCustomerBalanceTransactionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomerBalanceTransactionExternal>>;
    /**
     * Each customer has a Balance value, which denotes a debit or credit that\'s automatically applied to their next invoice upon finalization. Creates an immutable transaction that updates the customer\'s credit balance.
     * Create Customer Balance Transaction
     */
    createCustomerBalanceTransaction(requestParameters: CreateCustomerBalanceTransactionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomerBalanceTransactionExternal>;
    /**
     * Delete Customer Discount
     */
    deleteCustomerDiscountRaw(requestParameters: DeleteCustomerDiscountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomerExternal>>;
    /**
     * Delete Customer Discount
     */
    deleteCustomerDiscount(requestParameters: DeleteCustomerDiscountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomerExternal>;
    /**
     * Get Customer
     */
    getCustomerRaw(requestParameters: GetCustomerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomerExternal>>;
    /**
     * Get Customer
     */
    getCustomer(requestParameters: GetCustomerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomerExternal>;
    /**
     * Get Customer Balance Transaction
     */
    getCustomerBalanceTransactionRaw(requestParameters: GetCustomerBalanceTransactionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomerBalanceTransactionExternal>>;
    /**
     * Get Customer Balance Transaction
     */
    getCustomerBalanceTransaction(requestParameters: GetCustomerBalanceTransactionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomerBalanceTransactionExternal>;
    /**
     * Get Customer Balance Transactions
     */
    getCustomerBalanceTransactionsRaw(requestParameters: GetCustomerBalanceTransactionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<CustomerBalanceTransactionExternal>>>;
    /**
     * Get Customer Balance Transactions
     */
    getCustomerBalanceTransactions(requestParameters: GetCustomerBalanceTransactionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<CustomerBalanceTransactionExternal>>;
    /**
     * Retrieves payment methods for a given customer. Can optionally filter by payment provider type.
     * List Customer Payment Methods
     */
    listCustomerPaymentMethodsRaw(requestParameters: ListCustomerPaymentMethodsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListResponseUnionTokenizedCreditCardExternalPaymentMethodExternal>>;
    /**
     * Retrieves payment methods for a given customer. Can optionally filter by payment provider type.
     * List Customer Payment Methods
     */
    listCustomerPaymentMethods(requestParameters: ListCustomerPaymentMethodsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListResponseUnionTokenizedCreditCardExternalPaymentMethodExternal>;
    /**
     * List Customers
     */
    listCustomersRaw(requestParameters: ListCustomersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListResponseCustomerExternal>>;
    /**
     * List Customers
     */
    listCustomers(requestParameters: ListCustomersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListResponseCustomerExternal>;
    /**
     * Lists valid subscriptions for given product_id or price_id. All \'active\' or \'trialing\' subscriptions are considered to be valid.
     * List Valid Subscriptions
     */
    listValidSubscriptionsRaw(requestParameters: ListValidSubscriptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ActiveSubResponse>>;
    /**
     * Lists valid subscriptions for given product_id or price_id. All \'active\' or \'trialing\' subscriptions are considered to be valid.
     * List Valid Subscriptions
     */
    listValidSubscriptions(requestParameters: ListValidSubscriptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ActiveSubResponse>;
    /**
     * Update Customer
     */
    updateCustomerRaw(requestParameters: UpdateCustomerOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomerExternal>>;
    /**
     * Update Customer
     */
    updateCustomer(requestParameters: UpdateCustomerOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomerExternal>;
}