import {z} from 'zod' export type GetApiV3AdministrationsAdministrationIdAgreementsIdArgs = {administration_id: string, id: string, 'fields[agreement]'?: string | undefined, include?: string | undefined, 'Accept-Language'?: string | undefined}; export type GetApiV3AdministrationsAdministrationIdAgreementsIdOptions = {baseUrl?: string | undefined, ApiKeyAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const agreement = z.object({id: z.string().optional(), type: z.string().optional(), attributes: z.object({active_from: z.string().optional(), active_till: z.string().optional(), name: z.string().optional(), frequency: z.enum(["anytime", "monthly", "quarterly", "halfyearly", "yearly"]).optional(), settlement_method: z.enum(["end_date", "start_date", "overlapping", "confirmed_date"]).optional(), apply_rent_earned_account_to_costs: z.boolean().optional(), poule_share_multiplier: z.number().optional(), discount_mode: z.string().optional(), owner_reservable: z.boolean().optional(), owner_can_make_reservation_on_irregular_price_periods: z.boolean().optional(), owner_can_make_reservation_outside_schemes: z.boolean().optional(), owner_can_cancel_reservations: z.boolean().optional(), can_promote: z.boolean().optional(), owner_can_view_availability: z.boolean().optional(), owner_can_view_reservations: z.boolean().optional(), owner_can_view_contact_data: z.boolean().optional(), owner_can_view_guest_order: z.boolean().optional(), owner_can_view_channel_order: z.boolean().optional(), owner_can_view_rent_amount: z.boolean().optional(), owner_can_view_guest_invoice: z.boolean().optional(), owner_can_view_channel_invoice: z.boolean().optional(), owner_can_view_settlements: z.boolean().optional(), owner_can_view_settlement_calculation_explanations: z.boolean().optional(), owner_should_check_reservations: z.boolean().optional(), owner_can_edit_agenda_periods: z.boolean().optional(), owner_can_view_rentable_details: z.boolean().optional(), owner_can_create_pricing_change_request: z.boolean().optional(), owner_can_view_guest_details: z.boolean().optional(), owner_can_view_guest_memo: z.boolean().optional(), owner_can_view_todos: z.boolean().optional(), can_view_reviews: z.boolean().optional(), created_at: z.string().optional(), updated_at: z.string().optional()}).optional(), relationships: z.object({owner: z.object({data: z.object({id: z.string().optional(), type: z.string().optional(), meta: z.object({temp_id: z.string().optional(), method: z.string().optional()}).optional()}).optional()}).optional(), inventory_object: z.object({data: z.object({id: z.string().optional(), type: z.string().optional(), meta: z.object({temp_id: z.string().optional(), method: z.string().optional()}).optional()}).optional()}).optional(), owners_profile: z.object({data: z.object({id: z.string().optional(), type: z.string().optional(), meta: z.object({temp_id: z.string().optional(), method: z.string().optional()}).optional()}).optional()}).optional(), administration: z.object({data: z.object({id: z.string().optional(), type: z.string().optional(), meta: z.object({temp_id: z.string().optional(), method: z.string().optional()}).optional()}).optional()}).optional(), commission_agreement: z.object({data: z.object({id: z.string().optional(), type: z.string().optional(), meta: z.object({temp_id: z.string().optional(), method: z.string().optional()}).optional()}).optional()}).optional(), poule_based_discounts: z.object({data: z.array(z.object({id: z.string().optional(), type: z.string().optional(), meta: z.object({temp_id: z.string().optional(), method: z.string().optional()}).optional()})).optional()}).optional(), rentable_identity: z.object({data: z.object({id: z.string().optional(), type: z.string().optional(), meta: z.object({temp_id: z.string().optional(), method: z.string().optional()}).optional()}).optional()}).optional(), rent_earned_account: z.object({data: z.object({id: z.string().optional(), type: z.string().optional(), meta: z.object({temp_id: z.string().optional(), method: z.string().optional()}).optional()}).optional()}).optional()}).optional(), meta: z.object({temp_id: z.string().optional()}).optional()}); export const owner = z.object({id: z.string().optional(), type: z.string().optional(), attributes: z.object({license_plate_number: z.string().optional(), memo: z.string().optional(), pays_vat: z.boolean().optional(), pay_in_advance: z.boolean().optional(), invoice_from: z.string().optional(), contract_ends_at: z.string().optional(), active: z.boolean().optional(), psp_recurring_enabled_at: z.string().optional(), promotion_token: z.string().optional(), title: z.enum(["mr", "ms", "family", "mrs", "miss", "mx", "dr", "prof", "rev", "sir", "dame", "lord", "lady"]).optional(), first_name: z.string().optional(), last_name: z.string().optional(), phone: z.string().optional(), mobile_phone: z.string().optional(), nationality: z.string().optional(), gender: z.enum(["male", "female", "other", "prefer_not_to_say"]).optional(), email: z.string().optional(), linked_emails: z.array(z.string()).optional(), is_company: z.boolean().optional(), company: z.string().optional(), vat_nr: z.string().optional(), tin: z.string().optional(), business_registration_number: z.string().optional(), date_of_birth: z.string().optional(), receive_newsletter: z.boolean().optional(), locale: z.enum(["cs", "da-DK", "de", "de-AT", "de-CH", "en-US", "en-GB", "es", "fr", "fr-BE", "fr-LU", "it", "nb", "nl", "nl-BE", "pl", "pt", "tr", "en", "da"]).optional(), address: z.string().optional(), address_line_1: z.string().optional(), address_line_2: z.string().optional(), number: z.string().optional(), postalcode: z.string().optional(), city: z.string().optional(), country_code: z.string().optional(), iban: z.string().optional(), bic: z.string().optional(), debtor_code: z.string().optional()}).optional(), relationships: z.object({primary_contact: z.object({data: z.object({id: z.string().optional(), type: z.string().optional(), meta: z.object({temp_id: z.string().optional(), method: z.string().optional()}).optional()}).optional()}).optional(), contacts: z.object({data: z.array(z.object({id: z.string().optional(), type: z.string().optional(), meta: z.object({temp_id: z.string().optional(), method: z.string().optional()}).optional()})).optional()}).optional(), administration: z.object({data: z.object({id: z.string().optional(), type: z.string().optional(), meta: z.object({temp_id: z.string().optional(), method: z.string().optional()}).optional()}).optional()}).optional(), active_inventory_objects: z.object({data: z.array(z.object({id: z.string().optional(), type: z.string().optional(), meta: z.object({temp_id: z.string().optional(), method: z.string().optional()}).optional()})).optional()}).optional(), owner_guests: z.object({data: z.array(z.object({id: z.string().optional(), type: z.string().optional(), meta: z.object({temp_id: z.string().optional(), method: z.string().optional()}).optional()})).optional()}).optional(), active_rentable_identities: z.object({data: z.object({id: z.string().optional(), type: z.string().optional(), meta: z.object({temp_id: z.string().optional(), method: z.string().optional()}).optional()}).optional()}).optional(), labels: z.object({data: z.array(z.object({id: z.string().optional(), type: z.string().optional(), meta: z.object({temp_id: z.string().optional(), method: z.string().optional()}).optional()})).optional()}).optional()}).optional(), meta: z.object({temp_id: z.string().optional()}).optional()}); export const inventoryObject = z.object({id: z.string().optional(), type: z.string().optional(), attributes: z.object({name: z.string().optional(), original_identifier: z.string().optional(), door_name: z.string().optional(), energy_label: z.enum(["exempt", "A++++", "A+++", "A++", "A+", "A", "B", "C", "D", "E", "F", "G", "H"]).optional(), surface_area: z.number().int().optional(), lot_number: z.string().optional(), blocked: z.boolean().optional(), custom_fields: z.array(z.object({key: z.string().optional(), text_value: z.string().optional(), integer_value: z.number().int().optional()})).optional(), attachment_text: z.object({cs: z.string().optional(), "da-DK": z.string().optional(), de: z.string().optional(), "de-AT": z.string().optional(), "de-CH": z.string().optional(), "en-US": z.string().optional(), "en-GB": z.string().optional(), es: z.string().optional(), fr: z.string().optional(), "fr-BE": z.string().optional(), "fr-LU": z.string().optional(), it: z.string().optional(), nb: z.string().optional(), nl: z.string().optional(), "nl-BE": z.string().optional(), pl: z.string().optional(), pt: z.string().optional(), tr: z.string().optional(), en: z.string().optional(), da: z.string().optional()}).optional(), name_with_type: z.string().optional(), cluster_parent: z.boolean().optional(), archived: z.boolean().optional(), created_at: z.string().optional(), updated_at: z.string().optional()}).optional(), relationships: z.object({current_or_future_external_blocked_agenda_periods: z.object({data: z.array(z.object({id: z.string().optional(), type: z.string().optional(), meta: z.object({temp_id: z.string().optional(), method: z.string().optional()}).optional()})).optional()}).optional(), labels: z.object({data: z.array(z.object({id: z.string().optional(), type: z.string().optional(), meta: z.object({temp_id: z.string().optional(), method: z.string().optional()}).optional()})).optional()}).optional(), administration: z.object({data: z.object({id: z.string().optional(), type: z.string().optional(), meta: z.object({temp_id: z.string().optional(), method: z.string().optional()}).optional()}).optional()}).optional(), cluster_children: z.object({data: z.array(z.object({id: z.string().optional(), type: z.string().optional(), meta: z.object({temp_id: z.string().optional(), method: z.string().optional()}).optional()})).optional()}).optional(), images: z.object({data: z.array(z.object({id: z.string().optional(), type: z.string().optional(), meta: z.object({temp_id: z.string().optional(), method: z.string().optional()}).optional()})).optional()}).optional()}).optional(), meta: z.object({temp_id: z.string().optional()}).optional()}); export const ownersProfile = z.object({id: z.string().optional(), type: z.string().optional(), attributes: z.object({owner_can_view_order: z.boolean().optional(), owner_can_view_invoice: z.boolean().optional(), name: z.string().optional(), owner_reservable: z.boolean().optional(), owner_can_make_reservation_on_irregular_price_periods: z.boolean().optional(), owner_can_make_reservation_outside_schemes: z.boolean().optional(), owner_can_cancel_reservations: z.boolean().optional(), can_promote: z.boolean().optional(), owner_can_view_availability: z.boolean().optional(), owner_can_view_reservations: z.boolean().optional(), owner_can_view_contact_data: z.boolean().optional(), owner_can_view_guest_order: z.boolean().optional(), owner_can_view_rent_amount: z.boolean().optional(), owner_can_view_guest_invoice: z.boolean().optional(), owner_can_view_settlements: z.boolean().optional(), owner_can_view_settlement_calculation_explanations: z.boolean().optional(), owner_should_check_reservations: z.boolean().optional(), owner_can_edit_agenda_periods: z.boolean().optional(), owner_can_view_rentable_details: z.boolean().optional(), owner_can_create_pricing_change_request: z.boolean().optional(), owner_can_view_guest_details: z.boolean().optional(), owner_can_view_guest_memo: z.boolean().optional(), owner_can_view_todos: z.boolean().optional(), can_view_reviews: z.boolean().optional()}).optional(), meta: z.object({temp_id: z.string().optional()}).optional()}); export const administration = z.object({id: z.string().optional(), type: z.string().optional(), attributes: z.object({name: z.string().optional(), email: z.string().optional(), phone: z.string().optional(), website: z.string().optional(), native_currency: z.string().optional(), address: z.string().optional(), country_code: z.string().optional(), postal_code: z.string().optional(), city: z.object({cs: z.string().optional(), "da-DK": z.string().optional(), de: z.string().optional(), "de-AT": z.string().optional(), "de-CH": z.string().optional(), "en-US": z.string().optional(), "en-GB": z.string().optional(), es: z.string().optional(), fr: z.string().optional(), "fr-BE": z.string().optional(), "fr-LU": z.string().optional(), it: z.string().optional(), nb: z.string().optional(), nl: z.string().optional(), "nl-BE": z.string().optional(), pl: z.string().optional(), pt: z.string().optional(), tr: z.string().optional(), en: z.string().optional(), da: z.string().optional()}).optional(), description: z.object({cs: z.string().optional(), "da-DK": z.string().optional(), de: z.string().optional(), "de-AT": z.string().optional(), "de-CH": z.string().optional(), "en-US": z.string().optional(), "en-GB": z.string().optional(), es: z.string().optional(), fr: z.string().optional(), "fr-BE": z.string().optional(), "fr-LU": z.string().optional(), it: z.string().optional(), nb: z.string().optional(), nl: z.string().optional(), "nl-BE": z.string().optional(), pl: z.string().optional(), pt: z.string().optional(), tr: z.string().optional(), en: z.string().optional(), da: z.string().optional()}).optional(), surroundings_description: z.object({cs: z.string().optional(), "da-DK": z.string().optional(), de: z.string().optional(), "de-AT": z.string().optional(), "de-CH": z.string().optional(), "en-US": z.string().optional(), "en-GB": z.string().optional(), es: z.string().optional(), fr: z.string().optional(), "fr-BE": z.string().optional(), "fr-LU": z.string().optional(), it: z.string().optional(), nb: z.string().optional(), nl: z.string().optional(), "nl-BE": z.string().optional(), pl: z.string().optional(), pt: z.string().optional(), tr: z.string().optional(), en: z.string().optional(), da: z.string().optional()}).optional(), tin: z.string().optional(), vat_nr: z.string().optional(), available_locales: z.array(z.string()).optional(), native_locale: z.string().optional(), timezone: z.string().optional(), invoice_email: z.string().optional(), invoice_phone: z.string().optional(), invoice_address: z.string().optional(), invoice_postalcode: z.string().optional(), invoice_city: z.string().optional(), invoice_country_code: z.string().optional(), billing_vat_percentage: z.number().int().optional(), available_currencies: z.array(z.string()).optional(), map_available: z.boolean().optional(), guest_list_group: z.enum(["main_guest", "all", "adults", "none"]).optional(), guest_accepted_document_type: z.array(z.enum(["passport", "license", "identity_card"])).optional(), guest_identification_required: z.enum(["none", "main_guest", "all", "adults"]).optional(), ask_for_guest_gender: z.boolean().optional(), ask_for_guest_address: z.boolean().optional(), ask_for_guest_postal_code: z.boolean().optional(), ask_for_guest_city: z.boolean().optional(), ask_for_guest_country: z.boolean().optional(), ask_for_guest_email: z.boolean().optional(), ask_for_guest_phone: z.boolean().optional(), ask_for_guest_profession: z.boolean().optional(), ask_for_guest_signature: z.boolean().optional(), ask_for_fellow_guest_gender: z.boolean().optional(), ask_for_fellow_guest_address: z.boolean().optional(), ask_for_fellow_guest_postal_code: z.boolean().optional(), ask_for_fellow_guest_city: z.boolean().optional(), ask_for_fellow_guest_country: z.boolean().optional(), ask_for_fellow_guest_email: z.boolean().optional(), ask_for_fellow_guest_phone: z.boolean().optional(), ask_for_fellow_guest_profession: z.boolean().optional(), ask_for_fellow_guest_signature: z.boolean().optional(), default_option_validity: z.number().int().optional(), max_options_per_customer: z.number().int().optional(), max_options_per_booker: z.number().int().optional(), latitude: z.number().optional(), longitude: z.number().optional(), allow_multi_reservation_bookings_through_api: z.boolean().optional(), accounting_closed_upto: z.string().optional(), enable_license_plates: z.boolean().optional(), iban: z.string().optional(), bic: z.string().optional(), peppol_identifiers: z.array(z.object({scheme: z.string().optional(), value: z.string().optional()})).optional(), created_at: z.string().optional(), updated_at: z.string().optional()}).optional(), links: z.object({self: z.string().optional(), url: z.string().optional()}).optional(), relationships: z.object({city: z.object({data: z.object({id: z.string().optional(), type: z.string().optional(), meta: z.object({temp_id: z.string().optional(), method: z.string().optional()}).optional()}).optional()}).optional(), checkin_timetable: z.object({data: z.object({id: z.string().optional(), type: z.string().optional(), meta: z.object({temp_id: z.string().optional(), method: z.string().optional()}).optional()}).optional()}).optional(), checkout_timetable: z.object({data: z.object({id: z.string().optional(), type: z.string().optional(), meta: z.object({temp_id: z.string().optional(), method: z.string().optional()}).optional()}).optional()}).optional(), interactive_map: z.object({data: z.object({id: z.string().optional(), type: z.string().optional(), meta: z.object({temp_id: z.string().optional(), method: z.string().optional()}).optional()}).optional()}).optional(), payment_handlers: z.object({data: z.array(z.object({id: z.string().optional(), type: z.string().optional(), meta: z.object({temp_id: z.string().optional(), method: z.string().optional()}).optional()})).optional()}).optional()}).optional(), meta: z.object({temp_id: z.string().optional()}).optional()}); export const commissionAgreement = z.object({id: z.string().optional(), type: z.string().optional(), attributes: z.object({name: z.string().optional(), frequency: z.enum(["anytime", "monthly", "quarterly", "halfyearly", "yearly"]).optional(), settlement_method: z.enum(["end_date", "start_date", "overlapping", "confirmed_date"]).optional(), created_at: z.string().optional(), updated_at: z.string().optional(), fixed_payout: z.object({currency: z.string().optional(), value: z.string().optional()}).optional()}).optional(), meta: z.object({temp_id: z.string().optional()}).optional()}); export const pouleBasedDiscount = z.object({id: z.string().optional(), type: z.string().optional(), attributes: z.object({points_available: z.number().int().optional(), start_date: z.string().optional(), end_date: z.string().optional(), created_at: z.string().optional(), updated_at: z.string().optional()}).optional(), relationships: z.object({agreement: z.object({data: z.object({id: z.string().optional(), type: z.string().optional(), meta: z.object({temp_id: z.string().optional(), method: z.string().optional()}).optional()}).optional()}).optional()}).optional(), meta: z.object({temp_id: z.string().optional()}).optional()}); export const rentableIdentity = z.object({id: z.string().optional(), type: z.string().optional(), attributes: z.object({name: z.string().optional(), original_identifier: z.string().optional(), door_name: z.string().optional(), energy_label: z.enum(["exempt", "A++++", "A+++", "A++", "A+", "A", "B", "C", "D", "E", "F", "G", "H"]).optional(), surface_area: z.number().int().optional(), lot_number: z.string().optional(), blocked: z.boolean().optional(), custom_fields: z.array(z.object({key: z.string().optional(), text_value: z.string().optional(), integer_value: z.number().int().optional()})).optional(), attachment_text: z.object({cs: z.string().optional(), "da-DK": z.string().optional(), de: z.string().optional(), "de-AT": z.string().optional(), "de-CH": z.string().optional(), "en-US": z.string().optional(), "en-GB": z.string().optional(), es: z.string().optional(), fr: z.string().optional(), "fr-BE": z.string().optional(), "fr-LU": z.string().optional(), it: z.string().optional(), nb: z.string().optional(), nl: z.string().optional(), "nl-BE": z.string().optional(), pl: z.string().optional(), pt: z.string().optional(), tr: z.string().optional(), en: z.string().optional(), da: z.string().optional()}).optional(), name_with_type: z.string().optional(), cluster_parent: z.boolean().optional(), archived: z.boolean().optional(), created_at: z.string().optional(), updated_at: z.string().optional()}).optional(), relationships: z.object({current_or_future_external_blocked_agenda_periods: z.object({data: z.array(z.object({id: z.string().optional(), type: z.string().optional(), meta: z.object({temp_id: z.string().optional(), method: z.string().optional()}).optional()})).optional()}).optional(), labels: z.object({data: z.array(z.object({id: z.string().optional(), type: z.string().optional(), meta: z.object({temp_id: z.string().optional(), method: z.string().optional()}).optional()})).optional()}).optional(), administration: z.object({data: z.object({id: z.string().optional(), type: z.string().optional(), meta: z.object({temp_id: z.string().optional(), method: z.string().optional()}).optional()}).optional()}).optional(), cluster_children: z.object({data: z.array(z.object({id: z.string().optional(), type: z.string().optional(), meta: z.object({temp_id: z.string().optional(), method: z.string().optional()}).optional()})).optional()}).optional(), images: z.object({data: z.array(z.object({id: z.string().optional(), type: z.string().optional(), meta: z.object({temp_id: z.string().optional(), method: z.string().optional()}).optional()})).optional()}).optional()}).optional(), meta: z.object({temp_id: z.string().optional()}).optional()}); export const ledgerAccount = z.object({id: z.string().optional(), type: z.string().optional(), attributes: z.object({created_at: z.string().optional(), updated_at: z.string().optional(), number: z.string().optional(), name: z.string().optional(), report_type: z.string().optional(), fixed_type: z.enum(["cash", "bank", "pin", "psp", "safe", "booking", "channel", "pos", "owner", "pre_invoiced_turnover", "vat_low_payable", "vat_high_payable", "settlements", "batch", "vouchers", "other_parks", "advances", "uncategorized_payments", "security_deposits", "security_deposits_damages", "payment_difference", "cash_difference", "rent", "uncategorized_expenses", "uncategorized_turnover"]).optional(), current_vat_rate: z.number().optional()}).optional(), relationships: z.object({vat_code: z.object({data: z.object({id: z.string().optional(), type: z.string().optional(), meta: z.object({temp_id: z.string().optional(), method: z.string().optional()}).optional()}).optional()}).optional()}).optional(), meta: z.object({temp_id: z.string().optional()}).optional()}); export const getApiV3AdministrationsAdministrationIdAgreementsIdResponse = z.object({data: agreement.optional(), included: z.array(z.union([owner, inventoryObject, ownersProfile, administration, commissionAgreement, pouleBasedDiscount, rentableIdentity, ledgerAccount])).optional()}); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * GET agreement * * GET /v3/administrations/{administration_id}/agreements/{id} * * Also accepts auth: OAuth2 */ export const getApiV3AdministrationsAdministrationIdAgreementsId = async (args: GetApiV3AdministrationsAdministrationIdAgreementsIdArgs, options?: GetApiV3AdministrationsAdministrationIdAgreementsIdOptions) => { const {baseUrl = "https://api.bookingexperts.com", fetch: fetchFn = fetch, ApiKeyAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/vnd.api+json") if (args['fields[agreement]'] != null) query.append("fields[agreement]", String(args['fields[agreement]'])) if (args.include != null) query.append("include", String(args.include)) if (args['Accept-Language'] != null) headers.set("Accept-Language", String(args['Accept-Language'])) if (ApiKeyAuth !== undefined) headers.set("X-API-KEY", ApiKeyAuth) const url = `${baseUrl.replace(/\/+$/, '')}/v3/administrations/${encodeURIComponent(String(args.administration_id))}/agreements/${encodeURIComponent(String(args.id))}${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "GET", headers}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(getApiV3AdministrationsAdministrationIdAgreementsIdResponse, await res.json()) };