@compassdigital/sdk.typescript 4.861.0 → 4.863.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@compassdigital/sdk.typescript",
3
- "version": "4.861.0",
3
+ "version": "4.863.0",
4
4
  "description": "Compass Digital Labs TypeScript SDK",
5
5
  "type": "commonjs",
6
6
  "main": "./lib/index.js",
package/src/index.ts CHANGED
@@ -378,6 +378,9 @@ import {
378
378
 
379
379
  import {
380
380
  GetConfigAppconfigResponse,
381
+ GetConfigAppClientsResponse,
382
+ PutConfigAppClientsBody,
383
+ PutConfigAppClientsResponse,
381
384
  GetConfigResponse,
382
385
  PostConfigBody,
383
386
  PostConfigResponse,
@@ -5326,6 +5329,42 @@ export class ServiceClient extends BaseServiceClient {
5326
5329
  );
5327
5330
  }
5328
5331
 
5332
+ /**
5333
+ * GET /config/app-clients - Get the per-client exclusive access settings
5334
+ *
5335
+ * @param options - additional request options
5336
+ */
5337
+ get_config_app_clients(options?: RequestOptions): ResponsePromise<GetConfigAppClientsResponse> {
5338
+ return this.request(
5339
+ 'config',
5340
+ '/config/app-clients',
5341
+ 'GET',
5342
+ `/config/app-clients`,
5343
+ null,
5344
+ options,
5345
+ );
5346
+ }
5347
+
5348
+ /**
5349
+ * PUT /config/app-clients - Replace the per-client exclusive access settings
5350
+ *
5351
+ * @param body
5352
+ * @param options - additional request options
5353
+ */
5354
+ put_config_app_clients(
5355
+ body: PutConfigAppClientsBody,
5356
+ options?: RequestOptions,
5357
+ ): ResponsePromise<PutConfigAppClientsResponse> {
5358
+ return this.request(
5359
+ 'config',
5360
+ '/config/app-clients',
5361
+ 'PUT',
5362
+ `/config/app-clients`,
5363
+ body,
5364
+ options,
5365
+ );
5366
+ }
5367
+
5329
5368
  /**
5330
5369
  * GET /config/{key} - get a configuration
5331
5370
  *
@@ -9,6 +9,19 @@ export interface Config {
9
9
  [index: string]: any;
10
10
  }
11
11
 
12
+ export interface AppClientsConfig {
13
+ [index: string]: AppClientSettings;
14
+ }
15
+
16
+ export interface AppClientSettings {
17
+ // Whether the client's sites are hidden from users not affiliated with the client.
18
+ exclusive_access?: boolean;
19
+ // Whether the client uses the aggregate site view.
20
+ aggregate_view?: boolean;
21
+ // Code a user redeems to become affiliated with the client. Lowercase letters and digits, at least five characters; `PUT /config/app-clients` rejects any other value. The rule is enforced in that handler, not as a `pattern` here, because responses are validated against this schema and rows written through the generic route were never checked.
22
+ access_code?: string;
23
+ }
24
+
12
25
  export interface Error {
13
26
  error?: string;
14
27
  code?: number;
@@ -693,6 +706,22 @@ export type GetConfigAppconfigResponse = AppConfig;
693
706
 
694
707
  export interface GetConfigAppconfigRequest extends BaseRequest {}
695
708
 
709
+ // GET /config/app-clients - Get the per-client exclusive access settings
710
+
711
+ export type GetConfigAppClientsResponse = AppClientsConfig;
712
+
713
+ export interface GetConfigAppClientsRequest extends BaseRequest {}
714
+
715
+ // PUT /config/app-clients - Replace the per-client exclusive access settings
716
+
717
+ export type PutConfigAppClientsBody = AppClientsConfig;
718
+
719
+ export type PutConfigAppClientsResponse = AppClientsConfig;
720
+
721
+ export interface PutConfigAppClientsRequest extends BaseRequest {
722
+ body: PutConfigAppClientsBody;
723
+ }
724
+
696
725
  // GET /config/{key} - get a configuration
697
726
 
698
727
  export interface GetConfigPath {
@@ -458,6 +458,7 @@ export interface Items {
458
458
 
459
459
  export interface PatchMenu {
460
460
  id?: string;
461
+ location_brand?: string;
461
462
  meta?: {
462
463
  // User ID
463
464
  locked_by_user?: string;