@caraer/client 2.0.570 → 2.0.571

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.
Files changed (10) hide show
  1. package/api.ts +6 -4
  2. package/dist/api.d.ts +6 -4
  3. package/dist/api.js +2 -0
  4. package/dist/esm/api.d.ts +6 -4
  5. package/dist/esm/api.js +2 -0
  6. package/docs/AppDTO.md +1 -1
  7. package/docs/AppSettingFieldSchema.md +2 -2
  8. package/docs/ExistingWidgetSummary.md +2 -2
  9. package/docs/SettingField.md +2 -2
  10. package/package.json +1 -1
package/api.ts CHANGED
@@ -539,7 +539,7 @@ export interface AppDTO {
539
539
  */
540
540
  'resolvedRequiredScopes'?: Array<string>;
541
541
  /**
542
- * Authentication method for this app (API_KEY default, OAUTH2 for OAuth 2.0)
542
+ * App credentials: NONE for platform-managed installation tokens, API_KEY (legacy default), or OAUTH2
543
543
  */
544
544
  'authMethod'?: AppDTOAuthMethodEnum;
545
545
  /**
@@ -609,6 +609,7 @@ export interface AppDTO {
609
609
  }
610
610
 
611
611
  export const AppDTOAuthMethodEnum = {
612
+ None: 'NONE',
612
613
  ApiKey: 'API_KEY',
613
614
  Oauth2: 'OAUTH2',
614
615
  } as const;
@@ -996,8 +997,8 @@ export interface AppSettingFieldSchema {
996
997
  'hasValue'?: boolean;
997
998
  'mappingValue'?: AppSettingFieldMappingStructure;
998
999
  'valueScope'?: string;
999
- 'action'?: boolean;
1000
1000
  'settingsGroup'?: boolean;
1001
+ 'action'?: boolean;
1001
1002
  'filterPropertyTypes'?: Array<string>;
1002
1003
  'filterPropertyFormats'?: Array<string>;
1003
1004
  }
@@ -1784,6 +1785,7 @@ export interface CreatePrivateAppRequest {
1784
1785
  }
1785
1786
 
1786
1787
  export const CreatePrivateAppRequestAuthMethodEnum = {
1788
+ None: 'NONE',
1787
1789
  ApiKey: 'API_KEY',
1788
1790
  Oauth2: 'OAUTH2',
1789
1791
  } as const;
@@ -2603,8 +2605,8 @@ export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof t
2603
2605
 
2604
2606
  export interface ExistingWidgetSummary {
2605
2607
  'ymetric'?: string;
2606
- 'xproperty'?: string;
2607
2608
  'yproperty'?: string;
2609
+ 'xproperty'?: string;
2608
2610
  'title'?: string;
2609
2611
  'chartType'?: string;
2610
2612
  'xProperty'?: string;
@@ -5787,8 +5789,8 @@ export interface SettingField {
5787
5789
  'hidden'?: boolean;
5788
5790
  'disabled'?: boolean;
5789
5791
  'options'?: Array<SettingOption>;
5790
- 'value'?: any;
5791
5792
  'defaultValue'?: any;
5793
+ 'value'?: any;
5792
5794
  }
5793
5795
 
5794
5796
  export const SettingFieldTypeEnum = {
package/dist/api.d.ts CHANGED
@@ -532,7 +532,7 @@ export interface AppDTO {
532
532
  */
533
533
  'resolvedRequiredScopes'?: Array<string>;
534
534
  /**
535
- * Authentication method for this app (API_KEY default, OAUTH2 for OAuth 2.0)
535
+ * App credentials: NONE for platform-managed installation tokens, API_KEY (legacy default), or OAUTH2
536
536
  */
537
537
  'authMethod'?: AppDTOAuthMethodEnum;
538
538
  /**
@@ -601,6 +601,7 @@ export interface AppDTO {
601
601
  'runtimeGeneration'?: number;
602
602
  }
603
603
  export declare const AppDTOAuthMethodEnum: {
604
+ readonly None: "NONE";
604
605
  readonly ApiKey: "API_KEY";
605
606
  readonly Oauth2: "OAUTH2";
606
607
  };
@@ -986,8 +987,8 @@ export interface AppSettingFieldSchema {
986
987
  'hasValue'?: boolean;
987
988
  'mappingValue'?: AppSettingFieldMappingStructure;
988
989
  'valueScope'?: string;
989
- 'action'?: boolean;
990
990
  'settingsGroup'?: boolean;
991
+ 'action'?: boolean;
991
992
  'filterPropertyTypes'?: Array<string>;
992
993
  'filterPropertyFormats'?: Array<string>;
993
994
  }
@@ -1778,6 +1779,7 @@ export interface CreatePrivateAppRequest {
1778
1779
  'runtime'?: string;
1779
1780
  }
1780
1781
  export declare const CreatePrivateAppRequestAuthMethodEnum: {
1782
+ readonly None: "NONE";
1781
1783
  readonly ApiKey: "API_KEY";
1782
1784
  readonly Oauth2: "OAUTH2";
1783
1785
  };
@@ -2590,8 +2592,8 @@ export declare const EventRsvpRequestScopeEnum: {
2590
2592
  export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof typeof EventRsvpRequestScopeEnum];
2591
2593
  export interface ExistingWidgetSummary {
2592
2594
  'ymetric'?: string;
2593
- 'xproperty'?: string;
2594
2595
  'yproperty'?: string;
2596
+ 'xproperty'?: string;
2595
2597
  'title'?: string;
2596
2598
  'chartType'?: string;
2597
2599
  'xProperty'?: string;
@@ -5836,8 +5838,8 @@ export interface SettingField {
5836
5838
  'hidden'?: boolean;
5837
5839
  'disabled'?: boolean;
5838
5840
  'options'?: Array<SettingOption>;
5839
- 'value'?: any;
5840
5841
  'defaultValue'?: any;
5842
+ 'value'?: any;
5841
5843
  }
5842
5844
  export declare const SettingFieldTypeEnum: {
5843
5845
  readonly String: "STRING";
package/dist/api.js CHANGED
@@ -57,6 +57,7 @@ exports.AppBarDTOLocationEnum = {
57
57
  RecordTrait: 'RECORD_TRAIT',
58
58
  };
59
59
  exports.AppDTOAuthMethodEnum = {
60
+ None: 'NONE',
60
61
  ApiKey: 'API_KEY',
61
62
  Oauth2: 'OAUTH2',
62
63
  };
@@ -82,6 +83,7 @@ exports.CreateCompanyRequestCmsVersionEnum = {
82
83
  NUMBER_2: 2,
83
84
  };
84
85
  exports.CreatePrivateAppRequestAuthMethodEnum = {
86
+ None: 'NONE',
85
87
  ApiKey: 'API_KEY',
86
88
  Oauth2: 'OAUTH2',
87
89
  };
package/dist/esm/api.d.ts CHANGED
@@ -532,7 +532,7 @@ export interface AppDTO {
532
532
  */
533
533
  'resolvedRequiredScopes'?: Array<string>;
534
534
  /**
535
- * Authentication method for this app (API_KEY default, OAUTH2 for OAuth 2.0)
535
+ * App credentials: NONE for platform-managed installation tokens, API_KEY (legacy default), or OAUTH2
536
536
  */
537
537
  'authMethod'?: AppDTOAuthMethodEnum;
538
538
  /**
@@ -601,6 +601,7 @@ export interface AppDTO {
601
601
  'runtimeGeneration'?: number;
602
602
  }
603
603
  export declare const AppDTOAuthMethodEnum: {
604
+ readonly None: "NONE";
604
605
  readonly ApiKey: "API_KEY";
605
606
  readonly Oauth2: "OAUTH2";
606
607
  };
@@ -986,8 +987,8 @@ export interface AppSettingFieldSchema {
986
987
  'hasValue'?: boolean;
987
988
  'mappingValue'?: AppSettingFieldMappingStructure;
988
989
  'valueScope'?: string;
989
- 'action'?: boolean;
990
990
  'settingsGroup'?: boolean;
991
+ 'action'?: boolean;
991
992
  'filterPropertyTypes'?: Array<string>;
992
993
  'filterPropertyFormats'?: Array<string>;
993
994
  }
@@ -1778,6 +1779,7 @@ export interface CreatePrivateAppRequest {
1778
1779
  'runtime'?: string;
1779
1780
  }
1780
1781
  export declare const CreatePrivateAppRequestAuthMethodEnum: {
1782
+ readonly None: "NONE";
1781
1783
  readonly ApiKey: "API_KEY";
1782
1784
  readonly Oauth2: "OAUTH2";
1783
1785
  };
@@ -2590,8 +2592,8 @@ export declare const EventRsvpRequestScopeEnum: {
2590
2592
  export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof typeof EventRsvpRequestScopeEnum];
2591
2593
  export interface ExistingWidgetSummary {
2592
2594
  'ymetric'?: string;
2593
- 'xproperty'?: string;
2594
2595
  'yproperty'?: string;
2596
+ 'xproperty'?: string;
2595
2597
  'title'?: string;
2596
2598
  'chartType'?: string;
2597
2599
  'xProperty'?: string;
@@ -5836,8 +5838,8 @@ export interface SettingField {
5836
5838
  'hidden'?: boolean;
5837
5839
  'disabled'?: boolean;
5838
5840
  'options'?: Array<SettingOption>;
5839
- 'value'?: any;
5840
5841
  'defaultValue'?: any;
5842
+ 'value'?: any;
5841
5843
  }
5842
5844
  export declare const SettingFieldTypeEnum: {
5843
5845
  readonly String: "STRING";
package/dist/esm/api.js CHANGED
@@ -51,6 +51,7 @@ export const AppBarDTOLocationEnum = {
51
51
  RecordTrait: 'RECORD_TRAIT',
52
52
  };
53
53
  export const AppDTOAuthMethodEnum = {
54
+ None: 'NONE',
54
55
  ApiKey: 'API_KEY',
55
56
  Oauth2: 'OAUTH2',
56
57
  };
@@ -76,6 +77,7 @@ export const CreateCompanyRequestCmsVersionEnum = {
76
77
  NUMBER_2: 2,
77
78
  };
78
79
  export const CreatePrivateAppRequestAuthMethodEnum = {
80
+ None: 'NONE',
79
81
  ApiKey: 'API_KEY',
80
82
  Oauth2: 'OAUTH2',
81
83
  };
package/docs/AppDTO.md CHANGED
@@ -38,7 +38,7 @@ Name | Type | Description | Notes
38
38
  **installed** | **boolean** | Whether the app is installed for the current company | [optional] [default to undefined]
39
39
  **requiredScopes** | **Array&lt;string&gt;** | Required scopes requested by the app (macro patterns or concrete scope strings). | [optional] [default to undefined]
40
40
  **resolvedRequiredScopes** | **Array&lt;string&gt;** | Resolved concrete required scopes derived from requiredScopes and dynamic availableScopes. | [optional] [default to undefined]
41
- **authMethod** | **string** | Authentication method for this app (API_KEY default, OAUTH2 for OAuth 2.0) | [optional] [default to undefined]
41
+ **authMethod** | **string** | App credentials: NONE for platform-managed installation tokens, API_KEY (legacy default), or OAUTH2 | [optional] [default to undefined]
42
42
  **oauthClientId** | **string** | OAuth 2.0 client identifier (OAuth apps only) | [optional] [default to undefined]
43
43
  **oauthClientSecret** | **string** | OAuth 2.0 client secret; only returned once on create or secret rotation | [optional] [default to undefined]
44
44
  **oauthClientSecretConfigured** | **boolean** | Whether an OAuth client secret is stored for this app (plain value is not re-readable) | [optional] [default to undefined]
package/docs/AppSettingFieldSchema.md CHANGED
@@ -30,8 +30,8 @@ Name | Type | Description | Notes
30
30
  **hasValue** | **boolean** | | [optional] [default to undefined]
31
31
  **mappingValue** | [**AppSettingFieldMappingStructure**](AppSettingFieldMappingStructure.md) | | [optional] [default to undefined]
32
32
  **valueScope** | **string** | | [optional] [default to undefined]
33
- **action** | **boolean** | | [optional] [default to undefined]
34
33
  **settingsGroup** | **boolean** | | [optional] [default to undefined]
34
+ **action** | **boolean** | | [optional] [default to undefined]
35
35
  **filterPropertyTypes** | **Array&lt;string&gt;** | | [optional] [default to undefined]
36
36
  **filterPropertyFormats** | **Array&lt;string&gt;** | | [optional] [default to undefined]
37
37
 
@@ -66,8 +66,8 @@ const instance: AppSettingFieldSchema = {
66
66
  hasValue,
67
67
  mappingValue,
68
68
  valueScope,
69
- action,
70
69
  settingsGroup,
70
+ action,
71
71
  filterPropertyTypes,
72
72
  filterPropertyFormats,
73
73
  };
package/docs/ExistingWidgetSummary.md CHANGED
@@ -6,8 +6,8 @@
6
6
  Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
8
  **ymetric** | **string** | | [optional] [default to undefined]
9
- **xproperty** | **string** | | [optional] [default to undefined]
10
9
  **yproperty** | **string** | | [optional] [default to undefined]
10
+ **xproperty** | **string** | | [optional] [default to undefined]
11
11
  **title** | **string** | | [optional] [default to undefined]
12
12
  **chartType** | **string** | | [optional] [default to undefined]
13
13
  **xProperty** | **string** | | [optional] [default to undefined]
@@ -21,8 +21,8 @@ import { ExistingWidgetSummary } from '@caraer/client';
21
21
 
22
22
  const instance: ExistingWidgetSummary = {
23
23
  ymetric,
24
- xproperty,
25
24
  yproperty,
25
+ xproperty,
26
26
  title,
27
27
  chartType,
28
28
  xProperty,
package/docs/SettingField.md CHANGED
@@ -14,8 +14,8 @@ Name | Type | Description | Notes
14
14
  **hidden** | **boolean** | | [optional] [default to undefined]
15
15
  **disabled** | **boolean** | | [optional] [default to undefined]
16
16
  **_options** | [**Array&lt;SettingOption&gt;**](SettingOption.md) | | [optional] [default to undefined]
17
- **value** | **any** | | [optional] [default to undefined]
18
17
  **defaultValue** | **any** | | [optional] [default to undefined]
18
+ **value** | **any** | | [optional] [default to undefined]
19
19
 
20
20
  ## Example
21
21
 
@@ -32,8 +32,8 @@ const instance: SettingField = {
32
32
  hidden,
33
33
  disabled,
34
34
  _options,
35
- value,
36
35
  defaultValue,
36
+ value,
37
37
  };
38
38
  ```
39
39
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@caraer/client",
3
- "version": "2.0.570",
3
+ "version": "2.0.571",
4
4
  "description": "Generated TypeScript client for the Caraer API",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {