baasic-sdk-javascript
Version:
JavaScript SDK provides core functionality for building web and mobile applications on [Baasic](http://www.baasic.com/).
83 lines (82 loc) • 4.65 kB
TypeScript
/**
* @module calendarEventRsvpAttendeeBatchClient
* @description CalendarEventRsvpAttendeeBatchClient provides an easy way to consume CalendarEventRsvpAttendeeBatch REST API end-points. In order to obtain needed routes `calendarEventRsvpAttendeeBatchClient` uses `calendarEventRsvpAttendeeBatchRoute`.
*/
import { ApiClient, IHttpResponse } from '../../../httpApi';
import { CalendarEventRsvpAttendeeBatchRoute } from '../';
import { ICalendarEventAttendee } from '../contracts';
export declare class CalendarEventRsvpAttendeeBatchClient {
protected calendarEventRsvpAttendeeBatchRoute: CalendarEventRsvpAttendeeBatchRoute;
protected apiClient: ApiClient;
readonly routeDefinition: CalendarEventRsvpAttendeeBatchRoute;
constructor(calendarEventRsvpAttendeeBatchRoute: CalendarEventRsvpAttendeeBatchRoute, apiClient: ApiClient);
/**
* Returns a promise that is resolved once the create CalendarEvenAttendees action has been performed; this action creates new CalendarEventAttendee resources.
* @method
* @param data CalendarEventAttendee objects that need to be inserted into the system.
* @returns A promise that is resolved once the create CalendarEventAttendees action has been performed.
* @example calendarEventRsvpAttendeeBatchClient.create([{
AttendeeStatus: <calendar-evetn-attendee-status>,
AttendeeStatusId '<attendee-status-id>',
DateCreated: '<date-created>',
DateUpdated: '<date-updated>',
Email: '<email>',
EventID: '<calendar-event-id>',
FullName: '<full-name>',
Id: '<id>',
InvitationType: <calendar-event-invitation-type>,
InvitationTypeId: '<invitation-type-id>',
Json: '<json>',
Slots: <slots>,
SlotsRequested: <slots-requested>,
User: <user-profile>,
UserID: '<user-id>'
}])
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
*/
create(data: ICalendarEventAttendee[]): PromiseLike<IHttpResponse<ICalendarEventAttendee[]>>;
/**
* Returns a promise that is resolved once the update CalendarEventAttendees action has been performed; this action updates CalendarEventAttendee resources.
* @method
* @param data CalendarEventAttendee objects used to update specified CalendarEventAttendee resources.
* @returns A promise that is resolved once the update CalendarEventAttendees action has been performed.
* @example calendarEventAttendees are resources previously fetched using get action.
calendarEventRsvpAttendeeBatchClient.update(calendarEventAttendees)
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
*/
update(data: ICalendarEventAttendee[]): PromiseLike<IHttpResponse<void>>;
/**
* Returns a promise that is resolved once the remove action has been performed. This action will remove CalendarEventAttendee resources from the system if successfully completed.
* @method
* @param data CalendarEventAttendee Ids which uniquely identify CalendarEventAttendee resources to be deleted.
* @returns A promise that is resolved once the remove action has been performed.
* @example calendarEventAttendeeIds are identifiers which uniquely identify CalendarEventAttendee resources.
calendarEventRsvpAttendeeBatchClient.remove(calendarEventAttendeeIds)
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
*/
remove(data: string[]): PromiseLike<IHttpResponse<void>>;
}
/**
* @copyright (c) 2017 Mono Ltd
* @license MIT
* @author Mono Ltd
* @overview
***Notes:**
- Refer to the [Baasic REST API](http://dev.baasic.com/api/reference/home) for detailed information about available Baasic REST API end-points.
- All end-point objects are transformed by the associated route definition.
*/