### Install Standard Webhooks Package Source: https://developer.eventsair.com/docs/guides/webhooks/receiving Commands to add the required library to a Node.js project. ```shell npm install standardwebhooks // Or yarn add standardwebhooks ``` -------------------------------- ### ContactStoreSetup Object Source: https://developer.eventsair.com/docs/reference/types/objects/contact-store-setup Defines the structure for configuring a contact store, encompassing various setup aspects. ```APIDOC ## ContactStoreSetup Object ### Description Represents the configuration settings for a contact store. ### Type Object ### Fields #### `contact` (ContactSetup!) - Non-null object The setup options for contacts within the contact store. #### `countryList` (CountryList!) - Non-null object The country list associated with the contact store. #### `marketing` (ContactStoreMarketingSetup!) - Non-null object The setup options for marketing tags within the contact store. #### `note` (ContactStoreNoteSetup!) - Non-null object The setup options for notes within the contact store. ### Member Of `ContactStore` object ``` -------------------------------- ### Upload file with C# Source: https://developer.eventsair.com/docs/guides/uploading-files Example using HttpClient to send a multipart/form-data request with an authentication header. ```csharp internal class Program { static async Task Main(string[] args) { var httpClient = new HttpClient { BaseAddress = new Uri("https://api.eventsair.com"), }; var accessToken = ""; httpClient.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", accessToken); var filePath = ""; var content = new MultipartFormDataContent { { new StreamContent(File.OpenRead(filePath)), "file", Path.GetFileName(filePath) } }; var response = await httpClient.PostAsync("/file", content); var data = await response.Content.ReadFromJsonAsync(); Console.WriteLine(data.TemporaryFileId); } } internal class FileUploadResponse { public Guid TemporaryFileId { get; set; } } ``` -------------------------------- ### EventSetup Object Definition Source: https://developer.eventsair.com/docs/reference/types/objects/event-setup Defines the structure for event setup configurations, encompassing all configurable aspects of an event. ```graphql type EventSetup { accommodation: AccommodationSetup! account: AccountSetup! contact: ContactSetup! countryList: CountryList! course: EventCourseSetup! exhibition: ExhibitionSetup! function: FunctionSetup! locations: [Location!]! marketing: EventMarketingSetup! note: EventNoteSetup! paymentTypes: [PaymentType!]! presentation: PresentationSetup! registration: RegistrationSetup! sponsorship: SponsorshipSetup! taxes: [Tax!]! travel: TravelSetup! } ``` -------------------------------- ### GraphQL API Response Example Source: https://developer.eventsair.com/docs/guides/issue-queries This is a sample JSON response from a successful GraphQL query, indicating the API is operational. ```json { "data": { "healthcheck": "Hello from the EventsAIR GraphQL API" } } ``` -------------------------------- ### Upload file with JavaScript/TypeScript Source: https://developer.eventsair.com/docs/guides/uploading-files Example using axios and form-data to upload a file stream. ```javascript const accessToken = '' const httpClient = axios.create({ baseURL: 'https://api.eventsair.com', headers: { Authorization: `Bearer ${accessToken}`, }, }) const filePath = '' const formData = new NodeFormData() formData.append('file', fs.createReadStream(filePath), { // This sets the "filename" attribute on the part automatically filepath: filePath, }) // Axios automatically transforms the `formData` instance into a multipart/form-data request const response = await httpClient.post('/file', formData) console.log(response.data.temporaryFileId) ``` -------------------------------- ### Define MembershipDefaultStartDate Enum Source: https://developer.eventsair.com/docs/reference/types/enums/membership-default-start-date Use this enum to specify the default start date for membership fees. The start date is not applicable for one-time charges. ```typescript enum MembershipDefaultStartDate { NONE START_OF_CURRENT_MONTH START_OF_NEXT_MONTH TODAY } ``` -------------------------------- ### GET MembershipContactStore.courseRegistrations Source: https://developer.eventsair.com/docs/reference/types/objects/membership-contact-store Retrieves course registrations for the store. ```APIDOC ## GET MembershipContactStore.courseRegistrations ### Description Retrieves course registrations for this membership contact store that match the filter criteria. ### Parameters #### Query Parameters - **input** (CourseRegistrationSearchFilterInput) - Required - Filter criteria for searching course registrations. - **limit** (PaginationLimit) - Required - Positive integer from 1 to 2000 (defaults to 100). - **offset** (NonNegativeInt) - Required - Non-negative integer (defaults to 0). ``` -------------------------------- ### Basic GraphQL Query Example Source: https://developer.eventsair.com/sandbox A simple GraphQL query to fetch the 'id' field. This can be used in the Explorer to test basic query functionality. ```graphql 1 2 3 4query ExampleQuery { id } ``` -------------------------------- ### GET MembershipContactStore.contact Source: https://developer.eventsair.com/docs/reference/types/objects/membership-contact-store Retrieves a specific contact by its identifier. ```APIDOC ## GET MembershipContactStore.contact ### Description Retrieves a contact by its identifier. Throws an error with code NOT_FOUND if no contact is found. ### Parameters #### Query Parameters - **id** (ID) - Required - The unique identifier of the contact. ``` -------------------------------- ### POST /createMembershipContactStoreCourse Source: https://developer.eventsair.com/docs/reference/operations/mutations/create-membership-contact-store-course Creates a course in a membership contact store. This operation requires a `CreateMembershipContactStoreCourseInput` object and returns a `CreateMembershipContactStoreCoursePayload`. ```APIDOC ## POST /createMembershipContactStoreCourse ### Description Create a course in a membership contact store. ### Method POST ### Endpoint /createMembershipContactStoreCourse ### Parameters #### Request Body - **input** (CreateMembershipContactStoreCourseInput!) - Required - Input object for creating a course. ### Request Example ```json { "input": { "membershipContactStoreId": "string", "courseTitle": "string", "courseCode": "string", "credits": [ { "creditTypeId": "string", "amount": 0 } ], "classifications": [ { "courseClassificationId": "string", "courseSubClassificationId": "string" } ], "instructors": [ { "contactId": "string", "role": "string" } ] } } ``` ### Response #### Success Response (200) - **CreateMembershipContactStoreCoursePayload** (object) - Payload returned when creating a course in a membership contact store. #### Response Example ```json { "course": { "id": "string", "membershipContactStoreId": "string", "title": "string", "code": "string", "credits": [ { "creditTypeId": "string", "amount": 0 } ], "classifications": [ { "courseClassificationId": "string", "courseSubClassificationId": "string" } ], "instructors": [ { "contactId": "string", "role": "string" } ] } } ``` ### Error Handling Throws an error with code: * `NOT_FOUND` if a membership contact store matching the input's `membershipContactStoreId` field cannot be found. * `MODULE_NOT_ENABLED` if the continuing education module is not enabled in the membership contact store. * `NOT_FOUND` if any credit types matching the input's `credits` collection `creditTypeId` field cannot be found within the membership contact store. * `NOT_FOUND` if any course classifications matching the input's `classifications` collection `courseClassificationId` field cannot be found within the membership contact store. * `NOT_FOUND` if a course sub classification matching the input's `classifications` collection `courseSubClassificationId` field is not associated with the course classification specified by `courseClassificationId`. * `NOT_FOUND` if any contact matching the input's `instructors` collection `contactId` field cannot be found within the membership contact store. ``` -------------------------------- ### GET Event.registration Source: https://developer.eventsair.com/docs/reference/types/objects/event Retrieves a specific registration by its identifier. ```APIDOC ## GET Event.registration ### Description Retrieves a registration by its identifier. Throws an error with code NOT_FOUND if no registration is found. ### Method GET ### Parameters #### Query Parameters - **id** (ID) - Required - The unique identifier of the registration. ``` -------------------------------- ### Define AccountSetup Object Source: https://developer.eventsair.com/docs/reference/types/objects/account-setup Defines the structure for AccountSetup, which includes a non-null list of Account objects. ```graphql type AccountSetup { accounts: [Account!]! } ``` -------------------------------- ### GET Event.portal Source: https://developer.eventsair.com/docs/reference/types/objects/event Retrieves a specific portal by its identifier. ```APIDOC ## GET Event.portal ### Description Retrieves a portal by its identifier. Throws an error with code NOT_FOUND if no portal is found. ### Method GET ### Parameters #### Query Parameters - **id** (ID) - Required - The unique identifier of the portal. ``` -------------------------------- ### MembershipContactStoreCourseSetup Fields Source: https://developer.eventsair.com/docs/reference/types/objects/membership-contact-store-course-setup This section details the fields available within the MembershipContactStoreCourseSetup object, including their types, descriptions, and optional arguments for pagination. ```APIDOC ## MembershipContactStoreCourseSetup Defines the settings for courses for a membership contact store in EventsAir. ### Fields #### `classificationTypes` ● `[CourseClassificationType!]!` non-null object A list of course classification types associated with this membership contact store. Optionally, the `offset` and `limit` arguments can be used to page through multiple items: * `offset` must be a non-negative integer (defaults to `0`). * `limit` must be a positive integer from `1` to `2000` (defaults to `100`). ##### `limit` ● `PaginationLimit!` non-null scalar ##### `offset` ● `NonNegativeInt!` non-null scalar #### `classifications` ● `[CourseClassification!]!` non-null object A list of course classifications associated with this membership contact store. Optionally, the `offset` and `limit` arguments can be used to page through multiple items: * `offset` must be a non-negative integer (defaults to `0`). * `limit` must be a positive integer from `1` to `2000` (defaults to `100`). ##### `limit` ● `PaginationLimit!` non-null scalar ##### `offset` ● `NonNegativeInt!` non-null scalar #### `courses` ● `[MembershipContactStoreCourse!]!` non-null object A list of courses associated with this membership contact store. See `CourseSearchFilterInput` for details on how the optional `input` argument can be used to filter course. Optionally, the `offset` and `limit` arguments can be used to page through multiple items: * `offset` must be a non-negative integer (defaults to `0`). * `limit` must be a positive integer from `1` to `2000` (defaults to `100`). ##### `input` ● `CourseSearchFilterInput!` non-null input ##### `limit` ● `PaginationLimit!` non-null scalar ##### `offset` ● `NonNegativeInt!` non-null scalar #### `creditTypes` ● `[CourseCreditType!]!` non-null object A list of course credit types associated with this membership contact store. Optionally, the `offset` and `limit` arguments can be used to page through multiple items: * `offset` must be a non-negative integer (defaults to `0`). * `limit` must be a positive integer from `1` to `2000` (defaults to `100`). ##### `limit` ● `PaginationLimit!` non-null scalar ##### `offset` ● `NonNegativeInt!` non-null scalar #### `discountCodes` ● `[CourseDiscountCode!]!` non-null object A list of course registration discount codes defined for this membership contact store. Optionally, the `offset` and `limit` arguments can be used to page through multiple items: * `offset` must be a non-negative integer (defaults to `0`). * `limit` must be a positive integer from `1` to `2000` (defaults to `100`). ##### `limit` ● `PaginationLimit!` non-null scalar ##### `offset` ● `NonNegativeInt!` non-null scalar #### `preferences` ● `CoursePreferences!` non-null object The configuration preferences for a course. ``` -------------------------------- ### GET /carriers Source: https://developer.eventsair.com/docs/reference/operations/queries/carriers Retrieves a paginated list of carriers. ```APIDOC ## GET /carriers ### Description Retrieves a list of carriers used in sectors and travel bookings. Supports pagination via offset and limit parameters. ### Method GET ### Endpoint /carriers ### Parameters #### Query Parameters - **limit** (PaginationLimit) - Optional - A positive integer from 1 to 2000 (defaults to 100). - **offset** (NonNegativeInt) - Optional - A non-negative integer (defaults to 0). ### Response #### Success Response (200) - **Carrier** (object) - A list of carrier objects. ``` -------------------------------- ### GraphQL Operation Cost Calculation Example (Sibling Arrays) Source: https://developer.eventsair.com/docs/overview/usage-limits This example illustrates how cost points are calculated for sibling array fields within an object. Each `limit: 20` contributes 20 points, resulting in a total of 40 points for the `event` object. ```graphql query ExampleQuery($eventId: ID!) { event(id: $eventId) { customFields(limit: 20) { name } registrationTypes(limit: 20) { id } } } ``` -------------------------------- ### GraphQL CeContactStoreCourseSetup Fields Source: https://developer.eventsair.com/docs/reference/types/objects/ce-contact-store-course-setup Retrieves various configuration settings and lists related to continuing education courses. ```APIDOC ## GraphQL CeContactStoreCourseSetup ### Description Defines the settings for courses for a continuing education contact store in EventsAir. ### Parameters #### Query Parameters - **limit** (PaginationLimit) - Optional - Positive integer from 1 to 2000 (defaults to 100). - **offset** (NonNegativeInt) - Optional - Non-negative integer (defaults to 0). - **input** (CourseSearchFilterInput) - Optional - Filter criteria for course searches. ### Fields - **classificationTypes** ([CourseClassificationType!]!) - A list of course classification types. - **classifications** ([CourseClassification!]!) - A list of course classifications. - **courses** ([CeContactStoreCourse!]!) - A list of courses associated with the store. - **creditTypes** ([CourseCreditType!]!) - A list of course credit types. - **discountCodes** ([CourseDiscountCode!]!) - A list of course registration discount codes. - **preferences** (CoursePreferences!) - The configuration preferences for a course. - **subClassifications** ([CourseSubClassification!]!) - A list of course sub classifications. ``` -------------------------------- ### GET Contact.marketingRecords Source: https://developer.eventsair.com/docs/reference/types/objects/contact Retrieves a list of marketing records for a contact. ```APIDOC ## GET Contact.marketingRecords ### Description Retrieves the marketing records for this contact with optional filtering and pagination. ### Parameters #### Query Parameters - **input** (MarketingSearchFilterInput) - Required - Filter criteria for marketing records. - **limit** (PaginationLimit) - Required - Number of items to return (1-2000, default 100). - **offset** (NonNegativeInt) - Required - Number of items to skip (default 0). ``` -------------------------------- ### GET Contact.hotelBookings Source: https://developer.eventsair.com/docs/reference/types/objects/contact Retrieves a list of hotel bookings for a contact. ```APIDOC ## GET Contact.hotelBookings ### Description Retrieves the hotel bookings for this contact with optional filtering and pagination. ### Parameters #### Query Parameters - **input** (HotelBookingSearchFilterInput) - Required - Filter criteria for hotel bookings. - **limit** (PaginationLimit) - Required - Number of items to return (1-2000, default 100). - **offset** (NonNegativeInt) - Required - Number of items to skip (default 0). ``` -------------------------------- ### Define CreateMembershipContactStorePaymentInput Source: https://developer.eventsair.com/docs/reference/types/inputs/create-membership-contact-store-payment-input Use this input to specify details for creating a payment, including items, amounts, and payment method. Ensure all required fields are provided. ```graphql input CreateMembershipContactStorePaymentInput { comment: String currencyId: ID description: String itemsToPay: [PayableItemToPayInput!]! membershipContactStoreId: ID! paidById: ID! paymentTypeId: ID! recordedAt: DateTime! totalAmount: Float! } ``` -------------------------------- ### GET Contact.functionRegistrations Source: https://developer.eventsair.com/docs/reference/types/objects/contact Retrieves a list of function registrations for a contact. ```APIDOC ## GET Contact.functionRegistrations ### Description Retrieves the function registrations for this contact with optional filtering and pagination. ### Parameters #### Query Parameters - **input** (FunctionRegistrationSearchFilterInput) - Required - Filter criteria for function registrations. - **limit** (PaginationLimit) - Required - Number of items to return (1-2000, default 100). - **offset** (NonNegativeInt) - Required - Number of items to skip (default 0). ``` -------------------------------- ### Define CreateCeContactStoreCourseRegistrationInput Source: https://developer.eventsair.com/docs/reference/types/inputs/create-ce-contact-store-course-registration-input Use this input to define the parameters for creating a course registration. It includes details such as attendance status, contact information, course fees, payment, and ticketing. ```graphql input CreateCeContactStoreCourseRegistrationInput { attendanceStatus: CourseAttendanceStatus! ceContactStoreId: ID! comment: String contactId: ID! courseFeeTypeId: ID! customFields: [CustomFieldInput!] dateTime: DateTime! discountCodeId: ID grade: String itineraryConfiguration: CourseRegistrationItineraryConfigurationInput! paymentDetails: CreatePaymentDetailsInput! score: NonNegativeFloat! taxOverrides: [TaxOverrideInput!] tickets: PositiveInt! } ``` -------------------------------- ### GET /CeContactStore/invoice Source: https://developer.eventsair.com/docs/reference/types/objects/ce-contact-store Retrieves a specific invoice by its unique identifier. ```APIDOC ## GET /CeContactStore/invoice ### Description Retrieves an invoice by its identifier. Throws an error with code NOT_FOUND if no invoice is found. ### Parameters #### Query Parameters - **id** (ID!) - Required - The unique identifier for the invoice. ``` -------------------------------- ### Define CreateCeContactStorePaymentInput Source: https://developer.eventsair.com/docs/reference/types/inputs/create-ce-contact-store-payment-input Use this input to specify details for creating a payment within a continuing education contact store. Ensure all required fields are provided. ```graphql input CreateCeContactStorePaymentInput { ceContactStoreId: ID! comment: String currencyId: ID description: String itemsToPay: [PayableItemToPayInput!]! paidById: ID! paymentTypeId: ID! recordedAt: DateTime! totalAmount: Float! } ``` -------------------------------- ### GET /me Source: https://developer.eventsair.com/docs/reference/operations/queries/me Returns information about the currently logged-in identity. ```APIDOC ## GET /me ### Description Returns information about the currently logged-in identity. ### Method GET ### Endpoint /me ### Response #### Success Response (200) - **Me** (object) - Information about the currently logged-in identity. ``` -------------------------------- ### Create Membership Contact Store Course Source: https://developer.eventsair.com/docs/reference/operations/mutations/create-membership-contact-store-course Use this mutation to create a course in a membership contact store. It requires a CreateMembershipContactStoreCourseInput object and returns a CreateMembershipContactStoreCoursePayload. ```graphql createMembershipContactStoreCourse( input: CreateMembershipContactStoreCourseInput! ): CreateMembershipContactStoreCoursePayload! ``` -------------------------------- ### Event.sessions Source: https://developer.eventsair.com/docs/reference/types/objects/event Retrieves sessions for an event, ordered by date and start time. ```APIDOC ## POST Event.sessions ### Description Retrieves sessions for the event, ordered by date (ascending) and start time (ascending). ### Parameters #### Query Parameters - **input** (SessionSearchFilterInput) - Required - Filter criteria for sessions. - **limit** (PaginationLimit) - Required - Number of items to return (1-2000, default 100). - **offset** (NonNegativeInt) - Required - Number of items to skip (default 0). ### Response #### Success Response (200) - **sessions** ([Session!]) - List of sessions. ``` -------------------------------- ### Define Presentation Theme Creation Input Source: https://developer.eventsair.com/docs/reference/operations/mutations/create-presentation-theme Use this function signature to define the input for creating a presentation theme. It requires a non-null CreatePresentationThemeInput object. ```graphql createPresentationTheme( input: CreatePresentationThemeInput! ): CreatePresentationThemePayload! ``` -------------------------------- ### Define CreateEventPaymentInput Source: https://developer.eventsair.com/docs/reference/types/inputs/create-event-payment-input Use this input to define the parameters for creating a payment. Ensure all non-null fields are provided. ```graphql input CreateEventPaymentInput { comment: String currencyId: ID description: String eventId: ID! itemsToPay: [PayableItemToPayInput!]! paidById: ID! paymentTypeId: ID! recordedAt: DateTime! totalAmount: Float! } ``` -------------------------------- ### GET /Event/contact Source: https://developer.eventsair.com/docs/reference/types/objects/event Retrieves a specific contact associated with the event by their identifier. ```APIDOC ## GET /Event/contact ### Description Retrieves a contact by its identifier. Throws an error with code NOT_FOUND if no contact is found. ### Method GET ### Parameters #### Query Parameters - **id** (ID!) - Required - The unique identifier of the contact. ``` -------------------------------- ### Enable Inline Traces with Apollo Server Source: https://developer.eventsair.com/sandbox Install the ApolloServerPluginInlineTrace to enable inline traces for GraphQL operations. Be aware that enabling this may expose sensitive server performance information to clients. ```javascript 1import { ApolloServerPluginInlineTrace } from "apollo-server-core"; 2const server = new ApolloServer({ 3 typeDefs, 4 resolvers, 5 plugins: [ApolloServerPluginInlineTrace()], 6}) ``` -------------------------------- ### Define CreateMembershipContactStoreFunctionRegistrationWithBasicGuestsInput Source: https://developer.eventsair.com/docs/reference/types/inputs/create-membership-contact-store-function-registration-with-basic-guests-input Use this input to define the details for creating a function registration, including contact, guest, and payment information. It allows for optional custom fields, discount codes, and tax overrides. ```graphql input CreateMembershipContactStoreFunctionRegistrationWithBasicGuestsInput { contactId: ID! customFields: [CustomFieldInput!] discountCodeId: ID functionFeeTypeId: ID! guests: [CreateBasicFunctionGuestInput!]! membershipContactStoreId: ID! paymentDetails: CreatePaymentDetailsInput! taxOverrides: [TaxOverrideInput!] temporaryHoldContextId: ID } ``` -------------------------------- ### GET Contact.exhibitionBookings Source: https://developer.eventsair.com/docs/reference/types/objects/contact Retrieves a list of exhibition bookings associated with a contact. ```APIDOC ## GET Contact.exhibitionBookings ### Description Retrieves the exhibitions that the contact has booked. Supports filtering via input and pagination via offset and limit. ### Parameters #### Query Parameters - **input** (ExhibitionBookingSearchFilterInput) - Required - Filter criteria for exhibition bookings. - **limit** (PaginationLimit) - Required - Number of items to return (1-2000, default 100). - **offset** (NonNegativeInt) - Required - Number of items to skip (default 0). ``` -------------------------------- ### GET Contact.customFields Source: https://developer.eventsair.com/docs/reference/types/objects/contact Retrieves custom field values associated with the contact. ```APIDOC ## GET Contact.customFields ### Description Retrieves a list of custom field values associated with this contact, with optional filtering and pagination. ### Parameters #### Query Parameters - **input** (CustomFieldSearchFilterInput) - Required - Filter criteria for custom fields. - **limit** (PaginationLimit) - Required - Positive integer from 1 to 2000 (defaults to 100). - **offset** (NonNegativeInt) - Required - Non-negative integer (defaults to 0). ### Response #### Success Response (200) - **CustomField** (Array) - List of custom field values. ``` -------------------------------- ### Create function registration with basic guest details Source: https://developer.eventsair.com/docs/guides/function-registrations Utilize the CreateBasicFunctionGuestInput type to provide guest names and contact information directly. ```graphql mutation createFunctionRegistrationWithBasicGuests { createFunctionRegistrationWithBasicGuests( input: { eventId: "00000000-0000-0000-0000-000000000000" functionFeeTypeId: "00000000-0000-0000-0000-000000000000" contactId: "00000000-0000-0000-0000-000000000000" guests: [{ lastName: "Cantrell", firstName: "Danny" }, { email: "roger.hanson@eventsair.com" }] paymentDetails: { paymentStatus: PURCHASE } } ) { functionRegistration { id guests { contact { ... on FunctionGuestDetails { lastName firstName email } } } } } } ``` -------------------------------- ### CeContactStoreSetup Object Source: https://developer.eventsair.com/docs/reference/types/objects/ce-contact-store-setup Details the fields and configuration objects available within the CeContactStoreSetup schema. ```APIDOC ## CeContactStoreSetup Object ### Description The CeContactStoreSetup object contains the configuration settings required for the Continuing Education Contact Store, including account, contact, course, and financial setup. ### Fields - **account** (AccountSetup!) - The setup options for accounts within the continuing education contact store. - **contact** (ContactSetup!) - The setup options for contacts within the continuing education contact store. - **countryList** (CountryList!) - The country list associated with the continuing education contact store. - **course** (CeContactStoreCourseSetup!) - The setup options for courses within the continuing education contact store. - **function** (CeContactStoreFunctionSetup!) - The setup options for functions within the continuing education contact store. - **locations** ([Location!]!) - The locations available for functions and continuing education courses. - **marketing** (CeContactStoreMarketingSetup!) - The setup options for marketing tags within the continuing education contact store. - **note** (CeContactStoreNoteSetup!) - The setup options for notes within the continuing education contact store. - **paymentTypes** ([PaymentType!]!) - The payment types available within the continuing education contact store. - **taxes** ([Tax!]!) - The setup options for taxes within the continuing education contact store. ### Member Of - CeContactStore ``` -------------------------------- ### GET CeContactStore.payment Source: https://developer.eventsair.com/docs/reference/types/objects/ce-contact-store Retrieves a specific payment by its identifier within the CeContactStore. ```APIDOC ## GET CeContactStore.payment ### Description Retrieves a payment by its identifier. Throws an error with code NOT_FOUND if no payment is found. ### Method GET ### Endpoint CeContactStore.payment ### Parameters #### Path Parameters - **id** (ID!) - Required - The unique identifier of the payment. ``` -------------------------------- ### GET /CeContactStore/functionRegistration Source: https://developer.eventsair.com/docs/reference/types/objects/ce-contact-store Retrieves a specific function registration by its unique identifier. ```APIDOC ## GET /CeContactStore/functionRegistration ### Description Retrieves a function registration by its identifier. Throws an error with code NOT_FOUND if no function registration is found. ### Parameters #### Query Parameters - **id** (ID!) - Required - The unique identifier for the function registration. ``` -------------------------------- ### EventCourseSetup Fields Source: https://developer.eventsair.com/docs/reference/types/objects/event-course-setup Details on the fields available within the EventCourseSetup object, including pagination support for list-based fields. ```APIDOC ## GraphQL EventCourseSetup ### Description Defines the settings for courses for an event in EventsAir. ### Parameters #### Query Parameters - **limit** (PaginationLimit) - Optional - Positive integer from 1 to 2000 (defaults to 100). - **offset** (NonNegativeInt) - Optional - Non-negative integer (defaults to 0). - **input** (CourseSearchFilterInput) - Optional - Filter criteria for courses. ### Fields - **classificationTypes** ([CourseClassificationType!]!) - A list of course classification types associated with this event. - **classifications** ([CourseClassification!]!) - A list of course classifications associated with this event. - **courses** ([EventCourse!]!) - A list of courses associated with this event. - **creditTypes** ([CourseCreditType!]!) - A list of course credit types associated with this event. - **discountCodes** ([CourseDiscountCode!]!) - A list of course registration discount codes defined for this event. - **preferences** (CoursePreferences!) - The configuration preferences for a course. - **subClassifications** ([CourseSubClassification!]!) - A list of course sub classifications associated with this event. ``` -------------------------------- ### MembershipContactStoreSetup API Source: https://developer.eventsair.com/docs/reference/types/objects/membership-contact-store-setup This section describes the fields available for the MembershipContactStoreSetup object. ```APIDOC ## MembershipContactStoreSetup ### Description Represents the setup configuration for a membership contact store. ### Fields #### `account` (AccountSetup!) - non-null object The setup options for accounts within the membership contact store. #### `contact` (ContactSetup!) - non-null object The setup options for contacts within the membership contact store. #### `countryList` (CountryList!) - non-null object The country list associated with the membership contact store. #### `course` (MembershipContactStoreCourseSetup!) - non-null object The setup options for courses within the membership contact store. #### `discountCodes` ( [MembershipDiscountCode!]! ) - non-null object A list of discount codes defined for this membership contact store. ##### Query Parameters - **offset** (NonNegativeInt!) - Optional - The number of records to skip. Defaults to 0. - **limit** (PaginationLimit!) - Optional - The maximum number of records to return. Defaults to 100. #### `function` (MembershipContactStoreFunctionSetup!) - non-null object The setup options for functions within the membership contact store. #### `locations` ( [Location!]! ) - non-null object The locations available for functions and continuing education courses. #### `marketing` (MembershipContactStoreMarketingSetup!) - non-null object The setup options for marketing tags within the membership contact store. #### `membership` (MembershipSetup!) - non-null object The setup options for membership within the membership contact store. #### `note` (MembershipContactStoreNoteSetup!) - non-null object The setup options for notes within the membership contact store. #### `paymentTypes` ( [PaymentType!]! ) - non-null object The payment types available within the membership contact store. #### `taxes` ( [Tax!]! ) - non-null object The setup options for taxes within the membership contact store. ### Member Of `MembershipContactStore` object ``` -------------------------------- ### GraphQL Operation Cost Calculation Example (Nested Arrays) Source: https://developer.eventsair.com/docs/overview/usage-limits This example shows how cost points are multiplied for nested array fields. A `limit: 20` on `registrationTypes` and another `limit: 20` on nested `registrations` results in a total cost of 400 points (20 * 20) for the `event` object. ```graphql query ExampleQuery($eventId: ID!) { event(id: $eventId) { registrationTypes(limit: 20) { registrations(limit: 20) { id } } } } ``` -------------------------------- ### RegistrationSetup GraphQL Type Definition Source: https://developer.eventsair.com/docs/reference/types/objects/registration-setup Defines the structure of the RegistrationSetup object, including fields for discount codes, preferences, registration groups, and registration types. ```graphql type RegistrationSetup { discountCodes( limit: PaginationLimit! = 100 offset: NonNegativeInt! = 0 ): [RegistrationDiscountCode!]! preferences: RegistrationPreferences! registrationGroups( limit: PaginationLimit! = 100 offset: NonNegativeInt! = 0 ): [RegistrationGroup!]! registrationTypes( limit: PaginationLimit! = 100 offset: NonNegativeInt! = 0 ): [RegistrationType!]! } ``` -------------------------------- ### GET MembershipContactStore.contacts Source: https://developer.eventsair.com/docs/reference/types/objects/membership-contact-store Retrieves a list of contacts for the store based on filter criteria. ```APIDOC ## GET MembershipContactStore.contacts ### Description Retrieves contacts for this membership contact store that match the filter criteria. By default, inactive contacts are not returned. ### Parameters #### Query Parameters - **input** (MembershipContactStoreContactSearchFilterInput) - Required - Filter criteria for searching contacts. - **limit** (PaginationLimit) - Required - Positive integer from 1 to 2000 (defaults to 100). - **offset** (NonNegativeInt) - Required - Non-negative integer (defaults to 0). Must be a multiple of the limit. ``` -------------------------------- ### MembershipContactStoreSetup GraphQL Schema Source: https://developer.eventsair.com/docs/reference/types/objects/membership-contact-store-setup Defines the structure of the MembershipContactStoreSetup object, including required fields and pagination arguments for discount codes. ```graphql type MembershipContactStoreSetup { account: AccountSetup! contact: ContactSetup! countryList: CountryList! course: MembershipContactStoreCourseSetup! discountCodes( limit: PaginationLimit! = 100 offset: NonNegativeInt! = 0 ): [MembershipDiscountCode!]! function: MembershipContactStoreFunctionSetup! locations: [Location!]! marketing: MembershipContactStoreMarketingSetup! membership: MembershipSetup! note: MembershipContactStoreNoteSetup! paymentTypes: [PaymentType!]! taxes: [Tax!]! } ``` -------------------------------- ### GET Event.payments Source: https://developer.eventsair.com/docs/reference/types/objects/event Retrieves a list of payments for an event, with support for filtering and pagination. ```APIDOC ## GET Event.payments ### Description Payments for this event that match the filter criteria specified in the optional input argument. ### Method GET ### Parameters #### Query Parameters - **input** (PaymentSearchFilterInput) - Required - Filter criteria for payments. - **limit** (PaginationLimit) - Required - Maximum number of items to return (1-2000). - **offset** (NonNegativeInt) - Required - Number of items to skip (defaults to 0). ``` -------------------------------- ### GET /Event/contacts Source: https://developer.eventsair.com/docs/reference/types/objects/event Retrieves a list of contacts for the event with support for filtering and pagination. ```APIDOC ## GET /Event/contacts ### Description Contacts for this event that match the filter criteria specified in the optional input argument. ### Method GET ### Parameters #### Query Parameters - **input** (ContactSearchFilterInput!) - Required - Filter criteria for the search. - **limit** (PaginationLimit!) - Required - Number of items to return (1-2000). - **offset** (NonNegativeInt!) - Required - Number of items to skip (must be a multiple of limit). ``` -------------------------------- ### AccountSetup Object Definition Source: https://developer.eventsair.com/docs/reference/types/objects/account-setup Details regarding the AccountSetup object structure and its associated fields. ```APIDOC ## AccountSetup Object ### Description Defines the settings for Accounts for an event in EventsAir. ### Fields - **accounts** ([Account!]!) - Non-null object - The accounts defined in EventsAir for an event. ### Member Of - CeContactStoreSetup - EventSetup - MembershipContactStoreSetup ``` -------------------------------- ### Define EventNoteSetup Object Source: https://developer.eventsair.com/docs/reference/types/objects/event-note-setup Defines the structure for event note settings, including a field to retrieve note types with pagination. ```graphql type EventNoteSetup { noteTypes( limit: PaginationLimit! = 100 offset: NonNegativeInt! = 0 ): [EventNoteType!]! } ``` -------------------------------- ### GET /Event/agendaAttendanceItem Source: https://developer.eventsair.com/docs/reference/types/objects/event Retrieves a specific agenda attendance item by its unique identifier. ```APIDOC ## GET /Event/agendaAttendanceItem ### Description Retrieves an agenda attendance item by its identifier. Throws an error with code NOT_FOUND if no agenda attendance item is found. ### Method GET ### Parameters #### Query Parameters - **id** (ID!) - Required - The unique identifier of the agenda attendance item. ``` -------------------------------- ### GET Contact.functionRegistration Source: https://developer.eventsair.com/docs/reference/types/objects/contact Retrieves a specific function registration for a contact by its unique identifier. ```APIDOC ## GET Contact.functionRegistration ### Description Retrieves a function registration by its identifier. Throws an error with code NOT_FOUND if no function registration is found. ### Parameters #### Query Parameters - **id** (ID) - Required - The unique identifier of the function registration. ``` -------------------------------- ### EventMarketingSetup - Tags Source: https://developer.eventsair.com/docs/reference/types/objects/event-marketing-setup Retrieves a list of marketing tags defined for an event. Supports pagination. ```APIDOC ## GET /events/{eventId}/marketing/tags ### Description Retrieves a list of marketing tags defined for an event. Supports pagination using offset and limit. ### Method GET ### Endpoint /events/{eventId}/marketing/tags ### Query Parameters - **offset** (NonNegativeInt) - Optional - The number of records to skip. Defaults to 0. - **limit** (PaginationLimit) - Optional - The maximum number of records to return. Defaults to 100. Maximum value is 2000. ### Response #### Success Response (200) - **tags** ([EventMarketingTag!]!) - A list of marketing tags. #### Response Example ```json { "tags": [ { "id": "tag1", "name": "Discount" } ] } ``` ``` -------------------------------- ### GET Contact.courseRegistrations Source: https://developer.eventsair.com/docs/reference/types/objects/contact Retrieves course registrations for a contact with optional filtering and pagination. ```APIDOC ## GET Contact.courseRegistrations ### Description Retrieves the course registrations for this contact that match the filter criteria specified in the optional input argument. ### Parameters #### Query Parameters - **input** (CourseRegistrationSearchFilterInput) - Required - Filter criteria for course registrations. - **limit** (PaginationLimit) - Required - Positive integer from 1 to 2000 (defaults to 100). - **offset** (NonNegativeInt) - Required - Non-negative integer (defaults to 0). ### Response #### Success Response (200) - **EventCourseRegistration** (Array) - List of course registrations. ``` -------------------------------- ### POST /createCeContactStoreCourse Source: https://developer.eventsair.com/docs/reference/operations/mutations/create-ce-contact-store-course Creates a new course in a continuing education contact store. Validates that the store, credit types, classifications, and instructors exist and are correctly associated. ```APIDOC ## POST createCeContactStoreCourse ### Description Creates a course in a continuing education contact store. ### Method POST ### Endpoint createCeContactStoreCourse ### Parameters #### Request Body - **input** (CreateCeContactStoreCourseInput!) - Required - The input object containing course details, including ceContactStoreId, credits, classifications, and instructors. ### Response #### Success Response - **payload** (CreateCeContactStoreCoursePayload!) - The payload returned upon successful creation of the course. ### Error Handling - **NOT_FOUND**: Thrown if the ceContactStoreId is invalid. - **NOT_FOUND**: Thrown if any creditTypeId is not found in the store. - **NOT_FOUND**: Thrown if any courseClassificationId is not found in the store. - **NOT_FOUND**: Thrown if a courseSubClassificationId is not associated with the specified courseClassificationId. - **NOT_FOUND**: Thrown if any contactId in the instructors collection is not found in the store. ``` -------------------------------- ### GET Contact.ceCredits Source: https://developer.eventsair.com/docs/reference/types/objects/contact Retrieves the list of continuing education credits associated with the contact. ```APIDOC ## GET Contact.ceCredits ### Description Retrieves the list of continuing education credits associated with the contact with pagination support. ### Parameters #### Query Parameters - **limit** (PaginationLimit) - Required - Positive integer from 1 to 2000 (defaults to 100). - **offset** (NonNegativeInt) - Required - Non-negative integer (defaults to 0). ### Response #### Success Response (200) - **EventCeCredit** (Array) - List of continuing education credits. ``` -------------------------------- ### PresentationSetup Object Source: https://developer.eventsair.com/docs/reference/types/objects/presentation-setup Defines the settings for Presentations for an event in EventsAir. ```APIDOC ## PresentationSetup Object ### Description Defines the settings for Presentations for an event in EventsAir. ### Fields #### `checklist` ([ `ChecklistItem`! ]!) - non-null object - The list of checklist items for presentation. #### `concurrentSessionBlocks` ([ `SessionBlock`! ]!) - non-null object - The blocks available for concurrent sessions. #### `documentTypes` ([ `DocumentType`! ]!) - non-null interface - The types of documents defined for a presentation. #### `keywords` ([ `PresentationKeyword`! ]!) - non-null object - The collection of terms or words that can help an organizer locate specific categories of presentations. #### `locations` ([ `Location`! ]!) - deprecated non-null object - DEPRECATED Use `setup.locations` instead. This field will be removed in a future release. - The locations available for presentations to be held in. #### `paperStatuses` ([ `PresentationPaperStatus`! ]!) - non-null object - The definitions created to classify the status of submitted papers or presentations. #### `preferences` (`PresentationPreferences`!) - non-null object - The configuration preferences for a Presentation. #### `sessionRoles` ([ `SessionRole`! ]!) - non-null object - The roles available for sessions. #### `sessionSurveys` ([ `SessionSurvey`! ]!) - non-null object - The surveys available for sessions. #### `themes` ([ `PresentationTheme`! ]!) - non-null object - The Presentation themes and sub themes defined in EventsAir for an event. #### `types` ([ `PresentationType`! ]!) - non-null object - The types of Presentations defined in EventsAir for an event. ### Member Of `EventSetup` object ``` -------------------------------- ### GET CeContactStore.payments Source: https://developer.eventsair.com/docs/reference/types/objects/ce-contact-store Retrieves a list of payments for the CeContactStore, supporting filtering and pagination. ```APIDOC ## GET CeContactStore.payments ### Description Payments for this continuing education contact store that match the filter criteria specified in the optional input argument. Supports pagination via offset and limit. ### Method GET ### Endpoint CeContactStore.payments ### Parameters #### Query Parameters - **input** (PaymentSearchFilterInput!) - Required - Filter criteria for payments. - **limit** (PaginationLimit!) - Required - Positive integer from 1 to 2000 (defaults to 100). - **offset** (NonNegativeInt!) - Required - Non-negative integer (defaults to 0). ``` -------------------------------- ### GET /CeContactStore/functionRegistrations Source: https://developer.eventsair.com/docs/reference/types/objects/ce-contact-store Retrieves a paginated list of function registrations for the contact store. ```APIDOC ## GET /CeContactStore/functionRegistrations ### Description A list of function registrations for this continuing education contact store. ### Parameters #### Query Parameters - **input** (FunctionRegistrationSearchFilterInput!) - Required - Filter criteria for function registrations. - **limit** (PaginationLimit!) - Required - Number of items to return (1-2000, default 100). - **offset** (NonNegativeInt!) - Required - Number of items to skip (default 0). ``` -------------------------------- ### Mutation: createCeContactStoreCourse Source: https://developer.eventsair.com/docs/reference/types/inputs/create-ce-contact-store-course-input Defines the input structure for creating a new continuing education contact store course. ```APIDOC ## mutation createCeContactStoreCourse ### Description Creates a new course within a continuing education contact store. ### Request Body - **status** (CourseStatus!) - Required - The status of this course. - **textColor** (HexColorCode) - Optional - The hex color code to use when rendering the course's text. - **uniqueCode** (String!) - Required - A customer supplied, UTF-8 string value that represents a unique code for the course. Must be unique across all courses for a continuing education contact store. ``` -------------------------------- ### RegistrationSetup Object Fields Source: https://developer.eventsair.com/docs/reference/types/objects/registration-setup Details regarding the fields available within the RegistrationSetup object, including paginated lists for discount codes, groups, and types. ```APIDOC ## RegistrationSetup Object ### Description Defines the settings for registrations for an event in EventsAir. ### Fields - **discountCodes** ([RegistrationDiscountCode!]!) - A list of registration discount codes defined for this event. - **limit** (PaginationLimit!) - Optional - Positive integer from 1 to 2000 (default 100). - **offset** (NonNegativeInt!) - Optional - Non-negative integer (default 0). - **preferences** (RegistrationPreferences!) - The configuration preferences for a registration. - **registrationGroups** ([RegistrationGroup!]!) - A list of registration groups associated with this event. - **limit** (PaginationLimit!) - Optional - Positive integer from 1 to 2000 (default 100). - **offset** (NonNegativeInt!) - Optional - Non-negative integer (default 0). - **registrationTypes** ([RegistrationType!]!) - A list of registration types associated with this event. - **limit** (PaginationLimit!) - Optional - Positive integer from 1 to 2000 (default 100). - **offset** (NonNegativeInt!) - Optional - Non-negative integer (default 0). ``` -------------------------------- ### GET /suppliers Source: https://developer.eventsair.com/docs/reference/operations/queries/suppliers Retrieves a paginated list of suppliers from the EventsAir supplier library. ```APIDOC ## GET /suppliers ### Description Retrieves the list of suppliers in the supplier library in EventsAir. Supports pagination using limit and offset. ### Method GET ### Endpoint /suppliers ### Parameters #### Query Parameters - **limit** (PaginationLimit) - Optional - A positive integer from 1 to 2000 (defaults to 100). - **offset** (NonNegativeInt) - Optional - A non-negative integer (defaults to 0). ### Response #### Success Response (200) - **suppliers** (List of Supplier objects) - A list of supplier objects. ``` -------------------------------- ### Get API Version Information Source: https://developer.eventsair.com/docs/reference/operations/queries/version-information This endpoint returns the version information of the API. ```APIDOC ## GET /versionInformation ### Description Returns information about the API version. ### Method GET ### Endpoint /versionInformation ### Response #### Success Response (200) - **versionInformation** (VersionInformation) - Information about the API version. ### Type #### `**VersionInformation**` object Information about the API version. ``` -------------------------------- ### Define CreateWebhookSubscriptionInput Source: https://developer.eventsair.com/docs/reference/types/inputs/create-webhook-subscription-input Use this input type to define the parameters for creating a webhook subscription. It includes fields for a description, optional filters, the webhook URL, and a list of event type names to subscribe to. A maximum of 10 filters can be applied. ```graphql input CreateWebhookSubscriptionInput { description: String! filters: [WebhookSubscriptionFilterInput!] url: URL! webhookEventTypeNames: [String!]! } ``` -------------------------------- ### GET /currencies Source: https://developer.eventsair.com/docs/reference/operations/queries/currencies Retrieves a list of currencies from the EventsAir library with support for pagination. ```APIDOC ## GET /currencies ### Description Retrieves the list of currencies in the currency library in EventsAir. ### Method GET ### Endpoint /currencies ### Parameters #### Query Parameters - **limit** (PaginationLimit!) - Optional - A positive integer from 1 to 2000 (defaults to 100). - **offset** (NonNegativeInt!) - Optional - A non-negative integer (defaults to 0). ### Response #### Success Response (200) - **Currency** (object) - A currency as defined in the EventsAir currency library. ```