@praxium/sdk 0.2.4

package/src/generated/core/types.gen.ts

@@ -0,0 +1,104 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+import type { Auth, AuthToken } from './auth.gen';
+import type { BodySerializer, QuerySerializer, QuerySerializerOptions } from './bodySerializer.gen';
+
+export type HttpMethod =
+  | 'connect'
+  | 'delete'
+  | 'get'
+  | 'head'
+  | 'options'
+  | 'patch'
+  | 'post'
+  | 'put'
+  | 'trace';
+
+export type Client<
+  RequestFn = never,
+  Config = unknown,
+  MethodFn = never,
+  BuildUrlFn = never,
+  SseFn = never,
+> = {
+  /**
+   * Returns the final request URL.
+   */
+  buildUrl: BuildUrlFn;
+  getConfig: () => Config;
+  request: RequestFn;
+  setConfig: (config: Config) => Config;
+} & {
+  [K in HttpMethod]: MethodFn;
+} & ([SseFn] extends [never] ? { sse?: never } : { sse: { [K in HttpMethod]: SseFn } });
+
+export interface Config {
+  /**
+   * Auth token or a function returning auth token. The resolved value will be
+   * added to the request payload as defined by its `security` array.
+   */
+  auth?: ((auth: Auth) => Promise<AuthToken> | AuthToken) | AuthToken;
+  /**
+   * A function for serializing request body parameter. By default,
+   * {@link JSON.stringify()} will be used.
+   */
+  bodySerializer?: BodySerializer | null;
+  /**
+   * An object containing any HTTP headers that you want to pre-populate your
+   * `Headers` object with.
+   *
+   * {@link https://developer.mozilla.org/docs/Web/API/Headers/Headers#init See more}
+   */
+  headers?:
+    | RequestInit['headers']
+    | Record<
+        string,
+        string | number | boolean | (string | number | boolean)[] | null | undefined | unknown
+      >;
+  /**
+   * The request method.
+   *
+   * {@link https://developer.mozilla.org/docs/Web/API/fetch#method See more}
+   */
+  method?: Uppercase<HttpMethod>;
+  /**
+   * A function for serializing request query parameters. By default, arrays
+   * will be exploded in form style, objects will be exploded in deepObject
+   * style, and reserved characters are percent-encoded.
+   *
+   * This method will have no effect if the native `paramsSerializer()` Axios
+   * API function is used.
+   *
+   * {@link https://swagger.io/docs/specification/serialization/#query View examples}
+   */
+  querySerializer?: QuerySerializer | QuerySerializerOptions;
+  /**
+   * A function validating request data. This is useful if you want to ensure
+   * the request conforms to the desired shape, so it can be safely sent to
+   * the server.
+   */
+  requestValidator?: (data: unknown) => Promise<unknown>;
+  /**
+   * A function transforming response data before it's returned. This is useful
+   * for post-processing data, e.g. converting ISO strings into Date objects.
+   */
+  responseTransformer?: (data: unknown) => Promise<unknown>;
+  /**
+   * A function validating response data. This is useful if you want to ensure
+   * the response conforms to the desired shape, so it can be safely passed to
+   * the transformers and returned to the user.
+   */
+  responseValidator?: (data: unknown) => Promise<unknown>;
+}
+
+type IsExactlyNeverOrNeverUndefined<T> = [T] extends [never]
+  ? true
+  : [T] extends [never | undefined]
+    ? [undefined] extends [T]
+      ? false
+      : true
+    : false;
+
+export type OmitNever<T extends Record<string, unknown>> = {
+  [K in keyof T as IsExactlyNeverOrNeverUndefined<T[K]> extends true ? never : K]: T[K];
+};

package/src/generated/core/utils.gen.ts

@@ -0,0 +1,140 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+import type { BodySerializer, QuerySerializer } from './bodySerializer.gen';
+import {
+  type ArraySeparatorStyle,
+  serializeArrayParam,
+  serializeObjectParam,
+  serializePrimitiveParam,
+} from './pathSerializer.gen';
+
+export interface PathSerializer {
+  path: Record<string, unknown>;
+  url: string;
+}
+
+export const PATH_PARAM_RE = /\{[^{}]+\}/g;
+
+export const defaultPathSerializer = ({ path, url: _url }: PathSerializer) => {
+  let url = _url;
+  const matches = _url.match(PATH_PARAM_RE);
+  if (matches) {
+    for (const match of matches) {
+      let explode = false;
+      let name = match.substring(1, match.length - 1);
+      let style: ArraySeparatorStyle = 'simple';
+
+      if (name.endsWith('*')) {
+        explode = true;
+        name = name.substring(0, name.length - 1);
+      }
+
+      if (name.startsWith('.')) {
+        name = name.substring(1);
+        style = 'label';
+      } else if (name.startsWith(';')) {
+        name = name.substring(1);
+        style = 'matrix';
+      }
+
+      const value = path[name];
+
+      if (value === undefined || value === null) {
+        continue;
+      }
+
+      if (Array.isArray(value)) {
+        url = url.replace(match, serializeArrayParam({ explode, name, style, value }));
+        continue;
+      }
+
+      if (typeof value === 'object') {
+        url = url.replace(
+          match,
+          serializeObjectParam({
+            explode,
+            name,
+            style,
+            value: value as Record<string, unknown>,
+            valueOnly: true,
+          }),
+        );
+        continue;
+      }
+
+      if (style === 'matrix') {
+        url = url.replace(
+          match,
+          `;${serializePrimitiveParam({
+            name,
+            value: value as string,
+          })}`,
+        );
+        continue;
+      }
+
+      const replaceValue = encodeURIComponent(
+        style === 'label' ? `.${value as string}` : (value as string),
+      );
+      url = url.replace(match, replaceValue);
+    }
+  }
+  return url;
+};
+
+export const getUrl = ({
+  baseUrl,
+  path,
+  query,
+  querySerializer,
+  url: _url,
+}: {
+  baseUrl?: string;
+  path?: Record<string, unknown>;
+  query?: Record<string, unknown>;
+  querySerializer: QuerySerializer;
+  url: string;
+}) => {
+  const pathUrl = _url.startsWith('/') ? _url : `/${_url}`;
+  let url = (baseUrl ?? '') + pathUrl;
+  if (path) {
+    url = defaultPathSerializer({ path, url });
+  }
+  let search = query ? querySerializer(query) : '';
+  if (search.startsWith('?')) {
+    search = search.substring(1);
+  }
+  if (search) {
+    url += `?${search}`;
+  }
+  return url;
+};
+
+export function getValidRequestBody(options: {
+  body?: unknown;
+  bodySerializer?: BodySerializer | null;
+  serializedBody?: unknown;
+}) {
+  const hasBody = options.body !== undefined;
+  const isSerializedBody = hasBody && options.bodySerializer;
+
+  if (isSerializedBody) {
+    if ('serializedBody' in options) {
+      const hasSerializedBody =
+        options.serializedBody !== undefined && options.serializedBody !== '';
+
+      return hasSerializedBody ? options.serializedBody : null;
+    }
+
+    // not all clients implement a serializedBody property (i.e. client-axios)
+    return options.body !== '' ? options.body : null;
+  }
+
+  // plain/text body
+  if (hasBody) {
+    return options.body;
+  }
+
+  // no body was provided
+  return undefined;
+}

package/src/generated/index.ts

@@ -0,0 +1,4 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+export { getBookableServices, getBusinessName, getContactDetails, getFaq, getFeatures, getInsuranceInfo, getLocation, getOpeningHours, getPaymentMethods, getPolicyInfo, getServiceVariants, getSocialLinks, getTeamMembers, type Options, submitContactForm } from './sdk.gen';
+export type { ApiError, BilingualText, BookableService, BookableServices, BookableVariantInfo, BusinessName, ClientOptions, ContactDetails, ContactFormResult, FaqCategory, FaqContent, FaqGroup, FaqItem, FeatureItem, FeatureList, GetBookableServicesData, GetBookableServicesError, GetBookableServicesErrors, GetBookableServicesResponse, GetBookableServicesResponses, GetBusinessNameData, GetBusinessNameError, GetBusinessNameErrors, GetBusinessNameResponse, GetBusinessNameResponses, GetContactDetailsData, GetContactDetailsError, GetContactDetailsErrors, GetContactDetailsResponse, GetContactDetailsResponses, GetFaqData, GetFaqError, GetFaqErrors, GetFaqResponse, GetFaqResponses, GetFeaturesData, GetFeaturesError, GetFeaturesErrors, GetFeaturesResponse, GetFeaturesResponses, GetInsuranceInfoData, GetInsuranceInfoError, GetInsuranceInfoErrors, GetInsuranceInfoResponse, GetInsuranceInfoResponses, GetLocationData, GetLocationError, GetLocationErrors, GetLocationResponse, GetLocationResponses, GetOpeningHoursData, GetOpeningHoursError, GetOpeningHoursErrors, GetOpeningHoursResponse, GetOpeningHoursResponses, GetPaymentMethodsData, GetPaymentMethodsError, GetPaymentMethodsErrors, GetPaymentMethodsResponse, GetPaymentMethodsResponses, GetPolicyInfoData, GetPolicyInfoError, GetPolicyInfoErrors, GetPolicyInfoResponse, GetPolicyInfoResponses, GetServiceVariantsData, GetServiceVariantsError, GetServiceVariantsErrors, GetServiceVariantsResponse, GetServiceVariantsResponses, GetSocialLinksData, GetSocialLinksError, GetSocialLinksErrors, GetSocialLinksResponse, GetSocialLinksResponses, GetTeamMembersData, GetTeamMembersError, GetTeamMembersErrors, GetTeamMembersResponse, GetTeamMembersResponses, InsuranceInfo, InsuranceList, LocalizedSpecialization, Location, OpeningHours, PaymentMethod, PaymentMethodList, PolicyInfo, PolicyList, PricingVariant, PricingVariants, PublicDaySchedule, PublicTeamMember, ServiceCategoryInfo, SocialLinks, SubmitContactFormData, SubmitContactFormError, SubmitContactFormErrors, SubmitContactFormResponse, SubmitContactFormResponses, TeamMembers, TenantSlug } from './types.gen';

package/src/generated/sdk.gen.ts

@@ -0,0 +1,177 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+import type { Client, Options as Options2, TDataShape } from './client';
+import { client } from './client.gen';
+import type { GetBookableServicesData, GetBookableServicesErrors, GetBookableServicesResponses, GetBusinessNameData, GetBusinessNameErrors, GetBusinessNameResponses, GetContactDetailsData, GetContactDetailsErrors, GetContactDetailsResponses, GetFaqData, GetFaqErrors, GetFaqResponses, GetFeaturesData, GetFeaturesErrors, GetFeaturesResponses, GetInsuranceInfoData, GetInsuranceInfoErrors, GetInsuranceInfoResponses, GetLocationData, GetLocationErrors, GetLocationResponses, GetOpeningHoursData, GetOpeningHoursErrors, GetOpeningHoursResponses, GetPaymentMethodsData, GetPaymentMethodsErrors, GetPaymentMethodsResponses, GetPolicyInfoData, GetPolicyInfoErrors, GetPolicyInfoResponses, GetServiceVariantsData, GetServiceVariantsErrors, GetServiceVariantsResponses, GetSocialLinksData, GetSocialLinksErrors, GetSocialLinksResponses, GetTeamMembersData, GetTeamMembersErrors, GetTeamMembersResponses, SubmitContactFormData, SubmitContactFormErrors, SubmitContactFormResponses } from './types.gen';
+
+export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & {
+    /**
+     * You can provide a client instance returned by `createClient()` instead of
+     * individual options. This might be also useful if you want to implement a
+     * custom client.
+     */
+    client?: Client;
+    /**
+     * You can pass arbitrary values through the `meta` object. This can be
+     * used to access values that aren't defined as part of the SDK function.
+     */
+    meta?: Record<string, unknown>;
+};
+
+/**
+ * Get weekly opening hours
+ *
+ * Returns the practice opening schedule for the requested locale. Includes daily hours, closed days, and optional notes.
+ */
+export const getOpeningHours = <ThrowOnError extends boolean = false>(options: Options<GetOpeningHoursData, ThrowOnError>) => (options.client ?? client).get<GetOpeningHoursResponses, GetOpeningHoursErrors, ThrowOnError>({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/api/public/{tenantSlug}/opening-hours',
+    ...options
+});
+
+/**
+ * Get contact details
+ *
+ * Returns phone, WhatsApp, and email contact information for the practice.
+ */
+export const getContactDetails = <ThrowOnError extends boolean = false>(options: Options<GetContactDetailsData, ThrowOnError>) => (options.client ?? client).get<GetContactDetailsResponses, GetContactDetailsErrors, ThrowOnError>({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/api/public/{tenantSlug}/contact',
+    ...options
+});
+
+/**
+ * Submit a contact form
+ *
+ * Sends a contact form submission via email to the practice admin. The email is sent using the Accept-Language locale for template localization.
+ */
+export const submitContactForm = <ThrowOnError extends boolean = false>(options: Options<SubmitContactFormData, ThrowOnError>) => (options.client ?? client).post<SubmitContactFormResponses, SubmitContactFormErrors, ThrowOnError>({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/api/public/{tenantSlug}/contact',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options.headers
+    }
+});
+
+/**
+ * Get practice location
+ *
+ * Returns the practice address, GPS coordinates, Google Maps URL, parking info, and accessibility information.
+ */
+export const getLocation = <ThrowOnError extends boolean = false>(options: Options<GetLocationData, ThrowOnError>) => (options.client ?? client).get<GetLocationResponses, GetLocationErrors, ThrowOnError>({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/api/public/{tenantSlug}/location',
+    ...options
+});
+
+/**
+ * Get business name
+ *
+ * Returns the practice business name for the requested locale.
+ */
+export const getBusinessName = <ThrowOnError extends boolean = false>(options: Options<GetBusinessNameData, ThrowOnError>) => (options.client ?? client).get<GetBusinessNameResponses, GetBusinessNameErrors, ThrowOnError>({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/api/public/{tenantSlug}/business',
+    ...options
+});
+
+/**
+ * Get social media links
+ *
+ * Returns social media profile URLs (Facebook, Instagram, LinkedIn, Twitter/X).
+ */
+export const getSocialLinks = <ThrowOnError extends boolean = false>(options: Options<GetSocialLinksData, ThrowOnError>) => (options.client ?? client).get<GetSocialLinksResponses, GetSocialLinksErrors, ThrowOnError>({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/api/public/{tenantSlug}/social-links',
+    ...options
+});
+
+/**
+ * Get public team members
+ *
+ * Returns team members visible on the public team page, including name, image, specializations, bio, and BIG registration number.
+ */
+export const getTeamMembers = <ThrowOnError extends boolean = false>(options: Options<GetTeamMembersData, ThrowOnError>) => (options.client ?? client).get<GetTeamMembersResponses, GetTeamMembersErrors, ThrowOnError>({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/api/public/{tenantSlug}/team',
+    ...options
+});
+
+/**
+ * Get FAQ items grouped by category
+ *
+ * Returns all visible FAQ items, grouped by category. Questions and answers are bilingual (nl/en) — the SDK consumer localizes using their locale.
+ */
+export const getFaq = <ThrowOnError extends boolean = false>(options: Options<GetFaqData, ThrowOnError>) => (options.client ?? client).get<GetFaqResponses, GetFaqErrors, ThrowOnError>({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/api/public/{tenantSlug}/faq',
+    ...options
+});
+
+/**
+ * Get service pricing variants
+ *
+ * Returns all service variants with pricing information, suitable for displaying a pricing page. Includes category and service grouping metadata.
+ */
+export const getServiceVariants = <ThrowOnError extends boolean = false>(options: Options<GetServiceVariantsData, ThrowOnError>) => (options.client ?? client).get<GetServiceVariantsResponses, GetServiceVariantsErrors, ThrowOnError>({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/api/public/{tenantSlug}/service-variants',
+    ...options
+});
+
+/**
+ * Get insurance information
+ *
+ * Returns insurance coverage information items with bilingual titles and descriptions.
+ */
+export const getInsuranceInfo = <ThrowOnError extends boolean = false>(options: Options<GetInsuranceInfoData, ThrowOnError>) => (options.client ?? client).get<GetInsuranceInfoResponses, GetInsuranceInfoErrors, ThrowOnError>({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/api/public/{tenantSlug}/insurance',
+    ...options
+});
+
+/**
+ * Get practice features
+ *
+ * Returns practice feature/highlight items for display on the website.
+ */
+export const getFeatures = <ThrowOnError extends boolean = false>(options: Options<GetFeaturesData, ThrowOnError>) => (options.client ?? client).get<GetFeaturesResponses, GetFeaturesErrors, ThrowOnError>({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/api/public/{tenantSlug}/features',
+    ...options
+});
+
+/**
+ * Get accepted payment methods
+ *
+ * Returns the list of accepted payment methods with bilingual names.
+ */
+export const getPaymentMethods = <ThrowOnError extends boolean = false>(options: Options<GetPaymentMethodsData, ThrowOnError>) => (options.client ?? client).get<GetPaymentMethodsResponses, GetPaymentMethodsErrors, ThrowOnError>({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/api/public/{tenantSlug}/payments',
+    ...options
+});
+
+/**
+ * Get cancellation/practice policies
+ *
+ * Returns practice policy information items (cancellation, payment terms, etc.) with bilingual titles and descriptions.
+ */
+export const getPolicyInfo = <ThrowOnError extends boolean = false>(options: Options<GetPolicyInfoData, ThrowOnError>) => (options.client ?? client).get<GetPolicyInfoResponses, GetPolicyInfoErrors, ThrowOnError>({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/api/public/{tenantSlug}/policy',
+    ...options
+});
+
+/**
+ * Get bookable services with variants
+ *
+ * Returns all services available for online booking, with their variants, categories, pricing, and Cal.com event type slugs for booking integration.
+ */
+export const getBookableServices = <ThrowOnError extends boolean = false>(options: Options<GetBookableServicesData, ThrowOnError>) => (options.client ?? client).get<GetBookableServicesResponses, GetBookableServicesErrors, ThrowOnError>({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/api/public/{tenantSlug}/services',
+    ...options
+});