expresspayments/types/ReviewsResource.d.ts

ExpressPayments API wrapper

// File generated from our OpenAPI spec

declare module 'expresspayments' {
    namespace ExpressPayments {
        interface ReviewRetrieveParams {
            /**
             * Specifies which fields in the response should be expanded.
             */
            expand?: Array<string>;
        }

        interface ReviewListParams extends PaginationParams {
            created?: ExpressPayments.RangeQueryParam | number;

            /**
             * Specifies which fields in the response should be expanded.
             */
            expand?: Array<string>;
        }

        interface ReviewApproveParams {
            /**
             * Specifies which fields in the response should be expanded.
             */
            expand?: Array<string>;
        }

        class ReviewsResource {
            /**
             * Retrieves a Review object.
             */
            retrieve(
                id: string,
                params?: ReviewRetrieveParams,
                options?: RequestOptions
            ): Promise<ExpressPayments.Response<ExpressPayments.Review>>;
            retrieve(
                id: string,
                options?: RequestOptions
            ): Promise<ExpressPayments.Response<ExpressPayments.Review>>;

            /**
             * Returns a list of Review objects that have open set to true. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
             */
            list(
                params?: ReviewListParams,
                options?: RequestOptions
            ): ApiListPromise<ExpressPayments.Review>;
            list(
                options?: RequestOptions
            ): ApiListPromise<ExpressPayments.Review>;

            /**
             * Approves a Review object, closing it and removing it from the list of reviews.
             */
            approve(
                id: string,
                params?: ReviewApproveParams,
                options?: RequestOptions
            ): Promise<ExpressPayments.Response<ExpressPayments.Review>>;
            approve(
                id: string,
                options?: RequestOptions
            ): Promise<ExpressPayments.Response<ExpressPayments.Review>>;
        }
    }
}