@snapp-store/snapp-box-sdk
Version:
A javascript sdk for snapp box api
61 lines (60 loc) • 2.77 kB
TypeScript
import type { ORDERACCEPTEDREQUEST } from '../models/ORDERACCEPTEDREQUEST';
import type { ORDERARRIVEDREQUEST } from '../models/ORDERARRIVEDREQUEST';
import type { ORDERCANCELEDBYSYSTEMREQUEST } from '../models/ORDERCANCELEDBYSYSTEMREQUEST';
import type { ORDERCANCELEDREQUEST } from '../models/ORDERCANCELEDREQUEST';
import type { ORDERDELIVEREDREQUEST } from '../models/ORDERDELIVEREDREQUEST';
import type { ORDERPICKEDUPREQUEST } from '../models/ORDERPICKEDUPREQUEST';
import type { CancelablePromise } from '../core/CancelablePromise';
import type { BaseHttpRequest } from '../core/BaseHttpRequest';
export declare class WebhooksService {
readonly httpRequest: BaseHttpRequest;
constructor(httpRequest: BaseHttpRequest);
/**
* ORDER ACCEPTED
* Following payload will be sent through Webhooks/FCM when a biker is allocated to the order, you can test this webhook with your webhook handler url.
* @param requestBody
* @returns any
* @throws ApiError
*/
orderaccepted(requestBody: ORDERACCEPTEDREQUEST): CancelablePromise<any>;
/**
* ORDER ARRIVED
* Following payload will be sent through Webhooks/FCM when a biker is allocated to the order, you can test this webhook with your webhook handler url.
* @param requestBody
* @returns any
* @throws ApiError
*/
orderarrived(requestBody: ORDERARRIVEDREQUEST): CancelablePromise<any>;
/**
* ORDER PICKED UP
* Following payload will be sent through Webhooks/FCM when the biker has picked up the package, you can test this webhook with your webhook handler url.
* @param requestBody
* @returns any
* @throws ApiError
*/
orderpickedup(requestBody: ORDERPICKEDUPREQUEST): CancelablePromise<any>;
/**
* ORDER DELIVERED
* Following payload will be sent through Webhooks/FCM when the biker has delivered the package, you can test this webhook with your webhook handler url.
* @param requestBody
* @returns any
* @throws ApiError
*/
orderdelivered(requestBody: ORDERDELIVEREDREQUEST): CancelablePromise<any>;
/**
* ORDER CANCELED
* Following payload will be sent through Webhooks/FCM when the order is cancelled, you can test this webhook with your webhook handler url.
* @param requestBody
* @returns any
* @throws ApiError
*/
ordercanceled(requestBody: ORDERCANCELEDREQUEST): CancelablePromise<any>;
/**
* ORDER CANCELED (by system)
* If you create an order and in its time of "allocation" no biker accepts your order , it'll be cancelled by system.
* @param requestBody
* @returns any
* @throws ApiError
*/
ordercanceledBysystem(requestBody: ORDERCANCELEDBYSYSTEMREQUEST): CancelablePromise<any>;
}