@getopenpay/client/models/SubscriptionQueryParams.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 { DateTimeFilter } from './DateTimeFilter';
import type { SearchFilter } from './SearchFilter';
import type { SubscriptionStatusEnum } from './SubscriptionStatusEnum';
/**
 *
 * @export
 * @interface SubscriptionQueryParams
 */
export interface SubscriptionQueryParams {
    /**
     *
     * @type {string}
     * @memberof SubscriptionQueryParams
     */
    couponId?: string | null;
    /**
     *
     * @type {DateTimeFilter}
     * @memberof SubscriptionQueryParams
     */
    createdAt?: DateTimeFilter | null;
    /**
     *
     * @type {DateTimeFilter}
     * @memberof SubscriptionQueryParams
     */
    currentPeriodEnd?: DateTimeFilter | null;
    /**
     *
     * @type {DateTimeFilter}
     * @memberof SubscriptionQueryParams
     */
    currentPeriodStart?: DateTimeFilter | null;
    /**
     *
     * @type {string}
     * @memberof SubscriptionQueryParams
     */
    customerId?: string | null;
    /**
     * Specifies which fields in the response should be expanded.
     * @type {Array<string>}
     * @memberof SubscriptionQueryParams
     */
    expand?: Array<string>;
    /**
     * Page number
     * @type {number}
     * @memberof SubscriptionQueryParams
     */
    pageNumber?: number;
    /**
     * Page size
     * @type {number}
     * @memberof SubscriptionQueryParams
     */
    pageSize?: number;
    /**
     *
     * @type {string}
     * @memberof SubscriptionQueryParams
     */
    priceId?: string | null;
    /**
     *
     * @type {string}
     * @memberof SubscriptionQueryParams
     */
    productId?: string | null;
    /**
     *
     * @type {SearchFilter}
     * @memberof SubscriptionQueryParams
     */
    search?: SearchFilter | null;
    /**
     * Sort direction.
     * @type {boolean}
     * @memberof SubscriptionQueryParams
     */
    sortDescending?: boolean;
    /**
     * Key name based on which data is sorted.
     * @type {string}
     * @memberof SubscriptionQueryParams
     */
    sortKey?: string;
    /**
     * Current statuses of the subscription.
     * @type {Array<SubscriptionStatusEnum>}
     * @memberof SubscriptionQueryParams
     */
    statuses?: Array<SubscriptionStatusEnum>;
    /**
     *
     * @type {DateTimeFilter}
     * @memberof SubscriptionQueryParams
     */
    updatedAt?: DateTimeFilter | null;
}
/**
 * Check if a given object implements the SubscriptionQueryParams interface.
 */
export declare function instanceOfSubscriptionQueryParams(value: object): value is SubscriptionQueryParams;
export declare function SubscriptionQueryParamsFromJSON(json: any): SubscriptionQueryParams;
export declare function SubscriptionQueryParamsFromJSONTyped(json: any, ignoreDiscriminator: boolean): SubscriptionQueryParams;
export declare function SubscriptionQueryParamsToJSON(json: any): SubscriptionQueryParams;
export declare function SubscriptionQueryParamsToJSONTyped(value?: SubscriptionQueryParams | null, ignoreDiscriminator?: boolean): any;