@studyfetch/sdk 0.1.0-alpha.1

package/src/internal/utils/values.ts

@@ -0,0 +1,105 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { StudyfetchSDKError } from '../../core/error';
+
+// https://url.spec.whatwg.org/#url-scheme-string
+const startsWithSchemeRegexp = /^[a-z][a-z0-9+.-]*:/i;
+
+export const isAbsoluteURL = (url: string): boolean => {
+  return startsWithSchemeRegexp.test(url);
+};
+
+export let isArray = (val: unknown): val is unknown[] => ((isArray = Array.isArray), isArray(val));
+export let isReadonlyArray = isArray as (val: unknown) => val is readonly unknown[];
+
+/** Returns an object if the given value isn't an object, otherwise returns as-is */
+export function maybeObj(x: unknown): object {
+  if (typeof x !== 'object') {
+    return {};
+  }
+
+  return x ?? {};
+}
+
+// https://stackoverflow.com/a/34491287
+export function isEmptyObj(obj: Object | null | undefined): boolean {
+  if (!obj) return true;
+  for (const _k in obj) return false;
+  return true;
+}
+
+// https://eslint.org/docs/latest/rules/no-prototype-builtins
+export function hasOwn<T extends object = object>(obj: T, key: PropertyKey): key is keyof T {
+  return Object.prototype.hasOwnProperty.call(obj, key);
+}
+
+export function isObj(obj: unknown): obj is Record<string, unknown> {
+  return obj != null && typeof obj === 'object' && !Array.isArray(obj);
+}
+
+export const ensurePresent = <T>(value: T | null | undefined): T => {
+  if (value == null) {
+    throw new StudyfetchSDKError(`Expected a value to be given but received ${value} instead.`);
+  }
+
+  return value;
+};
+
+export const validatePositiveInteger = (name: string, n: unknown): number => {
+  if (typeof n !== 'number' || !Number.isInteger(n)) {
+    throw new StudyfetchSDKError(`${name} must be an integer`);
+  }
+  if (n < 0) {
+    throw new StudyfetchSDKError(`${name} must be a positive integer`);
+  }
+  return n;
+};
+
+export const coerceInteger = (value: unknown): number => {
+  if (typeof value === 'number') return Math.round(value);
+  if (typeof value === 'string') return parseInt(value, 10);
+
+  throw new StudyfetchSDKError(`Could not coerce ${value} (type: ${typeof value}) into a number`);
+};
+
+export const coerceFloat = (value: unknown): number => {
+  if (typeof value === 'number') return value;
+  if (typeof value === 'string') return parseFloat(value);
+
+  throw new StudyfetchSDKError(`Could not coerce ${value} (type: ${typeof value}) into a number`);
+};
+
+export const coerceBoolean = (value: unknown): boolean => {
+  if (typeof value === 'boolean') return value;
+  if (typeof value === 'string') return value === 'true';
+  return Boolean(value);
+};
+
+export const maybeCoerceInteger = (value: unknown): number | undefined => {
+  if (value === undefined) {
+    return undefined;
+  }
+  return coerceInteger(value);
+};
+
+export const maybeCoerceFloat = (value: unknown): number | undefined => {
+  if (value === undefined) {
+    return undefined;
+  }
+  return coerceFloat(value);
+};
+
+export const maybeCoerceBoolean = (value: unknown): boolean | undefined => {
+  if (value === undefined) {
+    return undefined;
+  }
+  return coerceBoolean(value);
+};
+
+export const safeJSON = (text: string) => {
+  try {
+    return JSON.parse(text);
+  } catch (err) {
+    return undefined;
+  }
+};

package/src/internal/utils.ts

@@ -0,0 +1,8 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './utils/values';
+export * from './utils/base64';
+export * from './utils/env';
+export * from './utils/log';
+export * from './utils/uuid';
+export * from './utils/sleep';

package/src/lib/.keep

@@ -0,0 +1,4 @@
+File generated from our OpenAPI spec by Stainless.
+
+This directory can be used to store custom files to expand the SDK.
+It is ignored by Stainless code generation and its content (other than this keep file) won't be touched.

package/src/resource.ts

@@ -0,0 +1,2 @@
+/** @deprecated Import from ./core/resource instead */
+export * from './core/resource';

package/src/resources/index.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { V1 } from './v1/v1';

package/src/resources/v1/admin/admin.ts

@@ -0,0 +1,47 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as ModelsAPI from './models';
+import { Models } from './models';
+import * as OrganizationInvitesAPI from './organization-invites';
+import { OrganizationInviteCreateParams, OrganizationInvites } from './organization-invites';
+import * as OrganizationsAPI from './organizations/organizations';
+import { Organizations } from './organizations/organizations';
+import { APIPromise } from '../../../core/api-promise';
+import { buildHeaders } from '../../../internal/headers';
+import { RequestOptions } from '../../../internal/request-options';
+
+export class Admin extends APIResource {
+  organizationInvites: OrganizationInvitesAPI.OrganizationInvites =
+    new OrganizationInvitesAPI.OrganizationInvites(this._client);
+  organizations: OrganizationsAPI.Organizations = new OrganizationsAPI.Organizations(this._client);
+  models: ModelsAPI.Models = new ModelsAPI.Models(this._client);
+
+  /**
+   * @example
+   * ```ts
+   * await client.v1.admin.getUsers();
+   * ```
+   */
+  getUsers(options?: RequestOptions): APIPromise<void> {
+    return this._client.get('/api/v1/admin/users', {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+Admin.OrganizationInvites = OrganizationInvites;
+Admin.Organizations = Organizations;
+Admin.Models = Models;
+
+export declare namespace Admin {
+  export {
+    OrganizationInvites as OrganizationInvites,
+    type OrganizationInviteCreateParams as OrganizationInviteCreateParams,
+  };
+
+  export { Organizations as Organizations };
+
+  export { Models as Models };
+}

package/src/resources/v1/admin/index.ts

@@ -0,0 +1,6 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Admin } from './admin';
+export { Models } from './models';
+export { OrganizationInvites, type OrganizationInviteCreateParams } from './organization-invites';
+export { Organizations } from './organizations/index';

package/src/resources/v1/admin/models.ts

@@ -0,0 +1,21 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import { APIPromise } from '../../../core/api-promise';
+import { buildHeaders } from '../../../internal/headers';
+import { RequestOptions } from '../../../internal/request-options';
+
+export class Models extends APIResource {
+  /**
+   * @example
+   * ```ts
+   * await client.v1.admin.models.listAll();
+   * ```
+   */
+  listAll(options?: RequestOptions): APIPromise<void> {
+    return this._client.get('/api/v1/admin/models/all', {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}

package/src/resources/v1/admin/organization-invites.ts

@@ -0,0 +1,70 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import { APIPromise } from '../../../core/api-promise';
+import { buildHeaders } from '../../../internal/headers';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+export class OrganizationInvites extends APIResource {
+  /**
+   * Create organization invite
+   *
+   * @example
+   * ```ts
+   * await client.v1.admin.organizationInvites.create();
+   * ```
+   */
+  create(body: OrganizationInviteCreateParams, options?: RequestOptions): APIPromise<void> {
+    return this._client.post('/api/v1/admin/organization-invites', {
+      body,
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * @example
+   * ```ts
+   * await client.v1.admin.organizationInvites.list();
+   * ```
+   */
+  list(options?: RequestOptions): APIPromise<void> {
+    return this._client.get('/api/v1/admin/organization-invites', {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * @example
+   * ```ts
+   * await client.v1.admin.organizationInvites.delete('id');
+   * ```
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/api/v1/admin/organization-invites/${id}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * @example
+   * ```ts
+   * await client.v1.admin.organizationInvites.resend('id');
+   * ```
+   */
+  resend(id: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.post(path`/api/v1/admin/organization-invites/${id}/resend`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export interface OrganizationInviteCreateParams {}
+
+export declare namespace OrganizationInvites {
+  export { type OrganizationInviteCreateParams as OrganizationInviteCreateParams };
+}

package/src/resources/v1/admin/organizations/index.ts

@@ -0,0 +1,4 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Models } from './models/index';
+export { Organizations } from './organizations';

package/src/resources/v1/admin/organizations/models/excluded.ts

@@ -0,0 +1,39 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../../../core/resource';
+import { APIPromise } from '../../../../../core/api-promise';
+import { buildHeaders } from '../../../../../internal/headers';
+import { RequestOptions } from '../../../../../internal/request-options';
+import { path } from '../../../../../internal/utils/path';
+
+export class Excluded extends APIResource {
+  /**
+   * @example
+   * ```ts
+   * await client.v1.admin.organizations.models.excluded.create(
+   *   'organizationId',
+   * );
+   * ```
+   */
+  create(organizationID: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.post(path`/api/v1/admin/organizations/${organizationID}/models/excluded`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * @example
+   * ```ts
+   * await client.v1.admin.organizations.models.excluded.list(
+   *   'organizationId',
+   * );
+   * ```
+   */
+  list(organizationID: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.get(path`/api/v1/admin/organizations/${organizationID}/models/excluded`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}

package/src/resources/v1/admin/organizations/models/index.ts

@@ -0,0 +1,4 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Excluded } from './excluded';
+export { Models } from './models';

package/src/resources/v1/admin/organizations/models/models.ts

@@ -0,0 +1,15 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../../../core/resource';
+import * as ExcludedAPI from './excluded';
+import { Excluded } from './excluded';
+
+export class Models extends APIResource {
+  excluded: ExcludedAPI.Excluded = new ExcludedAPI.Excluded(this._client);
+}
+
+Models.Excluded = Excluded;
+
+export declare namespace Models {
+  export { Excluded as Excluded };
+}

package/src/resources/v1/admin/organizations/models.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './models/index';

package/src/resources/v1/admin/organizations/organizations.ts

@@ -0,0 +1,31 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../../core/resource';
+import * as ModelsAPI from './models/models';
+import { Models } from './models/models';
+import { APIPromise } from '../../../../core/api-promise';
+import { buildHeaders } from '../../../../internal/headers';
+import { RequestOptions } from '../../../../internal/request-options';
+
+export class Organizations extends APIResource {
+  models: ModelsAPI.Models = new ModelsAPI.Models(this._client);
+
+  /**
+   * @example
+   * ```ts
+   * await client.v1.admin.organizations.list();
+   * ```
+   */
+  list(options?: RequestOptions): APIPromise<void> {
+    return this._client.get('/api/v1/admin/organizations', {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+Organizations.Models = Models;
+
+export declare namespace Organizations {
+  export { Models as Models };
+}

package/src/resources/v1/admin/organizations.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './organizations/index';

package/src/resources/v1/admin.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './admin/index';

package/src/resources/v1/audio-recaps/audio-recaps.ts

@@ -0,0 +1,79 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as SectionsAPI from './sections';
+import { SectionRetrieveParams, Sections } from './sections';
+import { APIPromise } from '../../../core/api-promise';
+import { buildHeaders } from '../../../internal/headers';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+export class AudioRecaps extends APIResource {
+  sections: SectionsAPI.Sections = new SectionsAPI.Sections(this._client);
+
+  /**
+   * Create a new audio recap
+   *
+   * @example
+   * ```ts
+   * await client.v1.audioRecaps.create();
+   * ```
+   */
+  create(body: AudioRecapCreateParams, options?: RequestOptions): APIPromise<void> {
+    return this._client.post('/api/v1/audio-recaps/create', {
+      body,
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Get audio recap by ID
+   *
+   * @example
+   * ```ts
+   * await client.v1.audioRecaps.retrieve('recapId');
+   * ```
+   */
+  retrieve(recapID: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.get(path`/api/v1/audio-recaps/${recapID}/get`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Ask a question about the audio recap
+   *
+   * @example
+   * ```ts
+   * await client.v1.audioRecaps.askQuestion('recapId');
+   * ```
+   */
+  askQuestion(
+    recapID: string,
+    body: AudioRecapAskQuestionParams,
+    options?: RequestOptions,
+  ): APIPromise<void> {
+    return this._client.post(path`/api/v1/audio-recaps/${recapID}/ask-question`, {
+      body,
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export interface AudioRecapCreateParams {}
+
+export interface AudioRecapAskQuestionParams {}
+
+AudioRecaps.Sections = Sections;
+
+export declare namespace AudioRecaps {
+  export {
+    type AudioRecapCreateParams as AudioRecapCreateParams,
+    type AudioRecapAskQuestionParams as AudioRecapAskQuestionParams,
+  };
+
+  export { Sections as Sections, type SectionRetrieveParams as SectionRetrieveParams };
+}

package/src/resources/v1/audio-recaps/index.ts

@@ -0,0 +1,4 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { AudioRecaps, type AudioRecapCreateParams, type AudioRecapAskQuestionParams } from './audio-recaps';
+export { Sections, type SectionRetrieveParams } from './sections';

package/src/resources/v1/audio-recaps/sections.ts

@@ -0,0 +1,53 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import { APIPromise } from '../../../core/api-promise';
+import { buildHeaders } from '../../../internal/headers';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+export class Sections extends APIResource {
+  /**
+   * Get specific audio recap section
+   *
+   * @example
+   * ```ts
+   * await client.v1.audioRecaps.sections.retrieve('sectionId', {
+   *   recapId: 'recapId',
+   * });
+   * ```
+   */
+  retrieve(sectionID: string, params: SectionRetrieveParams, options?: RequestOptions): APIPromise<void> {
+    const { recapId } = params;
+    return this._client.get(path`/api/v1/audio-recaps/${recapId}/sections/${sectionID}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Get audio recap sections
+   *
+   * @example
+   * ```ts
+   * await client.v1.audioRecaps.sections.list('recapId');
+   * ```
+   */
+  list(recapID: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.get(path`/api/v1/audio-recaps/${recapID}/sections`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export interface SectionRetrieveParams {
+  /**
+   * Audio recap ID
+   */
+  recapId: string;
+}
+
+export declare namespace Sections {
+  export { type SectionRetrieveParams as SectionRetrieveParams };
+}

package/src/resources/v1/audio-recaps.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './audio-recaps/index';