@getopenpay/client/models/CouponQueryParams.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 { CouponDuration } from './CouponDuration';
import type { DateTimeFilter } from './DateTimeFilter';
import type { IntRangeFilter } from './IntRangeFilter';
import type { SearchFilter } from './SearchFilter';
import type { CurrencyEnum } from './CurrencyEnum';
/**
 *
 * @export
 * @interface CouponQueryParams
 */
export interface CouponQueryParams {
    /**
     *
     * @type {DateTimeFilter}
     * @memberof CouponQueryParams
     */
    createdAt?: DateTimeFilter | null;
    /**
     *
     * @type {CurrencyEnum}
     * @memberof CouponQueryParams
     */
    currency?: CurrencyEnum | null;
    /**
     *
     * @type {CouponDuration}
     * @memberof CouponQueryParams
     */
    duration?: CouponDuration | null;
    /**
     * Specifies which fields in the response should be expanded.
     * @type {Array<string>}
     * @memberof CouponQueryParams
     */
    expand?: Array<string>;
    /**
     *
     * @type {boolean}
     * @memberof CouponQueryParams
     */
    isActive?: boolean | null;
    /**
     *
     * @type {IntRangeFilter}
     * @memberof CouponQueryParams
     */
    maxRedemptions?: IntRangeFilter | null;
    /**
     * Page number
     * @type {number}
     * @memberof CouponQueryParams
     */
    pageNumber?: number;
    /**
     * Page size
     * @type {number}
     * @memberof CouponQueryParams
     */
    pageSize?: number;
    /**
     *
     * @type {DateTimeFilter}
     * @memberof CouponQueryParams
     */
    redeemBy?: DateTimeFilter | null;
    /**
     *
     * @type {SearchFilter}
     * @memberof CouponQueryParams
     */
    search?: SearchFilter | null;
    /**
     * Sort direction.
     * @type {boolean}
     * @memberof CouponQueryParams
     */
    sortDescending?: boolean;
    /**
     * Key name based on which data is sorted.
     * @type {string}
     * @memberof CouponQueryParams
     */
    sortKey?: string;
    /**
     *
     * @type {DateTimeFilter}
     * @memberof CouponQueryParams
     */
    updatedAt?: DateTimeFilter | null;
}
/**
 * Check if a given object implements the CouponQueryParams interface.
 */
export declare function instanceOfCouponQueryParams(value: object): value is CouponQueryParams;
export declare function CouponQueryParamsFromJSON(json: any): CouponQueryParams;
export declare function CouponQueryParamsFromJSONTyped(json: any, ignoreDiscriminator: boolean): CouponQueryParams;
export declare function CouponQueryParamsToJSON(json: any): CouponQueryParams;
export declare function CouponQueryParamsToJSONTyped(value?: CouponQueryParams | null, ignoreDiscriminator?: boolean): any;