@globalscoutme/api-client 1.0.1

package/core/utils.gen.ts

@@ -0,0 +1,143 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+import type { BodySerializer, QuerySerializer } from './bodySerializer.gen.js';
+import {
+  type ArraySeparatorStyle,
+  serializeArrayParam,
+  serializeObjectParam,
+  serializePrimitiveParam,
+} from './pathSerializer.gen.js';
+
+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/index.ts

@@ -0,0 +1,115 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+export {
+  Achievements,
+  Auth,
+  Body,
+  Documents,
+  GlobalScoutMeClient,
+  Index,
+  type Options,
+  Organizations,
+  Players,
+  Profile,
+  Videos,
+} from './sdk.gen.js';
+export type {
+  AchievementCatalogDto,
+  BodyMeasurementResponseDto,
+  CareerAchievementDto,
+  ClientOptions,
+  CreateBodyMeasurementDto,
+  CreateDocumentDto,
+  CreateVideoDto,
+  DashboardResponseDto,
+  DeletePlayersMeData,
+  DeletePlayersMeErrors,
+  DeletePlayersMeResponse,
+  DeletePlayersMeResponses,
+  DeleteVideosByIdData,
+  DeleteVideosByIdErrors,
+  DeleteVideosByIdResponse,
+  DeleteVideosByIdResponses,
+  DocumentResponseDto,
+  GetAchievementsData,
+  GetAchievementsMeData,
+  GetAchievementsMeErrors,
+  GetAchievementsMeResponse,
+  GetAchievementsMeResponses,
+  GetAchievementsResponse,
+  GetAchievementsResponses,
+  GetAuthMeData,
+  GetAuthMeResponses,
+  GetBodyMeasurementsMeData,
+  GetBodyMeasurementsMeErrors,
+  GetBodyMeasurementsMeResponse,
+  GetBodyMeasurementsMeResponses,
+  GetDocumentsMeData,
+  GetDocumentsMeErrors,
+  GetDocumentsMeResponse,
+  GetDocumentsMeResponses,
+  GetIndexByTableNameData,
+  GetIndexByTableNameErrors,
+  GetIndexByTableNameResponse,
+  GetIndexByTableNameResponses,
+  GetOrganizationsMeData,
+  GetOrganizationsMeErrors,
+  GetOrganizationsMeResponse,
+  GetOrganizationsMeResponses,
+  GetPlayersMeDashboardData,
+  GetPlayersMeDashboardErrors,
+  GetPlayersMeDashboardResponse,
+  GetPlayersMeDashboardResponses,
+  GetPlayersMeData,
+  GetPlayersMeErrors,
+  GetPlayersMeResponse,
+  GetPlayersMeResponses,
+  GetProfileMeData,
+  GetProfileMeErrors,
+  GetProfileMeResponse,
+  GetProfileMeResponses,
+  GetVideosMeData,
+  GetVideosMeErrors,
+  GetVideosMeResponse,
+  GetVideosMeResponses,
+  IndexItemDto,
+  OrganizationResponseDto,
+  PatchPlayersMeData,
+  PatchPlayersMeErrors,
+  PatchPlayersMeResponse,
+  PatchPlayersMeResponses,
+  PlayerResponseDto,
+  PostBodyMeasurementsData,
+  PostBodyMeasurementsErrors,
+  PostBodyMeasurementsResponse,
+  PostBodyMeasurementsResponses,
+  PostDocumentsData,
+  PostDocumentsErrors,
+  PostDocumentsResponse,
+  PostDocumentsResponses,
+  PostOrganizationsRegisterClubData,
+  PostOrganizationsRegisterClubErrors,
+  PostOrganizationsRegisterClubResponse,
+  PostOrganizationsRegisterClubResponses,
+  PostVideosData,
+  PostVideosErrors,
+  PostVideosResponse,
+  PostVideosResponses,
+  PreviousClubDto,
+  ProfileResponseDto,
+  PutOrganizationsMeData,
+  PutOrganizationsMeErrors,
+  PutOrganizationsMeResponse,
+  PutOrganizationsMeResponses,
+  PutProfileMeData,
+  PutProfileMeErrors,
+  PutProfileMeResponse,
+  PutProfileMeResponses,
+  RegisterClubDto,
+  RegisterClubResponseDto,
+  UpdateOrganizationDto,
+  UpdatePlayerDto,
+  UpdateProfileDto,
+  UserAchievementResponseDto,
+  VideoResponseDto,
+} from './types.gen.js';

package/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "@globalscoutme/api-client",
+  "version": "1.0.1",
+  "description": "GlobalScoutMe Player API client (generated)",
+  "author": "GlobalScoutMe",
+  "license": "UNLICENSED",
+  "type": "module",
+  "main": "./index.ts",
+  "types": "./index.ts",
+  "keywords": ["api-client","typescript"],
+  "dependencies": {
+    "@hey-api/client-axios": "^0.2.5",
+    "axios": "^1.6.1"
+  },
+  "peerDependencies": {
+    "typescript": "^5.0.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
+}

package/sdk.gen.ts

@@ -0,0 +1,434 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+import { client } from './client.gen.js';
+import type {
+  Client,
+  Options as Options2,
+  TDataShape,
+} from './client/index.js';
+import type {
+  DeletePlayersMeData,
+  DeletePlayersMeErrors,
+  DeletePlayersMeResponses,
+  DeleteVideosByIdData,
+  DeleteVideosByIdErrors,
+  DeleteVideosByIdResponses,
+  GetAchievementsData,
+  GetAchievementsMeData,
+  GetAchievementsMeErrors,
+  GetAchievementsMeResponses,
+  GetAchievementsResponses,
+  GetAuthMeData,
+  GetAuthMeResponses,
+  GetBodyMeasurementsMeData,
+  GetBodyMeasurementsMeErrors,
+  GetBodyMeasurementsMeResponses,
+  GetDocumentsMeData,
+  GetDocumentsMeErrors,
+  GetDocumentsMeResponses,
+  GetIndexByTableNameData,
+  GetIndexByTableNameErrors,
+  GetIndexByTableNameResponses,
+  GetOrganizationsMeData,
+  GetOrganizationsMeErrors,
+  GetOrganizationsMeResponses,
+  GetPlayersMeDashboardData,
+  GetPlayersMeDashboardErrors,
+  GetPlayersMeDashboardResponses,
+  GetPlayersMeData,
+  GetPlayersMeErrors,
+  GetPlayersMeResponses,
+  GetProfileMeData,
+  GetProfileMeErrors,
+  GetProfileMeResponses,
+  GetVideosMeData,
+  GetVideosMeErrors,
+  GetVideosMeResponses,
+  PatchPlayersMeData,
+  PatchPlayersMeErrors,
+  PatchPlayersMeResponses,
+  PostBodyMeasurementsData,
+  PostBodyMeasurementsErrors,
+  PostBodyMeasurementsResponses,
+  PostDocumentsData,
+  PostDocumentsErrors,
+  PostDocumentsResponses,
+  PostOrganizationsRegisterClubData,
+  PostOrganizationsRegisterClubErrors,
+  PostOrganizationsRegisterClubResponses,
+  PostVideosData,
+  PostVideosErrors,
+  PostVideosResponses,
+  PutOrganizationsMeData,
+  PutOrganizationsMeErrors,
+  PutOrganizationsMeResponses,
+  PutProfileMeData,
+  PutProfileMeErrors,
+  PutProfileMeResponses,
+} from './types.gen.js';
+
+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>;
+};
+
+class HeyApiClient {
+  protected client: Client;
+
+  constructor(args?: { client?: Client }) {
+    this.client = args?.client ?? client;
+  }
+}
+
+class HeyApiRegistry<T> {
+  private readonly defaultKey = 'default';
+
+  private readonly instances: Map<string, T> = new Map();
+
+  get(key?: string): T {
+    const instance = this.instances.get(key ?? this.defaultKey);
+    if (!instance) {
+      throw new Error(
+        `No SDK client found. Create one with "new GlobalScoutMeClient()" to fix this error.`,
+      );
+    }
+    return instance;
+  }
+
+  set(value: T, key?: string): void {
+    this.instances.set(key ?? this.defaultKey, value);
+  }
+}
+
+export class Auth extends HeyApiClient {
+  public authControllerMe<ThrowOnError extends boolean = false>(
+    options?: Options<GetAuthMeData, ThrowOnError>,
+  ) {
+    return (options?.client ?? this.client).get<
+      GetAuthMeResponses,
+      unknown,
+      ThrowOnError
+    >({ url: '/auth/me', ...options });
+  }
+}
+
+export class Players extends HeyApiClient {
+  public deleteMe<ThrowOnError extends boolean = false>(
+    options?: Options<DeletePlayersMeData, ThrowOnError>,
+  ) {
+    return (options?.client ?? this.client).delete<
+      DeletePlayersMeResponses,
+      DeletePlayersMeErrors,
+      ThrowOnError
+    >({ url: '/players/me', ...options });
+  }
+
+  public getMe<ThrowOnError extends boolean = false>(
+    options?: Options<GetPlayersMeData, ThrowOnError>,
+  ) {
+    return (options?.client ?? this.client).get<
+      GetPlayersMeResponses,
+      GetPlayersMeErrors,
+      ThrowOnError
+    >({ url: '/players/me', ...options });
+  }
+
+  public patchMe<ThrowOnError extends boolean = false>(
+    options: Options<PatchPlayersMeData, ThrowOnError>,
+  ) {
+    return (options.client ?? this.client).patch<
+      PatchPlayersMeResponses,
+      PatchPlayersMeErrors,
+      ThrowOnError
+    >({
+      url: '/players/me',
+      ...options,
+      headers: {
+        'Content-Type': 'application/json',
+        ...options.headers,
+      },
+    });
+  }
+
+  public getMyDashboard<ThrowOnError extends boolean = false>(
+    options?: Options<GetPlayersMeDashboardData, ThrowOnError>,
+  ) {
+    return (options?.client ?? this.client).get<
+      GetPlayersMeDashboardResponses,
+      GetPlayersMeDashboardErrors,
+      ThrowOnError
+    >({ url: '/players/me/dashboard', ...options });
+  }
+}
+
+export class Profile extends HeyApiClient {
+  public getProfileMe<ThrowOnError extends boolean = false>(
+    options?: Options<GetProfileMeData, ThrowOnError>,
+  ) {
+    return (options?.client ?? this.client).get<
+      GetProfileMeResponses,
+      GetProfileMeErrors,
+      ThrowOnError
+    >({ url: '/profile/me', ...options });
+  }
+
+  public updateProfileMe<ThrowOnError extends boolean = false>(
+    options: Options<PutProfileMeData, ThrowOnError>,
+  ) {
+    return (options.client ?? this.client).put<
+      PutProfileMeResponses,
+      PutProfileMeErrors,
+      ThrowOnError
+    >({
+      url: '/profile/me',
+      ...options,
+      headers: {
+        'Content-Type': 'application/json',
+        ...options.headers,
+      },
+    });
+  }
+}
+
+export class Achievements extends HeyApiClient {
+  public getAchievementsCatalog<ThrowOnError extends boolean = false>(
+    options?: Options<GetAchievementsData, ThrowOnError>,
+  ) {
+    return (options?.client ?? this.client).get<
+      GetAchievementsResponses,
+      unknown,
+      ThrowOnError
+    >({ url: '/achievements', ...options });
+  }
+
+  public getMyAchievements<ThrowOnError extends boolean = false>(
+    options?: Options<GetAchievementsMeData, ThrowOnError>,
+  ) {
+    return (options?.client ?? this.client).get<
+      GetAchievementsMeResponses,
+      GetAchievementsMeErrors,
+      ThrowOnError
+    >({ url: '/achievements/me', ...options });
+  }
+}
+
+export class Body extends HeyApiClient {
+  public getMyMeasurements<ThrowOnError extends boolean = false>(
+    options?: Options<GetBodyMeasurementsMeData, ThrowOnError>,
+  ) {
+    return (options?.client ?? this.client).get<
+      GetBodyMeasurementsMeResponses,
+      GetBodyMeasurementsMeErrors,
+      ThrowOnError
+    >({ url: '/body/measurements/me', ...options });
+  }
+
+  public createMeasurement<ThrowOnError extends boolean = false>(
+    options: Options<PostBodyMeasurementsData, ThrowOnError>,
+  ) {
+    return (options.client ?? this.client).post<
+      PostBodyMeasurementsResponses,
+      PostBodyMeasurementsErrors,
+      ThrowOnError
+    >({
+      url: '/body/measurements',
+      ...options,
+      headers: {
+        'Content-Type': 'application/json',
+        ...options.headers,
+      },
+    });
+  }
+}
+
+export class Documents extends HeyApiClient {
+  public getMyDocuments<ThrowOnError extends boolean = false>(
+    options?: Options<GetDocumentsMeData, ThrowOnError>,
+  ) {
+    return (options?.client ?? this.client).get<
+      GetDocumentsMeResponses,
+      GetDocumentsMeErrors,
+      ThrowOnError
+    >({ url: '/documents/me', ...options });
+  }
+
+  public createDocument<ThrowOnError extends boolean = false>(
+    options: Options<PostDocumentsData, ThrowOnError>,
+  ) {
+    return (options.client ?? this.client).post<
+      PostDocumentsResponses,
+      PostDocumentsErrors,
+      ThrowOnError
+    >({
+      url: '/documents',
+      ...options,
+      headers: {
+        'Content-Type': 'application/json',
+        ...options.headers,
+      },
+    });
+  }
+}
+
+export class Index extends HeyApiClient {
+  public getIndexItems<ThrowOnError extends boolean = false>(
+    options: Options<GetIndexByTableNameData, ThrowOnError>,
+  ) {
+    return (options.client ?? this.client).get<
+      GetIndexByTableNameResponses,
+      GetIndexByTableNameErrors,
+      ThrowOnError
+    >({ url: '/index/{tableName}', ...options });
+  }
+}
+
+export class Organizations extends HeyApiClient {
+  public registerClub<ThrowOnError extends boolean = false>(
+    options: Options<PostOrganizationsRegisterClubData, ThrowOnError>,
+  ) {
+    return (options.client ?? this.client).post<
+      PostOrganizationsRegisterClubResponses,
+      PostOrganizationsRegisterClubErrors,
+      ThrowOnError
+    >({
+      url: '/organizations/register-club',
+      ...options,
+      headers: {
+        'Content-Type': 'application/json',
+        ...options.headers,
+      },
+    });
+  }
+
+  public getMyOrganization<ThrowOnError extends boolean = false>(
+    options?: Options<GetOrganizationsMeData, ThrowOnError>,
+  ) {
+    return (options?.client ?? this.client).get<
+      GetOrganizationsMeResponses,
+      GetOrganizationsMeErrors,
+      ThrowOnError
+    >({ url: '/organizations/me', ...options });
+  }
+
+  public updateMyOrganization<ThrowOnError extends boolean = false>(
+    options: Options<PutOrganizationsMeData, ThrowOnError>,
+  ) {
+    return (options.client ?? this.client).put<
+      PutOrganizationsMeResponses,
+      PutOrganizationsMeErrors,
+      ThrowOnError
+    >({
+      url: '/organizations/me',
+      ...options,
+      headers: {
+        'Content-Type': 'application/json',
+        ...options.headers,
+      },
+    });
+  }
+}
+
+export class Videos extends HeyApiClient {
+  public getMyVideos<ThrowOnError extends boolean = false>(
+    options: Options<GetVideosMeData, ThrowOnError>,
+  ) {
+    return (options.client ?? this.client).get<
+      GetVideosMeResponses,
+      GetVideosMeErrors,
+      ThrowOnError
+    >({ url: '/videos/me', ...options });
+  }
+
+  public createVideo<ThrowOnError extends boolean = false>(
+    options: Options<PostVideosData, ThrowOnError>,
+  ) {
+    return (options.client ?? this.client).post<
+      PostVideosResponses,
+      PostVideosErrors,
+      ThrowOnError
+    >({
+      url: '/videos',
+      ...options,
+      headers: {
+        'Content-Type': 'application/json',
+        ...options.headers,
+      },
+    });
+  }
+
+  public deleteVideo<ThrowOnError extends boolean = false>(
+    options: Options<DeleteVideosByIdData, ThrowOnError>,
+  ) {
+    return (options.client ?? this.client).delete<
+      DeleteVideosByIdResponses,
+      DeleteVideosByIdErrors,
+      ThrowOnError
+    >({ url: '/videos/{id}', ...options });
+  }
+}
+
+export class GlobalScoutMeClient extends HeyApiClient {
+  public static readonly __registry = new HeyApiRegistry<GlobalScoutMeClient>();
+
+  constructor(args?: { client?: Client; key?: string }) {
+    super(args);
+    GlobalScoutMeClient.__registry.set(this, args?.key);
+  }
+
+  private _auth?: Auth;
+  get auth(): Auth {
+    return (this._auth ??= new Auth({ client: this.client }));
+  }
+
+  private _players?: Players;
+  get players(): Players {
+    return (this._players ??= new Players({ client: this.client }));
+  }
+
+  private _profile?: Profile;
+  get profile(): Profile {
+    return (this._profile ??= new Profile({ client: this.client }));
+  }
+
+  private _achievements?: Achievements;
+  get achievements(): Achievements {
+    return (this._achievements ??= new Achievements({ client: this.client }));
+  }
+
+  private _body?: Body;
+  get body(): Body {
+    return (this._body ??= new Body({ client: this.client }));
+  }
+
+  private _documents?: Documents;
+  get documents(): Documents {
+    return (this._documents ??= new Documents({ client: this.client }));
+  }
+
+  private _index?: Index;
+  get index(): Index {
+    return (this._index ??= new Index({ client: this.client }));
+  }
+
+  private _organizations?: Organizations;
+  get organizations(): Organizations {
+    return (this._organizations ??= new Organizations({ client: this.client }));
+  }
+
+  private _videos?: Videos;
+  get videos(): Videos {
+    return (this._videos ??= new Videos({ client: this.client }));
+  }
+}