feat: add GET enterprise configuration endpoint (box/box-openapi#559)

Author: box-sdk-build

.codegen.json

@@ -1 +1 @@
-{ "engineHash": "192deac", "specHash": "fa34496", "version": "10.0.1" }
+{ "engineHash": "192deac", "specHash": "cf21406", "version": "10.0.1" }

docs/README.md

@@ -22,6 +22,7 @@ the SDK are available by topic:
 - [Docgen template](docgenTemplate.md)
 - [Downloads](downloads.md)
 - [Email aliases](emailAliases.md)
+- [Enterprise configurations](enterpriseConfigurations.md)
 - [Events](events.md)
 - [External users](externalUsers.md)
 - [File classifications](fileClassifications.md)

docs/enterpriseConfigurations.md

@@ -0,0 +1,28 @@
+# EnterpriseConfigurationsManager
+
+- [Get enterprise configuration](#get-enterprise-configuration)
+
+## Get enterprise configuration
+
+Retrieves the configuration for an enterprise.
+
+This operation is performed by calling function `getEnterpriseConfigurationByIdV2025R0`.
+
+See the endpoint docs at
+[API Reference](https://developer.box.com/reference/v2025.0/get-enterprise-configurations-id/).
+
+_Currently we don't have an example for calling `getEnterpriseConfigurationByIdV2025R0` in integration tests_
+
+### Arguments
+
+- enterpriseId `string`
+  - The ID of the enterprise. Example: "3442311"
+- queryParams `GetEnterpriseConfigurationByIdV2025R0QueryParams`
+  - Query parameters of getEnterpriseConfigurationByIdV2025R0 method
+- optionalsInput `GetEnterpriseConfigurationByIdV2025R0OptionalsInput`
+
+### Returns
+
+This function returns a value of type `EnterpriseConfigurationV2025R0`.
+
+Returns the enterprise configuration.

package-lock.json

@@ -76,6 +76,7 @@ import { AiManager } from './managers/ai';
 import { AiStudioManager } from './managers/aiStudio';
 import { DocgenTemplateManager } from './managers/docgenTemplate';
 import { DocgenManager } from './managers/docgen';
+import { EnterpriseConfigurationsManager } from './managers/enterpriseConfigurations';
 import { HubsManager } from './managers/hubs';
 import { HubCollaborationsManager } from './managers/hubCollaborations';
 import { HubItemsManager } from './managers/hubItems';
@@ -177,6 +178,7 @@ export class BoxClient {
   readonly aiStudio: AiStudioManager;
   readonly docgenTemplate: DocgenTemplateManager;
   readonly docgen: DocgenManager;
+  readonly enterpriseConfigurations: EnterpriseConfigurationsManager;
   readonly hubs: HubsManager;
   readonly hubCollaborations: HubCollaborationsManager;
   readonly hubItems: HubItemsManager;
@@ -260,6 +262,7 @@ export class BoxClient {
       | 'aiStudio'
       | 'docgenTemplate'
       | 'docgen'
+      | 'enterpriseConfigurations'
       | 'hubs'
       | 'hubCollaborations'
       | 'hubItems'
@@ -586,6 +589,10 @@ export class BoxClient {
       auth: this.auth,
       networkSession: this.networkSession,
     });
+    this.enterpriseConfigurations = new EnterpriseConfigurationsManager({
+      auth: this.auth,
+      networkSession: this.networkSession,
+    });
     this.hubs = new HubsManager({
       auth: this.auth,
       networkSession: this.networkSession,

src/client.ts

@@ -0,0 +1,178 @@
+import { serializeEnterpriseConfigurationV2025R0 } from '../schemas/v2025R0/enterpriseConfigurationV2025R0';
+import { deserializeEnterpriseConfigurationV2025R0 } from '../schemas/v2025R0/enterpriseConfigurationV2025R0';
+import { serializeClientErrorV2025R0 } from '../schemas/v2025R0/clientErrorV2025R0';
+import { deserializeClientErrorV2025R0 } from '../schemas/v2025R0/clientErrorV2025R0';
+import { serializeBoxVersionHeaderV2025R0 } from '../parameters/v2025R0/boxVersionHeaderV2025R0';
+import { deserializeBoxVersionHeaderV2025R0 } from '../parameters/v2025R0/boxVersionHeaderV2025R0';
+import { ResponseFormat } from '../networking/fetchOptions';
+import { EnterpriseConfigurationV2025R0 } from '../schemas/v2025R0/enterpriseConfigurationV2025R0';
+import { ClientErrorV2025R0 } from '../schemas/v2025R0/clientErrorV2025R0';
+import { BoxVersionHeaderV2025R0 } from '../parameters/v2025R0/boxVersionHeaderV2025R0';
+import { BoxSdkError } from '../box/errors';
+import { Authentication } from '../networking/auth';
+import { NetworkSession } from '../networking/network';
+import { FetchOptions } from '../networking/fetchOptions';
+import { FetchResponse } from '../networking/fetchResponse';
+import { prepareParams } from '../internal/utils';
+import { toString } from '../internal/utils';
+import { ByteStream } from '../internal/utils';
+import { CancellationToken } from '../internal/utils';
+import { sdToJson } from '../serialization/json';
+import { SerializedData } from '../serialization/json';
+import { sdIsEmpty } from '../serialization/json';
+import { sdIsBoolean } from '../serialization/json';
+import { sdIsNumber } from '../serialization/json';
+import { sdIsString } from '../serialization/json';
+import { sdIsList } from '../serialization/json';
+import { sdIsMap } from '../serialization/json';
+export class GetEnterpriseConfigurationByIdV2025R0Optionals {
+  readonly headers: GetEnterpriseConfigurationByIdV2025R0Headers =
+    new GetEnterpriseConfigurationByIdV2025R0Headers({});
+  readonly cancellationToken?: CancellationToken = void 0;
+  constructor(
+    fields: Omit<
+      GetEnterpriseConfigurationByIdV2025R0Optionals,
+      'headers' | 'cancellationToken'
+    > &
+      Partial<
+        Pick<
+          GetEnterpriseConfigurationByIdV2025R0Optionals,
+          'headers' | 'cancellationToken'
+        >
+      >,
+  ) {
+    if (fields.headers !== undefined) {
+      this.headers = fields.headers;
+    }
+    if (fields.cancellationToken !== undefined) {
+      this.cancellationToken = fields.cancellationToken;
+    }
+  }
+}
+export interface GetEnterpriseConfigurationByIdV2025R0OptionalsInput {
+  readonly headers?: GetEnterpriseConfigurationByIdV2025R0Headers;
+  readonly cancellationToken?: undefined | CancellationToken;
+}
+export interface GetEnterpriseConfigurationByIdV2025R0QueryParams {
+  /**
+   * The comma-delimited list of the enterprise configuration categories.
+   * Allowed values: `security`, `content_and_sharing`, `user_settings`, `shield`. */
+  readonly categories: string;
+}
+export class GetEnterpriseConfigurationByIdV2025R0Headers {
+  /**
+   * Version header. */
+  readonly boxVersion: BoxVersionHeaderV2025R0 =
+    '2025.0' as BoxVersionHeaderV2025R0;
+  /**
+   * Extra headers that will be included in the HTTP request. */
+  readonly extraHeaders?: {
+    readonly [key: string]: undefined | string;
+  } = {};
+  constructor(
+    fields: Omit<
+      GetEnterpriseConfigurationByIdV2025R0Headers,
+      'boxVersion' | 'extraHeaders'
+    > &
+      Partial<
+        Pick<
+          GetEnterpriseConfigurationByIdV2025R0Headers,
+          'boxVersion' | 'extraHeaders'
+        >
+      >,
+  ) {
+    if (fields.boxVersion !== undefined) {
+      this.boxVersion = fields.boxVersion;
+    }
+    if (fields.extraHeaders !== undefined) {
+      this.extraHeaders = fields.extraHeaders;
+    }
+  }
+}
+export interface GetEnterpriseConfigurationByIdV2025R0HeadersInput {
+  /**
+   * Version header. */
+  readonly boxVersion?: BoxVersionHeaderV2025R0;
+  /**
+   * Extra headers that will be included in the HTTP request. */
+  readonly extraHeaders?:
+    | undefined
+    | {
+        readonly [key: string]: undefined | string;
+      };
+}
+export class EnterpriseConfigurationsManager {
+  readonly auth?: Authentication;
+  readonly networkSession: NetworkSession = new NetworkSession({});
+  constructor(
+    fields: Omit<
+      EnterpriseConfigurationsManager,
+      'networkSession' | 'getEnterpriseConfigurationByIdV2025R0'
+    > &
+      Partial<Pick<EnterpriseConfigurationsManager, 'networkSession'>>,
+  ) {
+    if (fields.auth !== undefined) {
+      this.auth = fields.auth;
+    }
+    if (fields.networkSession !== undefined) {
+      this.networkSession = fields.networkSession;
+    }
+  }
+  /**
+     * Retrieves the configuration for an enterprise.
+     * @param {string} enterpriseId The ID of the enterprise.
+    Example: "3442311"
+     * @param {GetEnterpriseConfigurationByIdV2025R0QueryParams} queryParams Query parameters of getEnterpriseConfigurationByIdV2025R0 method
+     * @param {GetEnterpriseConfigurationByIdV2025R0OptionalsInput} optionalsInput
+     * @returns {Promise<EnterpriseConfigurationV2025R0>}
+     */
+  async getEnterpriseConfigurationByIdV2025R0(
+    enterpriseId: string,
+    queryParams: GetEnterpriseConfigurationByIdV2025R0QueryParams,
+    optionalsInput: GetEnterpriseConfigurationByIdV2025R0OptionalsInput = {},
+  ): Promise<EnterpriseConfigurationV2025R0> {
+    const optionals: GetEnterpriseConfigurationByIdV2025R0Optionals =
+      new GetEnterpriseConfigurationByIdV2025R0Optionals({
+        headers: optionalsInput.headers,
+        cancellationToken: optionalsInput.cancellationToken,
+      });
+    const headers: any = optionals.headers;
+    const cancellationToken: any = optionals.cancellationToken;
+    const queryParamsMap: {
+      readonly [key: string]: string;
+    } = prepareParams({
+      ['categories']: toString(queryParams.categories) as string,
+    });
+    const headersMap: {
+      readonly [key: string]: string;
+    } = prepareParams({
+      ...{ ['box-version']: toString(headers.boxVersion) as string },
+      ...headers.extraHeaders,
+    });
+    const response: FetchResponse =
+      await this.networkSession.networkClient.fetch(
+        new FetchOptions({
+          url: ''.concat(
+            this.networkSession.baseUrls.baseUrl,
+            '/2.0/enterprise_configurations/',
+            toString(enterpriseId) as string,
+          ) as string,
+          method: 'GET',
+          params: queryParamsMap,
+          headers: headersMap,
+          responseFormat: 'json' as ResponseFormat,
+          auth: this.auth,
+          networkSession: this.networkSession,
+          cancellationToken: cancellationToken,
+        }),
+      );
+    return {
+      ...deserializeEnterpriseConfigurationV2025R0(response.data!),
+      rawData: response.data!,
+    };
+  }
+}
+export interface EnterpriseConfigurationsManagerInput {
+  readonly auth?: Authentication;
+  readonly networkSession?: NetworkSession;
+}

src/managers/enterpriseConfigurations.ts

@@ -72,6 +72,7 @@ export * from './ai';
 export * from './aiStudio';
 export * from './docgenTemplate';
 export * from './docgen';
+export * from './enterpriseConfigurations';
 export * from './hubs';
 export * from './hubCollaborations';
 export * from './hubItems';