@agility/content-fetch/dist/methods/getSyncContent.d.ts

JS/TS library for the Agility Fetch API

import { SyncContent } from '../types/SyncContent';
import { ApiClientInstance } from '../types/Client';
/**
 * Retrieves a list of content items that need to be synced based on the provided sync content items token, and returns the next sync token.
 * @memberof AgilityFetch.Client.Sync
 * @param {Object} requestParams - The paramters for the API request.
 * @param {number} requestParams.syncToken - The sync token provided in the response to a previous sync API call. To start a new sync, use the value of '0'.
 * @param {string} requestParams.locale - The locale code of the content you want to retrieve.
 * @param {string} requestParams.languageCode - DEPRECATED: Use locale instead - The language code of the content you want to retrieve.
 * @param {number} [requestParams.pageSize] - The number of items to return back with each call.  Default is 500.
 * @returns {Promise<AgilityFetch.Types.SyncContent>} - Returns a list of content item objects.
 * @example
 *
 * import agility from '@agility/content-fetch'
 *
 * const api = agility.getApi({
 *   guid: 'ade6cf3c',
 *   apiKey: 'defaultlive.201ffdd0841cacad5bb647e76547e918b0c9ecdb8b5ddb3cf92e9a79b03623cb',
 * });
 *
 * api.getSyncContent({
 *      syncToken: '0', //to start a new sync
 *      locale: 'en-us',
 *      pageSize: 500
 * })
 * .then(function(contentList) {
 *      console.log(contentList.items);
 *
 *      //the next sync token to use, continue to call this method (loop) until no sync token is provided in the response. This indicates your are up to date.
 *      console.log(contentList.syncToken);
 * })
 * .catch(function(error) {
 *      console.log(error);
 * });
*/
export interface SyncContentRequestParams {
    syncToken: number;
    locale?: string;
    pageSize?: number;
    languageCode?: string;
}
declare function getSyncContent(this: ApiClientInstance, requestParams: SyncContentRequestParams): Promise<SyncContent>;
export default getSyncContent;