@solarwinds/squadcast-sdk-typescript 1.2.0 → 1.3.0

package/src/models/errors/index.ts

@@ -2,7 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-export * from "./analyticsgetorganalytics.js";
+export * from "./authgetaccesstoken.js";
 export * from "./commonv4error.js";
 export * from "./httpclienterrors.js";
 export * from "./responsevalidationerror.js";

package/src/models/index.ts

@@ -22,6 +22,7 @@ export * from "./v3auditlogsgetauditlogexporthistorybyidresponse.js";
 export * from "./v3auditlogslistauditlogsexporthistoryresponse.js";
 export * from "./v3auditlogslistauditlogsresponse.js";
 export * from "./v3auditlogsteam.js";
+export * from "./v3authaccesstokendata.js";
 export * from "./v3escalationpoliciescreateescalationpolicyrequest.js";
 export * from "./v3escalationpoliciesescalationentity.js";
 export * from "./v3escalationpoliciesescalationpolicyresponse.js";

package/src/models/operations/authgetaccesstoken.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 { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import * as models from "../index.js";
+
+export const AuthGetAccessTokenServerList = [
+  /**
+   * US Authentication
+   */
+  "https://auth.squadcast.com",
+  /**
+   * EU Authentication
+   */
+  "https://auth.eu.squadcast.com",
+] as const;
+
+export type AuthGetAccessTokenRequest = {
+  /**
+   * (Required) Send your refresh token obtained from Squadcast web application.
+   */
+  xRefreshToken: string;
+};
+
+/**
+ * The request has succeeded.
+ */
+export type AuthGetAccessTokenResponse = {
+  /**
+   * Access token response returned by the OAuth endpoint.
+   */
+  data: models.V3AuthAccessTokenData;
+};
+
+/** @internal */
+export type AuthGetAccessTokenRequest$Outbound = {
+  "X-Refresh-Token": string;
+};
+
+/** @internal */
+export const AuthGetAccessTokenRequest$outboundSchema: z.ZodType<
+  AuthGetAccessTokenRequest$Outbound,
+  z.ZodTypeDef,
+  AuthGetAccessTokenRequest
+> = z.object({
+  xRefreshToken: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    xRefreshToken: "X-Refresh-Token",
+  });
+});
+
+export function authGetAccessTokenRequestToJSON(
+  authGetAccessTokenRequest: AuthGetAccessTokenRequest,
+): string {
+  return JSON.stringify(
+    AuthGetAccessTokenRequest$outboundSchema.parse(authGetAccessTokenRequest),
+  );
+}
+
+/** @internal */
+export const AuthGetAccessTokenResponse$inboundSchema: z.ZodType<
+  AuthGetAccessTokenResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: models.V3AuthAccessTokenData$inboundSchema,
+});
+
+export function authGetAccessTokenResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<AuthGetAccessTokenResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AuthGetAccessTokenResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AuthGetAccessTokenResponse' from JSON`,
+  );
+}

package/src/models/operations/index.ts

@@ -13,6 +13,7 @@ export * from "./auditlogsgetauditlogbyid.js";
 export * from "./auditlogsgetauditlogsexporthistorybyid.js";
 export * from "./auditlogslistauditlogs.js";
 export * from "./auditlogslistauditlogsexporthistory.js";
+export * from "./authgetaccesstoken.js";
 export * from "./communicationcardsarchiveslackchannel.js";
 export * from "./communicationcardscreatecommunicationcard.js";
 export * from "./communicationcardscreateslackchannelincommunicationcard.js";

package/src/models/security.ts

@@ -6,12 +6,12 @@ import * as z from "zod/v3";
 import { remap as remap$ } from "../lib/primitives.js";
 
 export type Security = {
-  bearerAuth: string;
+  bearerAuth?: string | undefined;
 };
 
 /** @internal */
 export type Security$Outbound = {
-  BearerAuth: string;
+  BearerAuth?: string | undefined;
 };
 
 /** @internal */
@@ -20,7 +20,7 @@ export const Security$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   Security
 > = z.object({
-  bearerAuth: z.string(),
+  bearerAuth: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
     bearerAuth: "BearerAuth",

package/src/models/v3authaccesstokendata.ts

@@ -0,0 +1,65 @@
+/*
+ * 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";
+
+/**
+ * Access token response returned by the OAuth endpoint.
+ */
+export type V3AuthAccessTokenData = {
+  /**
+   * JWT access token used as Bearer token for API requests.
+   */
+  accessToken: string;
+  /**
+   * Unix timestamp when the access token expires.
+   */
+  expiresAt: number;
+  /**
+   * Unix timestamp when the access token was issued.
+   */
+  issuedAt: number;
+  /**
+   * Refresh token that can be used to obtain a new access token.
+   */
+  refreshToken: string;
+  /**
+   * Token type, e.g. "Bearer".
+   */
+  type: string;
+};
+
+/** @internal */
+export const V3AuthAccessTokenData$inboundSchema: z.ZodType<
+  V3AuthAccessTokenData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  access_token: z.string(),
+  expires_at: z.number().int(),
+  issued_at: z.number().int(),
+  refresh_token: z.string(),
+  type: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "access_token": "accessToken",
+    "expires_at": "expiresAt",
+    "issued_at": "issuedAt",
+    "refresh_token": "refreshToken",
+  });
+});
+
+export function v3AuthAccessTokenDataFromJSON(
+  jsonString: string,
+): SafeParseResult<V3AuthAccessTokenData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => V3AuthAccessTokenData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'V3AuthAccessTokenData' from JSON`,
+  );
+}

package/src/sdk/auth.ts

@@ -0,0 +1,29 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { authAuthGetAccessToken } from "../funcs/authAuthGetAccessToken.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Auth extends ClientSDK {
+  /**
+   * Get Access Token
+   *
+   * @remarks
+   * Get access token to make authenticated HTTP requests to the Squadcast API.
+   * Send your refresh token (obtained from the Squadcast web application) in the
+   * `X-Refresh-Token` header.
+   */
+  async authGetAccessToken(
+    request: operations.AuthGetAccessTokenRequest,
+    options?: RequestOptions,
+  ): Promise<operations.AuthGetAccessTokenResponse> {
+    return unwrapAsync(authAuthGetAccessToken(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/sdk.ts

@@ -5,6 +5,7 @@
 import { ClientSDK } from "../lib/sdks.js";
 import { Analytics } from "./analytics.js";
 import { AuditLogs } from "./auditlogs.js";
+import { Auth } from "./auth.js";
 import { CommunicationCards } from "./communicationcards.js";
 import { Components } from "./components.js";
 import { DedupKeyOverlays } from "./dedupkeyoverlays.js";
@@ -50,6 +51,11 @@ import { WorkflowLogs } from "./workflowlogs.js";
 import { Workflows } from "./workflows.js";
 
 export class SquadcastSDK extends ClientSDK {
+  private _auth?: Auth;
+  get auth(): Auth {
+    return (this._auth ??= new Auth(this._options));
+  }
+
   private _analytics?: Analytics;
   get analytics(): Analytics {
     return (this._analytics ??= new Analytics(this._options));