@revolugo/booking-api-client
Version:
Javascript Revolugo Booking API Client (browser + server)
46 lines (45 loc) • 1.98 kB
TypeScript
import { PollerStatus } from './PollerStatus';
/**
* Meta information about the response list, such as pagination cursors or status.
* @export
* @interface HotelOffersApiResponseMeta
*/
export interface HotelOffersApiResponseMeta {
/**
* A cursor to use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
* @type {string}
* @memberof HotelOffersApiResponseMeta
*/
endingBefore?: string | null;
/**
* A limit on the number of object to be returned.
* @type {number}
* @memberof HotelOffersApiResponseMeta
*/
limit?: number;
/**
* A cursor to use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
* @type {string}
* @memberof HotelOffersApiResponseMeta
*/
startingAfter?: string | null;
/**
*
* @type {number}
* @memberof HotelOffersApiResponseMeta
*/
totalCount: number;
/**
*
* @type {PollerStatus}
* @memberof HotelOffersApiResponseMeta
*/
status: PollerStatus;
}
/**
* Check if a given object implements the HotelOffersApiResponseMeta interface.
*/
export declare function instanceOfHotelOffersApiResponseMeta(value: object): boolean;
export declare function HotelOffersApiResponseMetaFromJSON(json: any): HotelOffersApiResponseMeta;
export declare function HotelOffersApiResponseMetaFromJSONTyped(json: any, ignoreDiscriminator: boolean): HotelOffersApiResponseMeta;
export declare function HotelOffersApiResponseMetaToJSON(value?: HotelOffersApiResponseMeta | null): any;