import {z} from 'zod' export type GetApiV1ProviderProviderIdArgs = {provider_id: number, 'X-Access-Token'?: (string | null) | undefined}; export type GetApiV1ProviderProviderIdOptions = {baseUrl: string, OAuth2PasswordBearer?: string | undefined, fetch?: typeof fetch | undefined}; export const providerType = z.enum(["Learning_Provider", "Training_Provider", "Awarding_Body", "Employer", "Local_Authority", "University", "College", "Charity", "Department", "Project", "Other"]); export const providerStatus = z.enum(["Active", "Suspended", "Deleted"]); export const suspensionReason = z.enum(["Subscription_Expired", "Manual"]); export const address = z.object({full_address: z.string().nullable().optional(), name: z.string().nullable().optional(), number: z.string().nullable().optional(), street: z.string().nullable().optional(), postcode: z.string().nullable().optional(), locality: z.string().nullable().optional(), city: z.string().nullable().optional(), district: z.string().nullable().optional(), region: z.string().nullable().optional(), country: z.string().nullable().optional()}); export const communityType = z.enum(["City", "Region", "Local_Authority", "Membership_Organisation", "Awarding_Body", "Partnership", "Corporate", "Association", "University", "College", "Charity", "Other"]); export const communityStatus = z.enum(["Active", "Suspended", "Deleted"]); export const userVisibility = z.enum(["Public", "Private"]); export const community = z.object({name: z.string().nullable().optional(), short_name: z.string().max(12).nullable().optional(), organisation_name: z.string().nullable().optional(), company_number: z.string().nullable().optional(), verification_url: z.string().nullable().optional(), type: communityType.nullable().optional(), description: z.string().nullable().optional(), email: z.string().nullable().optional(), phone: z.string().nullable().optional(), address: z.string().nullable().optional(), latitude: z.number().nullable().optional(), longitude: z.number().nullable().optional(), city: z.string().nullable().optional(), country: z.string().nullable().optional(), is_default: z.boolean().nullable().optional(), external_url: z.string().nullable().optional(), image_url: z.string().nullable().optional(), banner_url: z.string().nullable().optional(), image_url_2x: z.string().nullable().optional(), banner_url_2x: z.string().nullable().optional(), image_url_original: z.string().nullable().optional(), banner_url_original: z.string().nullable().optional(), featured: z.boolean().nullable().optional(), colour: z.string().nullable().optional(), enable_summary_emails: z.boolean().nullable().optional(), linkedin_organisation_id: z.number().int().nullable().optional(), social_handle_linkedin: z.string().nullable().optional(), social_handle_twitter: z.string().nullable().optional(), social_handle_facebook: z.string().nullable().optional(), social_handle_instagram: z.string().nullable().optional(), consent_supply_of_service: z.string().nullable().optional(), consent_supply_of_service_by: z.number().int().nullable().optional(), pipedrive_org_id: z.number().int().nullable().optional(), pipedrive_deal_id: z.number().int().nullable().optional(), id: z.number().int().optional(), status: communityStatus.optional(), seo_keywords: z.array(z.string()).nullable().optional(), seo_title: z.string().nullable().optional(), seo_description: z.string().nullable().optional(), enable_engagement_emails: z.boolean().nullable().optional(), suspension_reason: suspensionReason.nullable().optional(), ranking: z.number().int().nullable().optional(), created_by_id: z.number().int().nullable().optional(), updated_by_id: z.number().int().nullable().optional(), verified_by_id: z.number().int().nullable().optional(), verification_request_by_id: z.number().int().nullable().optional(), time_created: z.string().optional(), time_updated: z.string().nullable().optional(), time_verified: z.string().nullable().optional(), time_stats_email_sent: z.string().nullable().optional(), postal_address: address.nullable().optional(), config: z.unknown(), survey_consent: z.string().nullable().optional(), is_demo: z.boolean().nullable().optional(), is_verified: z.boolean().nullable().optional(), verification_text: z.string().nullable().optional(), verification_email: z.string().nullable().optional(), enable_analytics: z.boolean().nullable().optional(), enable_members: z.boolean().nullable().optional(), enable_library_card: z.boolean().nullable().optional(), spydus_library_url: z.string().nullable().optional(), referral_code: z.string().nullable().optional(), member_visibility_default: userVisibility.optional(), url: z.string().nullable().optional()}); export const provider = z.object({name: z.string().nullable().optional(), short_name: z.string().max(12).nullable().optional(), organisation_name: z.string().nullable().optional(), company_number: z.string().nullable().optional(), verification_url: z.string().nullable().optional(), type: providerType.nullable().optional(), description: z.string().nullable().optional(), email: z.string().nullable().optional(), phone: z.string().nullable().optional(), address: z.string().nullable().optional(), latitude: z.number().nullable().optional(), longitude: z.number().nullable().optional(), city: z.string().nullable().optional(), country: z.string().nullable().optional(), external_url: z.string().nullable().optional(), image_url: z.string().nullable().optional(), banner_url: z.string().nullable().optional(), image_url_2x: z.string().nullable().optional(), banner_url_2x: z.string().nullable().optional(), image_url_original: z.string().nullable().optional(), banner_url_original: z.string().nullable().optional(), source_credly_id: z.number().int().nullable().optional(), featured: z.boolean().nullable().optional(), brand_colours: z.array(z.string()).nullable().optional(), badge_logo_regular_url: z.string().nullable().optional(), badge_logo_mono_url: z.string().nullable().optional(), enable_summary_emails: z.boolean().nullable().optional(), enable_surveys: z.boolean().nullable().optional(), linkedin_organisation_id: z.number().int().nullable().optional(), social_handle_linkedin: z.string().nullable().optional(), social_handle_twitter: z.string().nullable().optional(), social_handle_facebook: z.string().nullable().optional(), social_handle_instagram: z.string().nullable().optional(), consent_supply_of_service: z.string().nullable().optional(), consent_supply_of_service_by: z.number().int().nullable().optional(), pipedrive_org_id: z.number().int().nullable().optional(), pipedrive_deal_id: z.number().int().nullable().optional(), id: z.number().int().optional(), community_id: z.number().int().nullable().optional(), status: providerStatus.optional(), seo_keywords: z.array(z.string()).nullable().optional(), seo_title: z.string().nullable().optional(), seo_description: z.string().nullable().optional(), enable_engagement_emails: z.boolean().nullable().optional(), suspension_reason: suspensionReason.nullable().optional(), postal_address: address.nullable().optional(), ranking: z.number().int().nullable().optional(), created_by_id: z.number().int().nullable().optional(), updated_by_id: z.number().int().nullable().optional(), verified_by_id: z.number().int().nullable().optional(), verification_request_by_id: z.number().int().nullable().optional(), time_created: z.string().optional(), time_updated: z.string().nullable().optional(), time_verified: z.string().nullable().optional(), time_stats_email_sent: z.string().nullable().optional(), config: z.unknown(), community: community.nullable(), is_verified: z.boolean().nullable().optional(), verification_text: z.string().nullable().optional(), verification_email: z.string().nullable().optional(), is_demo: z.boolean().nullable().optional(), open_access: z.boolean().nullable().optional(), enable_analytics: z.boolean().nullable().optional(), enable_members: z.boolean().nullable().optional(), enable_badge_publish: z.boolean().nullable().optional(), enable_badge_create: z.boolean().nullable().optional(), enable_badge_submit: z.boolean().nullable().optional(), enable_job_feed: z.boolean().nullable().optional(), qa_community_id: z.number().int().nullable().optional(), member_visibility_default: userVisibility.optional(), url: z.string().nullable().optional()}); export const communityPublic = z.object({id: z.number().int().optional(), status: communityStatus.optional(), type: communityType.nullable().optional(), name: z.string().nullable().optional(), short_name: z.string().max(12).nullable().optional(), description: z.string().nullable().optional(), external_url: z.string().nullable().optional(), address: z.string().nullable().optional(), latitude: z.number().nullable().optional(), longitude: z.number().nullable().optional(), is_verified: z.boolean().nullable().optional(), verification_text: z.string().nullable().optional(), verification_url: z.string().nullable().optional(), is_demo: z.boolean().nullable().optional(), colour: z.string().nullable().optional(), spydus_library_url: z.string().nullable().optional(), referral_code: z.string().nullable().optional(), image_url: z.string().nullable().optional(), banner_url: z.string().nullable().optional(), image_url_2x: z.string().nullable().optional(), banner_url_2x: z.string().nullable().optional(), image_url_original: z.string().nullable().optional(), banner_url_original: z.string().nullable().optional(), linkedin_organisation_id: z.number().int().nullable().optional(), social_handle_linkedin: z.string().nullable().optional(), social_handle_twitter: z.string().nullable().optional(), social_handle_facebook: z.string().nullable().optional(), social_handle_instagram: z.string().nullable().optional(), seo_title: z.string().nullable().optional(), seo_description: z.string().nullable().optional(), seo_keywords: z.array(z.string()).nullable().optional(), url: z.string().nullable().optional()}); export const providerPublic = z.object({id: z.number().int().optional(), status: providerStatus.optional(), type: providerType.nullable().optional(), name: z.string().nullable().optional(), short_name: z.string().max(12).nullable().optional(), description: z.string().nullable().optional(), email: z.string().nullable().optional(), external_url: z.string().nullable().optional(), is_verified: z.boolean().nullable().optional(), verification_text: z.string().nullable().optional(), verification_url: z.string().nullable().optional(), is_demo: z.boolean().nullable().optional(), open_access: z.boolean().optional(), enable_analytics: z.boolean().nullable().optional(), community_id: z.number().int().nullable().optional(), community: communityPublic.nullable(), latitude: z.number().nullable().optional(), longitude: z.number().nullable().optional(), image_url: z.string().nullable().optional(), banner_url: z.string().nullable().optional(), image_url_2x: z.string().nullable().optional(), banner_url_2x: z.string().nullable().optional(), image_url_original: z.string().nullable().optional(), banner_url_original: z.string().nullable().optional(), brand_colours: z.array(z.string()).nullable().optional(), qa_community_id: z.number().int().nullable().optional(), linkedin_organisation_id: z.number().int().nullable().optional(), social_handle_linkedin: z.string().nullable().optional(), social_handle_twitter: z.string().nullable().optional(), social_handle_facebook: z.string().nullable().optional(), social_handle_instagram: z.string().nullable().optional(), seo_title: z.string().nullable().optional(), seo_description: z.string().nullable().optional(), seo_keywords: z.array(z.string()).nullable().optional(), url: z.string().nullable().optional()}); export const getApiV1ProviderProviderIdResponse = z.union([provider, providerPublic]); 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 }; /** * Read Provider * * GET /v1/provider/{provider_id} */ export const getApiV1ProviderProviderId = async (args: GetApiV1ProviderProviderIdArgs, options: GetApiV1ProviderProviderIdOptions) => { const {baseUrl, fetch: fetchFn = fetch, OAuth2PasswordBearer} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args['X-Access-Token'] != null) headers.set("X-Access-Token", String(args['X-Access-Token'])) if (OAuth2PasswordBearer !== undefined) headers.set('authorization', `Bearer ${OAuth2PasswordBearer}`) const url = `${baseUrl.replace(/\/+$/, '')}/v1/provider/${encodeURIComponent(String(args.provider_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(getApiV1ProviderProviderIdResponse, await res.json()) };