@getopenpay/client/models/InvoiceQueryParams.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 type { CollectionMethodEnum } from './CollectionMethodEnum';
import type { BillingReasonEnum } from './BillingReasonEnum';
import type { DateTimeFilter } from './DateTimeFilter';
import type { IntRangeFilter } from './IntRangeFilter';
import type { InvoiceStatusEnum } from './InvoiceStatusEnum';
import type { SearchFilter } from './SearchFilter';
import type { CurrencyEnum } from './CurrencyEnum';
/**
 *
 * @export
 * @interface InvoiceQueryParams
 */
export interface InvoiceQueryParams {
    /**
     *
     * @type {BillingReasonEnum}
     * @memberof InvoiceQueryParams
     */
    billingReason?: BillingReasonEnum | null;
    /**
     *
     * @type {CollectionMethodEnum}
     * @memberof InvoiceQueryParams
     */
    collectionMethod?: CollectionMethodEnum | null;
    /**
     *
     * @type {string}
     * @memberof InvoiceQueryParams
     */
    couponId?: string | null;
    /**
     *
     * @type {DateTimeFilter}
     * @memberof InvoiceQueryParams
     */
    createdAt?: DateTimeFilter | null;
    /**
     *
     * @type {CurrencyEnum}
     * @memberof InvoiceQueryParams
     */
    currency?: CurrencyEnum | null;
    /**
     *
     * @type {string}
     * @memberof InvoiceQueryParams
     */
    customerId?: string | null;
    /**
     * Specifies which fields in the response should be expanded.
     * @type {Array<string>}
     * @memberof InvoiceQueryParams
     */
    expand?: Array<string>;
    /**
     * Page number
     * @type {number}
     * @memberof InvoiceQueryParams
     */
    pageNumber?: number;
    /**
     * Page size
     * @type {number}
     * @memberof InvoiceQueryParams
     */
    pageSize?: number;
    /**
     *
     * @type {DateTimeFilter}
     * @memberof InvoiceQueryParams
     */
    periodEnd?: DateTimeFilter | null;
    /**
     *
     * @type {DateTimeFilter}
     * @memberof InvoiceQueryParams
     */
    periodStart?: DateTimeFilter | null;
    /**
     *
     * @type {SearchFilter}
     * @memberof InvoiceQueryParams
     */
    search?: SearchFilter | null;
    /**
     * Sort direction.
     * @type {boolean}
     * @memberof InvoiceQueryParams
     */
    sortDescending?: boolean;
    /**
     * Key name based on which data is sorted.
     * @type {string}
     * @memberof InvoiceQueryParams
     */
    sortKey?: string;
    /**
     *
     * @type {InvoiceStatusEnum}
     * @memberof InvoiceQueryParams
     */
    status?: InvoiceStatusEnum | null;
    /**
     *
     * @type {string}
     * @memberof InvoiceQueryParams
     */
    subscriptionId?: string | null;
    /**
     *
     * @type {IntRangeFilter}
     * @memberof InvoiceQueryParams
     */
    totalAmountAtom?: IntRangeFilter | null;
    /**
     *
     * @type {DateTimeFilter}
     * @memberof InvoiceQueryParams
     */
    updatedAt?: DateTimeFilter | null;
}
/**
 * Check if a given object implements the InvoiceQueryParams interface.
 */
export declare function instanceOfInvoiceQueryParams(value: object): value is InvoiceQueryParams;
export declare function InvoiceQueryParamsFromJSON(json: any): InvoiceQueryParams;
export declare function InvoiceQueryParamsFromJSONTyped(json: any, ignoreDiscriminator: boolean): InvoiceQueryParams;
export declare function InvoiceQueryParamsToJSON(json: any): InvoiceQueryParams;
export declare function InvoiceQueryParamsToJSONTyped(value?: InvoiceQueryParams | null, ignoreDiscriminator?: boolean): any;