diff --git a/.changeset/four-paws-raise.md b/.changeset/four-paws-raise.md new file mode 100644 index 0000000..68578b1 --- /dev/null +++ b/.changeset/four-paws-raise.md @@ -0,0 +1,6 @@ +--- +"soteams-sdk-docs": patch +"@stackoverflow/teams-sdk": patch +--- + +Leftover changes from the update in naming conventions to Stack Overflow Internal diff --git a/.changeset/huge-breads-design.md b/.changeset/huge-breads-design.md new file mode 100644 index 0000000..d243aa7 --- /dev/null +++ b/.changeset/huge-breads-design.md @@ -0,0 +1,6 @@ +--- +"soteams-sdk-docs": minor +"@stackoverflow/teams-sdk": minor +--- + +Changed naming conventions from "Stack Overflow for Teams" and "Stack Overflow Enterprise" to "Stack Overflow Internal" and "Stack Internal Enterprise" diff --git a/.changeset/tired-papers-sleep.md b/.changeset/tired-papers-sleep.md new file mode 100644 index 0000000..08e8939 --- /dev/null +++ b/.changeset/tired-papers-sleep.md @@ -0,0 +1,5 @@ +--- +"soteams-sdk-docs": minor +--- + +Changed site URL to sdk.stackoverflow.help diff --git a/README.md b/README.md index ee85cb9..eff2013 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,18 @@ -# Stack Overflow for Teams SDK +# Stack Overflow Internal SDK [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](./LICENSE) ![Status: Early Access](https://img.shields.io/badge/status-early--access-orange) -> Official TypeScript SDK for interacting with the **Stack Overflow for Teams API**. +> Official TypeScript SDK for interacting with the **Stack Overflow Internal API**. -The Stack Overflow for Teams SDK lets you build powerful applications and integrations on top of your team’s private knowledge base. +The Stack Internal SDK lets you build powerful applications and integrations on top of your team’s private knowledge base. --- ## ✨ Features - πŸ›  **Official support** – built and maintained by Stack Overflow with full API coverage. -- πŸ§‘β€πŸ’» **Type safety** – complete TypeScript definitions for all Teams endpoints, models, and responses. +- πŸ§‘β€πŸ’» **Type safety** – complete TypeScript definitions for all Stack Internal endpoints, models, and responses. - πŸ“š **Knowledge access** – query questions, answers, and articles from your team’s private repository. - πŸ‘₯ **Team management** – access profiles, activity, and collaborate on internal documentation and Q&A. @@ -40,7 +40,7 @@ yarn add @stackoverflow/teams-sdk ## πŸ“š Documentation -* [Quick Start Guide](https://sdk.stackoverflowteams.com/) +* [Quick Start Guide](https://sdk.stackoverflow.help/) * [API v3 Overview](https://stackoverflowteams.help/en/articles/9085836-api-v3-overview) ## πŸ›  Contributing @@ -51,6 +51,6 @@ Contributions are welcome! Please open an [issue](https://github.com/StackExchan (C) Copyright 2025 Stack Exchange, Inc. -This Stack Overflow for Teams SDK is licensed to you under the terms of the Apache Software License Version 2.0 (Apache 2.0): https://www.apache.org/licenses/LICENSE-2.0.txt +This Stack Overflow Internal SDK is licensed to you under the terms of the Apache Software License Version 2.0 (Apache 2.0): https://www.apache.org/licenses/LICENSE-2.0.txt -The Teams SDK is 100% open source and freely available to download and use under the terms of the Apache 2.0 license. This SDK enables development with the Stack Overflow for Teams API, which is available to all Teams customers, but may be subject to future changes. +The Stack Overflow Internal SDK is 100% open source and freely available to download and use under the terms of the Apache 2.0 license. This SDK enables development with the Stack Internal API, which is available to all Stack Internal customers, but may be subject to future changes. diff --git a/docs/astro.config.mjs b/docs/astro.config.mjs index 8e5eb0e..3db5e1d 100644 --- a/docs/astro.config.mjs +++ b/docs/astro.config.mjs @@ -4,11 +4,11 @@ import starlight from '@astrojs/starlight'; // https://astro.build/config export default defineConfig({ - site: 'https://sdk.stackoverflowteams.com', + site: 'https://sdk.stackoverflow.help', integrations: [ starlight({ favicon: '/favicon.ico', - title: 'Stack Overflow for Teams SDK', + title: 'Stack Overflow Internal SDK', editLink: { baseUrl: 'https://github.com/StackExchange/StackOverflowSDK/edit/main/docs', }, diff --git a/docs/src/content/docs/guides/authentication.mdx b/docs/src/content/docs/guides/authentication.mdx index cf871fc..f5316e8 100644 --- a/docs/src/content/docs/guides/authentication.mdx +++ b/docs/src/content/docs/guides/authentication.mdx @@ -4,12 +4,12 @@ description: Learn how to authenticate with the Stack Overflow API using the bui --- import { Card, CardGrid } from '@astrojs/starlight/components'; -The Stack Overflow SDK provides built-in authentication helpers that simplify the OAuth 2.0 flow with PKCE for secure token generation. Authentication requirements vary by Stack Overflow for Teams tier. +The Stack Overflow SDK provides built-in authentication helpers that simplify the OAuth 2.0 flow with PKCE for secure token generation. Authentication requirements vary by Stack Internal tier. ### Authentication by Tier -- **Stack Overflow for Teams Enterprise** - Supports OAuth 2.0 with PKCE. Access tokens can be generated dynamically. You can optionally provide a single Access Token manually. -- **Stack Overflow for Teams Basic/Business** - OAuth is not available. Manual input of Access tokens (PATs) are **required** in order to use the SDK. +- **Stack Internal Enterprise** - Supports OAuth 2.0 with PKCE. Access tokens can be generated dynamically. You can optionally provide a single Access Token manually. +- **Stack Internal Basic/Business** - OAuth is not available. Manual input of Access tokens (PATs) are **required** in order to use the SDK. ### Authentication Clients @@ -66,7 +66,7 @@ const questions = await teamContext.questions.getAll(); ## Authentication Clients (Enterprise Only) :::note[Enterprise Feature] -Authentication clients are only available for Stack Overflow for Teams Enterprise instances. Basic/Business tiers must use Personal Access Tokens during SDK initialization. +Authentication clients are only available for Stack Internal Enterprise instances. Basic/Business tiers must use Personal Access Tokens during SDK initialization. ::: ### Backend Authentication (Server-Side) @@ -132,11 +132,11 @@ const success = await frontendClient.submitAccessToken(userToken); ```typescript interface AuthConfig { - /** OAuth client ID from Stack Overflow Enterprise */ + /** OAuth client ID from Stack Internal Enterprise */ clientId: string; /** Redirect URI registered with your application */ redirectUri: string; - /** Stack Overflow Enterprise instance URL */ + /** Stack Internal Enterprise instance URL */ baseUrl: string; /** OAuth scopes (optional) */ scope?: string; diff --git a/docs/src/content/docs/guides/quickstart.mdx b/docs/src/content/docs/guides/quickstart.mdx index b9a413a..cba4794 100644 --- a/docs/src/content/docs/guides/quickstart.mdx +++ b/docs/src/content/docs/guides/quickstart.mdx @@ -29,7 +29,7 @@ Get your Stack Overflow integration running in minutes with our JavaScript SDK. ## Authentication Setup -Before making API calls, you'll need to set up authentication. The approach varies by your Stack Overflow for Teams tier: +Before making API calls, you'll need to set up authentication. The approach varies by your Stack Internal tier: ### Enterprise - OAuth Available Enterprise instances can use built-in OAuth clients or manual tokens: @@ -181,7 +181,7 @@ const questions = await sdk.questions.getAll(); ## Team Context -For Stack Overflow for Teams, use the team context: +For Stack Internal Basic/Business, use the team context: ```typescript title="team-example.ts" // Switch to team context diff --git a/docs/src/content/docs/guides/rate-limiting.md b/docs/src/content/docs/guides/rate-limiting.md index 68877b0..f8e6078 100644 --- a/docs/src/content/docs/guides/rate-limiting.md +++ b/docs/src/content/docs/guides/rate-limiting.md @@ -1,9 +1,9 @@ --- title: Rate Limiting and Throttling -description: Understanding API throttling and rate limits for Stack Overflow for Teams API v3. +description: Understanding API throttling and rate limits for Stack Overflow Internal API v3. --- -Stack Overflow for Teams API v3 uses request throttling to prevent abuse and ensure optimum performance for all users. We currently implement two different types of throttling to alleviate excessive API calls: burst throttle rate limiter (short-term) and token bucket rate limiter (long-term). Both throttling methods monitor the number of requests coming from each access token. +Stack Overflow Internal API v3 uses request throttling to prevent abuse and ensure optimum performance for all users. We currently implement two different types of throttling to alleviate excessive API calls: burst throttle rate limiter (short-term) and token bucket rate limiter (long-term). Both throttling methods monitor the number of requests coming from each access token. ## Burst Throttle Rate Limiter diff --git a/docs/src/content/docs/index.mdx b/docs/src/content/docs/index.mdx index 29886bf..956b956 100644 --- a/docs/src/content/docs/index.mdx +++ b/docs/src/content/docs/index.mdx @@ -1,12 +1,12 @@ --- -title: Welcome to The Stack Overflow for Teams SDK -description: Build powerful applications with the official Stack Overflow for Teams SDK. Access your team's private knowledge base programmatically. +title: Welcome to The Stack Overflow Internal SDK +description: Build powerful applications with the official Stack Internal SDK. Access your team's private knowledge base programmatically. template: splash banner: content: | This SDK is currently in Early Access. New features are actively being developed. hero: - tagline: Start building with the Stack Overflow for Teams API using our official SDK + tagline: Start building with the Stack Internal API using our official SDK image: light: ../../assets/stackoverflow-black.svg dark: ../../assets/stackoverflow-white.png @@ -39,14 +39,14 @@ import { Card, CardGrid } from '@astrojs/starlight/components'; -## Why use the Stack Overflow for Teams SDK? +## Why use the Stack Internal SDK? - Built and maintained by Stack Overflow with full Teams API coverage and guaranteed compatibility. + Built and maintained by Stack Overflow with full Stack Internal API coverage and guaranteed compatibility. - Complete TypeScript definitions for all Teams endpoints, models, and responses. + Complete TypeScript definitions for all Stack Internal endpoints, models, and responses. Includes full PKCE authentication with ready-to-use helpers for both backend and frontend implementations. @@ -55,11 +55,11 @@ import { Card, CardGrid } from '@astrojs/starlight/components'; ## Popular use cases -Whether you're building internal tools, integrating with existing workflows, or creating custom team applications, the Stack Overflow for Teams SDK provides everything you need to leverage your team's collective knowledge. +Whether you're building internal tools, integrating with existing workflows, or creating custom team applications, the Stack Overflow Internal SDK provides everything you need to leverage your team's collective knowledge. **Internal Tooling**: Build IDE extensions, code review tools, or documentation generators that tap into your team's institutional knowledge. -**Workflow Integration**: Connect your Teams instance with CI/CD pipelines, project management tools, or custom dashboards. +**Workflow Integration**: Connect your Stack Internal instance with CI/CD pipelines, project management tools, or custom dashboards. **Knowledge Management**: Create applications that help organize, surface, and distribute your team's expertise and best practices. @@ -72,11 +72,11 @@ This project is in **early access**, and more language support and features will ## Ready to start building? -Our SDK provides a higher-level abstraction for programmatically interacting with Stack Overflow for Teams, removing friction and enabling you to focus on building great experiences for your team. +Our SDK provides a higher-level abstraction for programmatically interacting with Stack Internal, removing friction and enabling you to focus on building great experiences for your team. ## License (C) Copyright 2025 Stack Exchange, Inc. -This Stack Overflow for Teams SDK is licensed to you under the terms of the Apache Software License Version 2.0 (Apache 2.0): https://www.apache.org/licenses/LICENSE-2.0.txt +This Stack Overflow Internal SDK is licensed to you under the terms of the Apache Software License Version 2.0 (Apache 2.0): https://www.apache.org/licenses/LICENSE-2.0.txt -The Teams SDK is 100% open source and freely available to download and use under the terms of the Apache 2.0 license. This SDK enables development with the Stack Overflow for Teams API, which is available to all Teams customers, but may be subject to future changes. +The Stack Overflow Internal SDK is 100% open source and freely available to download and use under the terms of the Apache 2.0 license. This SDK enables development with the Stack Overflow Internal API, which is available to all Stack Internal customers, but may be subject to future changes. diff --git a/docs/src/content/docs/users/manage.mdx b/docs/src/content/docs/users/manage.mdx index 52a5d6d..b0a0ebc 100644 --- a/docs/src/content/docs/users/manage.mdx +++ b/docs/src/content/docs/users/manage.mdx @@ -515,7 +515,7 @@ const managementData = await safeUserManagement({ ## Notes -- **Enterprise Only**: This method is only available in enterprise Stack Overflow context, not for Stack Overflow for Teams. +- **Enterprise Only**: This method is only available in enterprise Stack Overflow context, not for Stack Internal Basic/Business. - **Admin Privileges**: Requires administrator or moderator permissions to access user management data. - **Extended User Data**: Provides additional fields like creation dates, modification dates, and deactivation status not available in regular user queries. - **Date Filtering**: Supports sophisticated date-based filtering for activity analysis and user lifecycle management. diff --git a/sdk/README.md b/sdk/README.md index dd5878b..4c9db4a 100644 --- a/sdk/README.md +++ b/sdk/README.md @@ -1,10 +1,10 @@ -# Stack Overflow for Teams SDK +# Stack Overflow Internal SDK -A comprehensive TypeScript/JavaScript SDK for interacting with the Stack Overflow for Teams API. This toolkit provides easy-to-use methods for accessing questions, answers, users, and other resources in your Stack Overflow for Teams instance. +A comprehensive TypeScript/JavaScript SDK for interacting with the Stack Internal API. This toolkit provides easy-to-use methods for accessing questions, answers, users, and other resources in your Stack Internal instance. ## Features -- πŸš€ **Simple API wrapper** - Clean, intuitive interface for all Stack Overflow for Teams endpoints +- πŸš€ **Simple API wrapper** - Clean, intuitive interface for all Stack Internal endpoints - πŸ”’ **OAuth2 authentication** - Built-in support for access token authentication - πŸ“¦ **Modular design** - Organized client modules for different resource types - 🎯 **Team context support** - Switch between different teams seamlessly @@ -101,7 +101,7 @@ interface SDKConfig { ### Authentication -Basic and Business customers can follow the official Stack Overflow for Teams guide to create a Personal Access Token (PAT) for API authentication: +Basic and Business customers can follow the official Stack Internal guide to create a Personal Access Token (PAT) for API authentication: πŸ‘‰ [Personal Access Tokens (PATs) for API Authentication](https://stackoverflowteams.help/en/articles/10908790-personal-access-tokens-pats-for-api-authentication) diff --git a/sdk/src/auth/backend.ts b/sdk/src/auth/backend.ts index 321572d..7d38a51 100644 --- a/sdk/src/auth/backend.ts +++ b/sdk/src/auth/backend.ts @@ -2,7 +2,7 @@ import { AuthConfig, TokenResponse, PKCETokens } from './types.js'; import crypto from 'crypto'; /** - * Backend authentication client for Stack Overflow Enterprise using PKCE flow + * Backend authentication client for Stack Overflow Internal Enterprise using PKCE flow * Designed for server-side Node.js environments with access to crypto module */ export class BackendAuthClient { @@ -10,7 +10,7 @@ export class BackendAuthClient { /** * Creates a new backend authentication client - * @param config - Authentication configuration for Stack Overflow Enterprise + * @param config - Authentication configuration for Stack Overflow Internal Enterprise */ constructor(config: AuthConfig) { this.config = config; @@ -44,7 +44,7 @@ export class BackendAuthClient { } /** - * Generate authorization URL for Stack Overflow Enterprise with PKCE + * Generate authorization URL for Stack Overflow Internal Enterprise with PKCE * Creates the URL where users should be redirected to authorize your application * * @returns Promise resolving to authorization data including the URL and tokens to store @@ -67,7 +67,7 @@ export class BackendAuthClient { const { codeVerifier, codeChallenge, state } = await this.generatePKCETokens(); - // Stack Overflow Enterprise uses /oauth endpoint, not /oauth/authorize + // Stack Overflow Internal Enterprise uses /oauth endpoint, not /oauth/authorize const authUrl = `${this.config.baseUrl}/oauth?client_id=${ this.config.clientId }&redirect_uri=${encodeURIComponent( @@ -106,7 +106,7 @@ export class BackendAuthClient { throw new Error('clientId and redirectUri are required for authentication'); } - // Stack Overflow Enterprise uses /oauth/access_token/json endpoint + // Stack Overflow Internal Enterprise uses /oauth/access_token/json endpoint const tokenUrl = `${this.config.baseUrl}/oauth/access_token/json`; const queryParams = new URLSearchParams({ diff --git a/sdk/src/auth/frontend.ts b/sdk/src/auth/frontend.ts index 0f5ed6f..9b6052b 100644 --- a/sdk/src/auth/frontend.ts +++ b/sdk/src/auth/frontend.ts @@ -1,7 +1,7 @@ import { AuthConfig } from './types.js'; /** - * Frontend authentication client for Stack Overflow Enterprise + * Frontend authentication client for Stack Overflow Internal Enterprise * This client communicates with your backend API to handle OAuth flows securely. * The backend performs all PKCE operations and token exchanges. */ @@ -11,7 +11,7 @@ export class FrontendAuthClient { /** * Creates a new frontend authentication client - * @param config - Authentication configuration for Stack Overflow Enterprise + * @param config - Authentication configuration for Stack Overflow Internal Enterprise * @param apiBaseUrl - Base URL of your backend API that handles OAuth operations */ constructor(config: AuthConfig, apiBaseUrl: string = '/api') { @@ -28,7 +28,7 @@ export class FrontendAuthClient { * @example * ```typescript * const authUrl = await frontendClient.startAuth(); - * window.location.href = authUrl; // Redirect user to Stack Overflow Enterprise + * window.location.href = authUrl; // Redirect user to Stack Overflow Internal Enterprise * ``` */ async startAuth(): Promise { @@ -44,8 +44,8 @@ export class FrontendAuthClient { * Complete the authentication process by sending the callback parameters to your backend * Your backend will validate the state, exchange the code for tokens, and store them securely * - * @param code - The authorization code received from Stack Overflow Enterprise callback - * @param state - The state parameter received from Stack Overflow Enterprise callback + * @param code - The authorization code received from Stack Overflow Internal Enterprise callback + * @param state - The state parameter received from Stack Overflow Internal Enterprise callback * @throws {Error} When the backend request fails or authentication is invalid * @example * ```typescript @@ -117,9 +117,9 @@ export class FrontendAuthClient { /** * Submit an access token directly (for cases where user provides their own token) - * Allows users to manually provide a Stack Overflow Enterprise access token + * Allows users to manually provide a Stack Overflow Internal Enterprise access token * - * @param token - The Stack Overflow Enterprise access token + * @param token - The Stack Overflow Internal Enterprise access token * @returns Promise resolving to true if token was accepted, false otherwise * @example * ```typescript diff --git a/sdk/src/auth/types.ts b/sdk/src/auth/types.ts index a9504be..1cc93fe 100644 --- a/sdk/src/auth/types.ts +++ b/sdk/src/auth/types.ts @@ -1,19 +1,19 @@ /** - * Configuration for Stack Overflow Enterprise authentication using PKCE + * Configuration for Stack Overflow Internal Enterprise authentication using PKCE */ export interface AuthConfig { - /** The OAuth client ID from your Stack Overflow Enterprise application */ + /** The OAuth client ID from your Stack Overflow Internal Enterprise application */ clientId: string; - /** The redirect URI registered with your Stack Overflow Enterprise application */ + /** The redirect URI registered with your Stack Overflow Internal Enterprise application */ redirectUri: string; - /** The base URL of your Stack Overflow Enterprise instance (e.g., 'https://acme.stackenterprise.co') */ - baseUrl: string; // Stack Overflow Enterprise instance URL + /** The base URL of your Stack Overflow Internal Enterprise instance (e.g., 'https://acme.stackenterprise.co') */ + baseUrl: string; // Stack Overflow Internal Enterprise instance URL /** OAuth scope to request (defaults to read-only access if not specified) */ scope?: string; } /** - * Response from Stack Overflow Enterprise token exchange endpoint + * Response from Stack Overflow Internal Enterprise token exchange endpoint */ export interface TokenResponse { /** The access token for making authenticated API requests */ diff --git a/sdk/src/client/answers.ts b/sdk/src/client/answers.ts index 883c883..2204cb2 100644 --- a/sdk/src/client/answers.ts +++ b/sdk/src/client/answers.ts @@ -34,7 +34,7 @@ export interface GetAnswersOptions { } /** - * Client for managing answers in Stack Overflow for Teams + * Client for managing answers in Stack Overflow Internal * * The AnswerClient provides methods to create, read, update, and delete answers, * as well as handle voting and moderation actions. It supports both main site diff --git a/sdk/src/client/articles.ts b/sdk/src/client/articles.ts index 75f5ae5..a966432 100644 --- a/sdk/src/client/articles.ts +++ b/sdk/src/client/articles.ts @@ -83,7 +83,7 @@ export interface GetLinkedQuestionsOptions { } /** - * Client for managing articles in Stack Overflow for Teams + * Client for managing articles in Stack Overflow Internal * * The ArticleClient provides comprehensive methods for creating, reading, updating, * and deleting articles, as well as managing upvotes and retrieving linked questions. diff --git a/sdk/src/client/collections.ts b/sdk/src/client/collections.ts index 8874cac..65682d2 100644 --- a/sdk/src/client/collections.ts +++ b/sdk/src/client/collections.ts @@ -76,7 +76,7 @@ export interface GetCollectionsOptions { } /** - * Client for managing collections in Stack Overflow for Teams + * Client for managing collections in Stack Overflow Internal * * The CollectionClient provides comprehensive methods for creating, reading, updating, * and deleting collections of questions and articles. Collections help organize related diff --git a/sdk/src/client/comments.ts b/sdk/src/client/comments.ts index 3f796a2..4e4e827 100644 --- a/sdk/src/client/comments.ts +++ b/sdk/src/client/comments.ts @@ -3,7 +3,7 @@ import { CommentsMainApi, CommentsTeamsApi } from '../generated/index.js'; import { CommentResponseModel } from '../generated/index.js'; /** - * Client for retrieving comments from articles, questions, and answers in Stack Overflow for Teams + * Client for retrieving comments from articles, questions, and answers in Stack Overflow Internal * * The CommentClient provides methods to retrieve comments associated with different types of content. * Comments are read-only through this API and provide additional context and discussion around diff --git a/sdk/src/client/communities.ts b/sdk/src/client/communities.ts index 20602de..10190f4 100644 --- a/sdk/src/client/communities.ts +++ b/sdk/src/client/communities.ts @@ -43,7 +43,7 @@ export interface LeaveCommunityBulkOptions { } /** - * Client for managing communities in Stack Overflow for Teams + * Client for managing communities in Stack Overflow Internal * * The CommunityClient provides methods for managing community membership and retrieving * community information. Communities are organizational units that group users together, @@ -75,7 +75,7 @@ export class CommunityClient extends BaseClient { constructor(config: ReturnType) { super(); this.mainApi = new CommunitiesMainApi(config); - // Note: Communities API has no Teams API variant - only Main API + // Note: Communities API has no Private Team API variant - only Main API } /** diff --git a/sdk/src/client/index.ts b/sdk/src/client/index.ts index a0d2f02..d1b9642 100644 --- a/sdk/src/client/index.ts +++ b/sdk/src/client/index.ts @@ -30,7 +30,7 @@ function normalizeBaseUrl(baseUrl: string): string { // Remove trailing slashes const cleanUrl = baseUrl.replace(/\/+$/, ''); - // Don't modify the B&B Stack Overflow Teams API URL + // Don't modify the B&B Stack Overflow Internal API URL if (cleanUrl.startsWith('https://api.stackoverflowteams.com')) { return cleanUrl; } @@ -64,8 +64,8 @@ export interface AuthSDKConfig extends SDKConfig { } /** - * Main Stack Overflow for Teams SDK client - * Provides access to all Stack Overflow for Teams API endpoints and authentication flows + * Main Stack Overflow Internal SDK client + * Provides access to all Stack Overflow Internal API endpoints and authentication flows */ export class StackOverflowSDK { private config: ReturnType; @@ -89,7 +89,7 @@ export class StackOverflowSDK { }; /** - * Creates a new Stack Overflow for Teams SDK instance + * Creates a new Stack Overflow Internal SDK instance * @param config - SDK configuration with optional authentication setup * @example * ```typescript @@ -182,8 +182,8 @@ export class StackOverflowSDK { * Create an authenticated SDK instance from an existing access token * Convenient factory method when you already have a valid access token * - * @param accessToken - Valid Stack Overflow for Teams access token - * @param baseUrl - Base URL of your Stack Overflow for Teams instance (API v3 path automatically appended where needed) + * @param accessToken - Valid Stack Overflow Internal access token + * @param baseUrl - Base URL of your Stack Overflow Internal instance (API v3 path automatically appended where needed) * @returns Configured SDK instance ready for authenticated API calls * @example * ```typescript @@ -212,7 +212,7 @@ export class StackOverflowSDK { } /** - * Create an SDK instance configured for Stack Overflow Enterprise OAuth authentication + * Create an SDK instance configured for Stack Overflow Internal Enterprise OAuth authentication * Sets up both backend and frontend auth clients for handling OAuth flows * * @param authConfig - Complete authentication configuration including OAuth settings @@ -243,7 +243,7 @@ export class StackOverflowSDK { } /** - * Team-specific context for Stack Overflow for Teams API operations (required for Basic and Business Teams) + * Team-specific context for Stack Overflow Internal API operations (required for Basic and Business Internal teams) * Provides access to all API clients scoped to a specific team */ export class TeamContext { diff --git a/sdk/src/client/questions.ts b/sdk/src/client/questions.ts index a3ee9af..d5d29f8 100644 --- a/sdk/src/client/questions.ts +++ b/sdk/src/client/questions.ts @@ -83,11 +83,11 @@ export interface GetLinkedQuestionsOptions { } /** - * Client for managing questions in Stack Overflow for Teams + * Client for managing questions in Stack Overflow Internal * * The QuestionClient provides comprehensive methods for creating, reading, updating, * and deleting questions, as well as managing votes, bookmarks, and discovering - * related content. Questions are the core content type in Stack Overflow for Teams, + * related content. Questions are the core content type in Stack Overflow Internal, * supporting rich interactions including voting, bookmarking, flagging, and * relationship discovery with other questions. * diff --git a/sdk/src/client/search.ts b/sdk/src/client/search.ts index 04cc4b4..732aa7e 100644 --- a/sdk/src/client/search.ts +++ b/sdk/src/client/search.ts @@ -21,7 +21,7 @@ export interface SearchOptions { } /** - * Client for performing searches across Stack Overflow for Teams content + * Client for performing searches across Stack Overflow Internal content * * The SearchClient provides comprehensive search functionality across all content types * including questions, answers, articles, and other searchable content. It supports diff --git a/sdk/src/client/shared/base.ts b/sdk/src/client/shared/base.ts index 7b98848..7a010f8 100644 --- a/sdk/src/client/shared/base.ts +++ b/sdk/src/client/shared/base.ts @@ -15,7 +15,7 @@ export abstract class BaseClient { } /** - * Helper method to determine which API to use (Main vs Teams) + * Helper method to determine which API to use (Main vs Internal teams) */ protected chooseApi( mainApi: TMain, diff --git a/sdk/src/client/tags.ts b/sdk/src/client/tags.ts index 0775e35..de44cd2 100644 --- a/sdk/src/client/tags.ts +++ b/sdk/src/client/tags.ts @@ -43,7 +43,7 @@ export interface SetSubjectMatterExpertsOptions { } /** - * Client for managing tags and Subject Matter Experts in Stack Overflow for Teams + * Client for managing tags and Subject Matter Experts in Stack Overflow Internal * * The TagClient provides comprehensive methods for tag discovery, management, and * Subject Matter Expert (SME) administration. Tags are used to categorize and organize diff --git a/sdk/src/client/userGroups.ts b/sdk/src/client/userGroups.ts index 1ac360a..b4ee6a2 100644 --- a/sdk/src/client/userGroups.ts +++ b/sdk/src/client/userGroups.ts @@ -48,7 +48,7 @@ export interface GetUserGroupsOptions { } /** - * Client for managing user groups in Stack Overflow for Teams + * Client for managing user groups in Stack Overflow Internal * * The UserGroupClient provides comprehensive methods for creating, reading, and updating * user groups, as well as managing group membership. User groups are organizational diff --git a/sdk/src/client/users.ts b/sdk/src/client/users.ts index 786c2a9..590574a 100644 --- a/sdk/src/client/users.ts +++ b/sdk/src/client/users.ts @@ -48,7 +48,7 @@ export interface ManageUsersOptions { } /** - * Client for managing users and user information in Stack Overflow for Teams + * Client for managing users and user information in Stack Overflow Internal * * The UserClient provides comprehensive methods for user discovery, management, * and profile access. It supports both basic user browsing and advanced administrative