@unified-api/typescript-sdk 2.83.3 → 2.83.4

package/src/sdk/models/operations/listlmscollections.ts

@@ -0,0 +1,111 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../../lib/primitives.js";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const ListLmsCollectionsQueryParamFields = {
+  Id: "id",
+  CreatedAt: "created_at",
+  UpdatedAt: "updated_at",
+  Name: "name",
+  Description: "description",
+  Media: "media",
+  IsActive: "is_active",
+  ParentId: "parent_id",
+  Raw: "raw",
+} as const;
+export type ListLmsCollectionsQueryParamFields = ClosedEnum<
+  typeof ListLmsCollectionsQueryParamFields
+>;
+
+export type ListLmsCollectionsRequest = {
+  /**
+   * ID of the connection
+   */
+  connectionId: string;
+  /**
+   * The course ID to filter by (reference to Course)
+   */
+  courseId?: string | undefined;
+  /**
+   * Fields to return
+   */
+  fields?: Array<ListLmsCollectionsQueryParamFields> | undefined;
+  limit?: number | undefined;
+  offset?: number | undefined;
+  order?: string | undefined;
+  /**
+   * The parent ID to filter by
+   */
+  parentId?: string | undefined;
+  /**
+   * Query string to search. eg. email address or name
+   */
+  query?: string | undefined;
+  /**
+   * Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar
+   */
+  raw?: string | undefined;
+  sort?: string | undefined;
+  /**
+   * Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
+  updatedGte?: string | undefined;
+};
+
+/** @internal */
+export const ListLmsCollectionsQueryParamFields$outboundSchema: z.ZodNativeEnum<
+  typeof ListLmsCollectionsQueryParamFields
+> = z.nativeEnum(ListLmsCollectionsQueryParamFields);
+
+/** @internal */
+export type ListLmsCollectionsRequest$Outbound = {
+  connection_id: string;
+  course_id?: string | undefined;
+  fields?: Array<string> | undefined;
+  limit?: number | undefined;
+  offset?: number | undefined;
+  order?: string | undefined;
+  parent_id?: string | undefined;
+  query?: string | undefined;
+  raw?: string | undefined;
+  sort?: string | undefined;
+  updated_gte?: string | undefined;
+};
+
+/** @internal */
+export const ListLmsCollectionsRequest$outboundSchema: z.ZodType<
+  ListLmsCollectionsRequest$Outbound,
+  z.ZodTypeDef,
+  ListLmsCollectionsRequest
+> = z.object({
+  connectionId: z.string(),
+  courseId: z.string().optional(),
+  fields: z.array(ListLmsCollectionsQueryParamFields$outboundSchema).optional(),
+  limit: z.number().optional(),
+  offset: z.number().optional(),
+  order: z.string().optional(),
+  parentId: z.string().optional(),
+  query: z.string().optional(),
+  raw: z.string().optional(),
+  sort: z.string().optional(),
+  updatedGte: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    connectionId: "connection_id",
+    courseId: "course_id",
+    parentId: "parent_id",
+    updatedGte: "updated_gte",
+  });
+});
+
+export function listLmsCollectionsRequestToJSON(
+  listLmsCollectionsRequest: ListLmsCollectionsRequest,
+): string {
+  return JSON.stringify(
+    ListLmsCollectionsRequest$outboundSchema.parse(listLmsCollectionsRequest),
+  );
+}

package/src/sdk/models/operations/listlmscontents.ts

@@ -0,0 +1,122 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../../lib/primitives.js";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const ListLmsContentsQueryParamFields = {
+  Id: "id",
+  CreatedAt: "created_at",
+  UpdatedAt: "updated_at",
+  ExternalReference: "external_reference",
+  CourseIds: "course_ids",
+  Name: "name",
+  Description: "description",
+  Languages: "languages",
+  Media: "media",
+  IsActive: "is_active",
+  DurationMinutes: "duration_minutes",
+  Categories: "categories",
+  Skills: "skills",
+  SortOrder: "sort_order",
+  ProviderName: "provider_name",
+  ShortDescription: "short_description",
+  Localizations: "localizations",
+  InstructorIds: "instructor_ids",
+  CollectionIds: "collection_ids",
+  Raw: "raw",
+} as const;
+export type ListLmsContentsQueryParamFields = ClosedEnum<
+  typeof ListLmsContentsQueryParamFields
+>;
+
+export type ListLmsContentsRequest = {
+  /**
+   * The collection ID to filter by (reference to CommerceCollection)
+   */
+  collectionId?: string | undefined;
+  /**
+   * ID of the connection
+   */
+  connectionId: string;
+  /**
+   * The course ID to filter by (reference to Course)
+   */
+  courseId?: string | undefined;
+  /**
+   * Fields to return
+   */
+  fields?: Array<ListLmsContentsQueryParamFields> | undefined;
+  limit?: number | undefined;
+  offset?: number | undefined;
+  order?: string | undefined;
+  /**
+   * Query string to search. eg. email address or name
+   */
+  query?: string | undefined;
+  /**
+   * Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar
+   */
+  raw?: string | undefined;
+  sort?: string | undefined;
+  /**
+   * Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
+  updatedGte?: string | undefined;
+};
+
+/** @internal */
+export const ListLmsContentsQueryParamFields$outboundSchema: z.ZodNativeEnum<
+  typeof ListLmsContentsQueryParamFields
+> = z.nativeEnum(ListLmsContentsQueryParamFields);
+
+/** @internal */
+export type ListLmsContentsRequest$Outbound = {
+  collection_id?: string | undefined;
+  connection_id: string;
+  course_id?: string | undefined;
+  fields?: Array<string> | undefined;
+  limit?: number | undefined;
+  offset?: number | undefined;
+  order?: string | undefined;
+  query?: string | undefined;
+  raw?: string | undefined;
+  sort?: string | undefined;
+  updated_gte?: string | undefined;
+};
+
+/** @internal */
+export const ListLmsContentsRequest$outboundSchema: z.ZodType<
+  ListLmsContentsRequest$Outbound,
+  z.ZodTypeDef,
+  ListLmsContentsRequest
+> = z.object({
+  collectionId: z.string().optional(),
+  connectionId: z.string(),
+  courseId: z.string().optional(),
+  fields: z.array(ListLmsContentsQueryParamFields$outboundSchema).optional(),
+  limit: z.number().optional(),
+  offset: z.number().optional(),
+  order: z.string().optional(),
+  query: z.string().optional(),
+  raw: z.string().optional(),
+  sort: z.string().optional(),
+  updatedGte: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    collectionId: "collection_id",
+    connectionId: "connection_id",
+    courseId: "course_id",
+    updatedGte: "updated_gte",
+  });
+});
+
+export function listLmsContentsRequestToJSON(
+  listLmsContentsRequest: ListLmsContentsRequest,
+): string {
+  return JSON.stringify(
+    ListLmsContentsRequest$outboundSchema.parse(listLmsContentsRequest),
+  );
+}

package/src/sdk/models/operations/patchlmsactivity.ts

@@ -0,0 +1,86 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../../lib/primitives.js";
+import { ClosedEnum } from "../../types/enums.js";
+import * as shared from "../shared/index.js";
+
+export const PatchLmsActivityQueryParamFields = {
+  Id: "id",
+  CreatedAt: "created_at",
+  UpdatedAt: "updated_at",
+  ContentId: "content_id",
+  CourseId: "course_id",
+  StudentId: "student_id",
+  DurationMinutes: "duration_minutes",
+  IsCompleted: "is_completed",
+  ProgressPercentage: "progress_percentage",
+  StartedAt: "started_at",
+  CompletedAt: "completed_at",
+  Raw: "raw",
+} as const;
+export type PatchLmsActivityQueryParamFields = ClosedEnum<
+  typeof PatchLmsActivityQueryParamFields
+>;
+
+export type PatchLmsActivityRequest = {
+  lmsActivity: shared.LmsActivity;
+  /**
+   * ID of the connection
+   */
+  connectionId: string;
+  /**
+   * Fields to return
+   */
+  fields?: Array<PatchLmsActivityQueryParamFields> | undefined;
+  /**
+   * ID of the Activity
+   */
+  id: string;
+  /**
+   * Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar
+   */
+  raw?: string | undefined;
+};
+
+/** @internal */
+export const PatchLmsActivityQueryParamFields$outboundSchema: z.ZodNativeEnum<
+  typeof PatchLmsActivityQueryParamFields
+> = z.nativeEnum(PatchLmsActivityQueryParamFields);
+
+/** @internal */
+export type PatchLmsActivityRequest$Outbound = {
+  LmsActivity: shared.LmsActivity$Outbound;
+  connection_id: string;
+  fields?: Array<string> | undefined;
+  id: string;
+  raw?: string | undefined;
+};
+
+/** @internal */
+export const PatchLmsActivityRequest$outboundSchema: z.ZodType<
+  PatchLmsActivityRequest$Outbound,
+  z.ZodTypeDef,
+  PatchLmsActivityRequest
+> = z.object({
+  lmsActivity: shared.LmsActivity$outboundSchema,
+  connectionId: z.string(),
+  fields: z.array(PatchLmsActivityQueryParamFields$outboundSchema).optional(),
+  id: z.string(),
+  raw: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    lmsActivity: "LmsActivity",
+    connectionId: "connection_id",
+  });
+});
+
+export function patchLmsActivityRequestToJSON(
+  patchLmsActivityRequest: PatchLmsActivityRequest,
+): string {
+  return JSON.stringify(
+    PatchLmsActivityRequest$outboundSchema.parse(patchLmsActivityRequest),
+  );
+}

package/src/sdk/models/operations/patchlmscollection.ts

@@ -0,0 +1,83 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../../lib/primitives.js";
+import { ClosedEnum } from "../../types/enums.js";
+import * as shared from "../shared/index.js";
+
+export const PatchLmsCollectionQueryParamFields = {
+  Id: "id",
+  CreatedAt: "created_at",
+  UpdatedAt: "updated_at",
+  Name: "name",
+  Description: "description",
+  Media: "media",
+  IsActive: "is_active",
+  ParentId: "parent_id",
+  Raw: "raw",
+} as const;
+export type PatchLmsCollectionQueryParamFields = ClosedEnum<
+  typeof PatchLmsCollectionQueryParamFields
+>;
+
+export type PatchLmsCollectionRequest = {
+  lmsCollection: shared.LmsCollection;
+  /**
+   * ID of the connection
+   */
+  connectionId: string;
+  /**
+   * Fields to return
+   */
+  fields?: Array<PatchLmsCollectionQueryParamFields> | undefined;
+  /**
+   * ID of the Collection
+   */
+  id: string;
+  /**
+   * Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar
+   */
+  raw?: string | undefined;
+};
+
+/** @internal */
+export const PatchLmsCollectionQueryParamFields$outboundSchema: z.ZodNativeEnum<
+  typeof PatchLmsCollectionQueryParamFields
+> = z.nativeEnum(PatchLmsCollectionQueryParamFields);
+
+/** @internal */
+export type PatchLmsCollectionRequest$Outbound = {
+  LmsCollection: shared.LmsCollection$Outbound;
+  connection_id: string;
+  fields?: Array<string> | undefined;
+  id: string;
+  raw?: string | undefined;
+};
+
+/** @internal */
+export const PatchLmsCollectionRequest$outboundSchema: z.ZodType<
+  PatchLmsCollectionRequest$Outbound,
+  z.ZodTypeDef,
+  PatchLmsCollectionRequest
+> = z.object({
+  lmsCollection: shared.LmsCollection$outboundSchema,
+  connectionId: z.string(),
+  fields: z.array(PatchLmsCollectionQueryParamFields$outboundSchema).optional(),
+  id: z.string(),
+  raw: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    lmsCollection: "LmsCollection",
+    connectionId: "connection_id",
+  });
+});
+
+export function patchLmsCollectionRequestToJSON(
+  patchLmsCollectionRequest: PatchLmsCollectionRequest,
+): string {
+  return JSON.stringify(
+    PatchLmsCollectionRequest$outboundSchema.parse(patchLmsCollectionRequest),
+  );
+}

package/src/sdk/models/operations/patchlmscontent.ts

@@ -0,0 +1,94 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../../lib/primitives.js";
+import { ClosedEnum } from "../../types/enums.js";
+import * as shared from "../shared/index.js";
+
+export const PatchLmsContentQueryParamFields = {
+  Id: "id",
+  CreatedAt: "created_at",
+  UpdatedAt: "updated_at",
+  ExternalReference: "external_reference",
+  CourseIds: "course_ids",
+  Name: "name",
+  Description: "description",
+  Languages: "languages",
+  Media: "media",
+  IsActive: "is_active",
+  DurationMinutes: "duration_minutes",
+  Categories: "categories",
+  Skills: "skills",
+  SortOrder: "sort_order",
+  ProviderName: "provider_name",
+  ShortDescription: "short_description",
+  Localizations: "localizations",
+  InstructorIds: "instructor_ids",
+  CollectionIds: "collection_ids",
+  Raw: "raw",
+} as const;
+export type PatchLmsContentQueryParamFields = ClosedEnum<
+  typeof PatchLmsContentQueryParamFields
+>;
+
+export type PatchLmsContentRequest = {
+  lmsContent: shared.LmsContent;
+  /**
+   * ID of the connection
+   */
+  connectionId: string;
+  /**
+   * Fields to return
+   */
+  fields?: Array<PatchLmsContentQueryParamFields> | undefined;
+  /**
+   * ID of the Content
+   */
+  id: string;
+  /**
+   * Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar
+   */
+  raw?: string | undefined;
+};
+
+/** @internal */
+export const PatchLmsContentQueryParamFields$outboundSchema: z.ZodNativeEnum<
+  typeof PatchLmsContentQueryParamFields
+> = z.nativeEnum(PatchLmsContentQueryParamFields);
+
+/** @internal */
+export type PatchLmsContentRequest$Outbound = {
+  LmsContent: shared.LmsContent$Outbound;
+  connection_id: string;
+  fields?: Array<string> | undefined;
+  id: string;
+  raw?: string | undefined;
+};
+
+/** @internal */
+export const PatchLmsContentRequest$outboundSchema: z.ZodType<
+  PatchLmsContentRequest$Outbound,
+  z.ZodTypeDef,
+  PatchLmsContentRequest
+> = z.object({
+  lmsContent: shared.LmsContent$outboundSchema,
+  connectionId: z.string(),
+  fields: z.array(PatchLmsContentQueryParamFields$outboundSchema).optional(),
+  id: z.string(),
+  raw: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    lmsContent: "LmsContent",
+    connectionId: "connection_id",
+  });
+});
+
+export function patchLmsContentRequestToJSON(
+  patchLmsContentRequest: PatchLmsContentRequest,
+): string {
+  return JSON.stringify(
+    PatchLmsContentRequest$outboundSchema.parse(patchLmsContentRequest),
+  );
+}

package/src/sdk/models/operations/removelmsactivity.ts

@@ -0,0 +1,75 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../../lib/primitives.js";
+import { safeParse } from "../../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type RemoveLmsActivityRequest = {
+  /**
+   * ID of the connection
+   */
+  connectionId: string;
+  /**
+   * ID of the Activity
+   */
+  id: string;
+};
+
+export type RemoveLmsActivityResponse = {
+  headers: { [k: string]: Array<string> };
+};
+
+/** @internal */
+export type RemoveLmsActivityRequest$Outbound = {
+  connection_id: string;
+  id: string;
+};
+
+/** @internal */
+export const RemoveLmsActivityRequest$outboundSchema: z.ZodType<
+  RemoveLmsActivityRequest$Outbound,
+  z.ZodTypeDef,
+  RemoveLmsActivityRequest
+> = z.object({
+  connectionId: z.string(),
+  id: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    connectionId: "connection_id",
+  });
+});
+
+export function removeLmsActivityRequestToJSON(
+  removeLmsActivityRequest: RemoveLmsActivityRequest,
+): string {
+  return JSON.stringify(
+    RemoveLmsActivityRequest$outboundSchema.parse(removeLmsActivityRequest),
+  );
+}
+
+/** @internal */
+export const RemoveLmsActivityResponse$inboundSchema: z.ZodType<
+  RemoveLmsActivityResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Headers: z.record(z.array(z.string())).default({}),
+}).transform((v) => {
+  return remap$(v, {
+    "Headers": "headers",
+  });
+});
+
+export function removeLmsActivityResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<RemoveLmsActivityResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RemoveLmsActivityResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RemoveLmsActivityResponse' from JSON`,
+  );
+}

package/src/sdk/models/operations/removelmscollection.ts

@@ -0,0 +1,75 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../../lib/primitives.js";
+import { safeParse } from "../../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type RemoveLmsCollectionRequest = {
+  /**
+   * ID of the connection
+   */
+  connectionId: string;
+  /**
+   * ID of the Collection
+   */
+  id: string;
+};
+
+export type RemoveLmsCollectionResponse = {
+  headers: { [k: string]: Array<string> };
+};
+
+/** @internal */
+export type RemoveLmsCollectionRequest$Outbound = {
+  connection_id: string;
+  id: string;
+};
+
+/** @internal */
+export const RemoveLmsCollectionRequest$outboundSchema: z.ZodType<
+  RemoveLmsCollectionRequest$Outbound,
+  z.ZodTypeDef,
+  RemoveLmsCollectionRequest
+> = z.object({
+  connectionId: z.string(),
+  id: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    connectionId: "connection_id",
+  });
+});
+
+export function removeLmsCollectionRequestToJSON(
+  removeLmsCollectionRequest: RemoveLmsCollectionRequest,
+): string {
+  return JSON.stringify(
+    RemoveLmsCollectionRequest$outboundSchema.parse(removeLmsCollectionRequest),
+  );
+}
+
+/** @internal */
+export const RemoveLmsCollectionResponse$inboundSchema: z.ZodType<
+  RemoveLmsCollectionResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Headers: z.record(z.array(z.string())).default({}),
+}).transform((v) => {
+  return remap$(v, {
+    "Headers": "headers",
+  });
+});
+
+export function removeLmsCollectionResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<RemoveLmsCollectionResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RemoveLmsCollectionResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RemoveLmsCollectionResponse' from JSON`,
+  );
+}