@caraer/client 2.0.573 → 2.0.575

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/api.ts CHANGED
@@ -1747,33 +1747,205 @@ export interface CreateOrUpdateEnvironmentRequest {
1747
1747
  'webpageObjects'?: Array<CaraerObjectDTO>;
1748
1748
  }
1749
1749
  /**
1750
- * Private app creation request with label and optional description
1750
+ * Private app creator manifest; label is required and internal name is optional
1751
1751
  */
1752
1752
  export interface CreatePrivateAppRequest {
1753
1753
  /**
1754
- * The display label for the private app.
1754
+ * Unique identifier for the entity
1755
+ */
1756
+ 'uuid': string;
1757
+ /**
1758
+ * The name of the entity
1759
+ */
1760
+ 'name': string;
1761
+ /**
1762
+ * Display label for the entity, can be different from name
1755
1763
  */
1756
1764
  'label': string;
1757
1765
  /**
1758
- * Optional description text for the app.
1766
+ * Unix timestamp when the entity was created
1759
1767
  */
1760
- 'description'?: string;
1768
+ 'createdAt'?: number;
1769
+ /**
1770
+ * Identifier of the user who created the entity
1771
+ */
1772
+ 'createdBy'?: ModelRecord;
1773
+ /**
1774
+ * Unix timestamp when the entity was last updated
1775
+ */
1776
+ 'updatedAt'?: number;
1777
+ /**
1778
+ * Identifier of the user who last updated the entity
1779
+ */
1780
+ 'updatedBy'?: ModelRecord;
1781
+ /**
1782
+ * Unix timestamp when the entity was deleted (null if not deleted)
1783
+ */
1784
+ 'deletedAt'?: number;
1785
+ /**
1786
+ * Identifier of the user who deleted the entity
1787
+ */
1788
+ 'deletedBy'?: ModelRecord;
1789
+ /**
1790
+ * Index number for ordering entities
1791
+ */
1792
+ 'index'?: number;
1793
+ /**
1794
+ * Indicates whether this app is private (only available to the creator\'s company)
1795
+ */
1796
+ 'privateApp'?: boolean;
1797
+ /**
1798
+ * Whether to hide the API token field in marketplace installer UI. Defaults to true when omitted. Private apps show the key regardless.
1799
+ */
1800
+ 'hideApiKeyField'?: boolean;
1801
+ /**
1802
+ * Additional details and specifications about the application
1803
+ */
1804
+ 'details'?: AppDetailsDTO;
1805
+ /**
1806
+ * App bars (location-specific configuration and actions)
1807
+ */
1808
+ 'appBars'?: Array<AppBarDTO>;
1809
+ /**
1810
+ * Serverless functions owned by this app
1811
+ */
1812
+ 'serverlessFunctions'?: Array<ServerlessFunctionDTO>;
1813
+ /**
1814
+ * Webhook triggered when the app is installed
1815
+ */
1816
+ 'installWebhook'?: SubscribeWebhookDTO;
1817
+ /**
1818
+ * Webhook triggered when the app is uninstalled
1819
+ */
1820
+ 'uninstallWebhook'?: SubscribeWebhookDTO;
1821
+ /**
1822
+ * Webhook triggered when the app installation token is rotated
1823
+ */
1824
+ 'rotateWebhook'?: SubscribeWebhookDTO;
1825
+ /**
1826
+ * Webhook triggered when an already installed app is saved again
1827
+ */
1828
+ 'updateWebhook'?: SubscribeWebhookDTO;
1829
+ /**
1830
+ * JSON array of AppSettingFieldSchema (app-level setting field definitions)
1831
+ */
1832
+ 'settingsSchema'?: Array<AppSettingFieldSchema>;
1833
+ /**
1834
+ * Optional UI grouping of settingsSchema fields into installer cards
1835
+ */
1836
+ 'settingsSections'?: Array<AppSettingsSection>;
1837
+ /**
1838
+ * External OAuth providers installers can Connect (name/logo only; no secrets)
1839
+ */
1840
+ 'externalOAuthProviders'?: Array<AppExternalOAuthProviderSummaryDTO>;
1841
+ /**
1842
+ * Webhook rate limit per minute
1843
+ */
1844
+ 'webhookRateLimitPerMinute'?: number;
1845
+ /**
1846
+ * App job enqueue rate limit per minute per installation
1847
+ */
1848
+ 'jobRateLimitPerMinute'?: number;
1849
+ /**
1850
+ * Publish and review state for the app in the marketplace (creator view)
1851
+ */
1852
+ 'appPublish'?: AppPublishDTO;
1853
+ /**
1854
+ * Installation link (company–app) with token, scopes, and per-installation settingsValues; present when includeSettings is true
1855
+ */
1856
+ 'hasApp'?: HasAppDTO;
1857
+ /**
1858
+ * URL to the application\'s image or icon (derived from details.image)
1859
+ */
1860
+ 'image'?: string;
1861
+ /**
1862
+ * URL where the application can be accessed (derived from details.url)
1863
+ */
1864
+ 'url'?: string;
1865
+ /**
1866
+ * Category the application belongs to (derived from details.category)
1867
+ */
1868
+ 'category'?: string;
1869
+ /**
1870
+ * Whether the app is installed for the current company
1871
+ */
1872
+ 'installed'?: boolean;
1761
1873
  /**
1762
- * Authentication method (API_KEY default, OAUTH2 for OAuth 2.0)
1874
+ * Required scopes requested by the app (macro patterns or concrete scope strings).
1875
+ */
1876
+ 'requiredScopes'?: Array<string>;
1877
+ /**
1878
+ * Resolved concrete required scopes derived from requiredScopes and dynamic availableScopes.
1879
+ */
1880
+ 'resolvedRequiredScopes'?: Array<string>;
1881
+ /**
1882
+ * App credentials: NONE for platform-managed installation tokens, API_KEY (legacy default), or OAUTH2
1763
1883
  */
1764
1884
  'authMethod'?: CreatePrivateAppRequestAuthMethodEnum;
1765
1885
  /**
1766
- * Registered OAuth redirect URIs (required when authMethod is OAUTH2)
1886
+ * OAuth 2.0 client identifier (OAuth apps only)
1887
+ */
1888
+ 'oauthClientId'?: string;
1889
+ /**
1890
+ * OAuth 2.0 client secret; only returned once on create or secret rotation
1891
+ */
1892
+ 'oauthClientSecret'?: string;
1893
+ /**
1894
+ * Whether an OAuth client secret is stored for this app (plain value is not re-readable)
1895
+ */
1896
+ 'oauthClientSecretConfigured'?: boolean;
1897
+ /**
1898
+ * Registered OAuth redirect URIs (OAuth apps only)
1767
1899
  */
1768
1900
  'oauthRedirectUris'?: Array<string>;
1769
1901
  /**
1770
- * Ignored; new private apps are always platform version 2 (async container runtime).
1902
+ * OAuth authorization endpoint URL
1903
+ */
1904
+ 'oauthAuthorizeUrl'?: string;
1905
+ /**
1906
+ * OAuth token endpoint URL
1907
+ */
1908
+ 'oauthTokenUrl'?: string;
1909
+ /**
1910
+ * External URL where end users install this app (e.g. ChatGPT connector page)
1911
+ */
1912
+ 'installUrl'?: string;
1913
+ /**
1914
+ * Square brandmark URL used in compact app surfaces
1915
+ */
1916
+ 'brandmark'?: string;
1917
+ /**
1918
+ * Internal app description used in Caraer admin views
1919
+ */
1920
+ 'description'?: string;
1921
+ /**
1922
+ * App platform version: 1 = legacy per-function Cloud Functions; 2 = one container per app
1771
1923
  */
1772
1924
  'platformVersion'?: number;
1773
1925
  /**
1774
- * Serverless runtime for the app: nodejs22 or python312. Defaults to nodejs22.
1926
+ * Serverless runtime for platform V2 apps (nodejs22 or python312)
1775
1927
  */
1776
1928
  'runtime'?: string;
1929
+ /**
1930
+ * Base HTTPS URL of the V2 app container runtime
1931
+ */
1932
+ 'runtimeBaseUrl'?: string;
1933
+ /**
1934
+ * Last deployed runtime revision id
1935
+ */
1936
+ 'runtimeRevision'?: string;
1937
+ /**
1938
+ * V2 runtime status: PENDING, PROVISIONING, READY, FAILED
1939
+ */
1940
+ 'runtimeStatus'?: string;
1941
+ /**
1942
+ * Last V2 runtime error message when FAILED
1943
+ */
1944
+ 'runtimeError'?: string;
1945
+ /**
1946
+ * Monotonic generation for async runtime jobs
1947
+ */
1948
+ 'runtimeGeneration'?: number;
1777
1949
  }
1778
1950
 
1779
1951
  export const CreatePrivateAppRequestAuthMethodEnum = {
@@ -2596,9 +2768,9 @@ export const EventRsvpRequestScopeEnum = {
2596
2768
  export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof typeof EventRsvpRequestScopeEnum];
2597
2769
 
2598
2770
  export interface ExistingWidgetSummary {
2599
- 'xproperty'?: string;
2600
- 'ymetric'?: string;
2601
2771
  'yproperty'?: string;
2772
+ 'ymetric'?: string;
2773
+ 'xproperty'?: string;
2602
2774
  'title'?: string;
2603
2775
  'chartType'?: string;
2604
2776
  'xProperty'?: string;
@@ -5781,8 +5953,8 @@ export interface SettingField {
5781
5953
  'hidden'?: boolean;
5782
5954
  'disabled'?: boolean;
5783
5955
  'options'?: Array<SettingOption>;
5784
- 'defaultValue'?: any;
5785
5956
  'value'?: any;
5957
+ 'defaultValue'?: any;
5786
5958
  }
5787
5959
 
5788
5960
  export const SettingFieldTypeEnum = {
@@ -10165,7 +10337,7 @@ export const ApplicationsApiAxiosParamCreator = function (configuration?: Config
10165
10337
  };
10166
10338
  },
10167
10339
  /**
10168
- * Creates a new private app with the provided label and optional description. Private apps are automatically installed for the creating user\'s company. Returns the created app details as a CreateResponse wrapping an AppDTO.
10340
+ * Creates a private app from its creator manifest, validating the supplied name, settings and app bars before saving. An omitted name is generated. Private apps are automatically installed for the creating user\'s company. Returns the created app details as a CreateResponse wrapping an AppDTO.
10169
10341
  * @summary Create a private app
10170
10342
  * @param {CreatePrivateAppRequest} createPrivateAppRequest
10171
10343
  * @param {*} [options] Override http request option.
@@ -11433,7 +11605,7 @@ export const ApplicationsApiFp = function(configuration?: Configuration) {
11433
11605
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11434
11606
  },
11435
11607
  /**
11436
- * Creates a new private app with the provided label and optional description. Private apps are automatically installed for the creating user\'s company. Returns the created app details as a CreateResponse wrapping an AppDTO.
11608
+ * Creates a private app from its creator manifest, validating the supplied name, settings and app bars before saving. An omitted name is generated. Private apps are automatically installed for the creating user\'s company. Returns the created app details as a CreateResponse wrapping an AppDTO.
11437
11609
  * @summary Create a private app
11438
11610
  * @param {CreatePrivateAppRequest} createPrivateAppRequest
11439
11611
  * @param {*} [options] Override http request option.
@@ -11865,7 +12037,7 @@ export const ApplicationsApiFactory = function (configuration?: Configuration, b
11865
12037
  return localVarFp.createAppWebhookForApp(appUuid, subscribeWebhookDTO, options).then((request) => request(axios, basePath));
11866
12038
  },
11867
12039
  /**
11868
- * Creates a new private app with the provided label and optional description. Private apps are automatically installed for the creating user\'s company. Returns the created app details as a CreateResponse wrapping an AppDTO.
12040
+ * Creates a private app from its creator manifest, validating the supplied name, settings and app bars before saving. An omitted name is generated. Private apps are automatically installed for the creating user\'s company. Returns the created app details as a CreateResponse wrapping an AppDTO.
11869
12041
  * @summary Create a private app
11870
12042
  * @param {CreatePrivateAppRequest} createPrivateAppRequest
11871
12043
  * @param {*} [options] Override http request option.
@@ -12206,7 +12378,7 @@ export class ApplicationsApi extends BaseAPI {
12206
12378
  }
12207
12379
 
12208
12380
  /**
12209
- * Creates a new private app with the provided label and optional description. Private apps are automatically installed for the creating user\'s company. Returns the created app details as a CreateResponse wrapping an AppDTO.
12381
+ * Creates a private app from its creator manifest, validating the supplied name, settings and app bars before saving. An omitted name is generated. Private apps are automatically installed for the creating user\'s company. Returns the created app details as a CreateResponse wrapping an AppDTO.
12210
12382
  * @summary Create a private app
12211
12383
  * @param {CreatePrivateAppRequest} createPrivateAppRequest
12212
12384
  * @param {*} [options] Override http request option.
package/dist/api.d.ts CHANGED
@@ -1745,33 +1745,205 @@ export interface CreateOrUpdateEnvironmentRequest {
1745
1745
  'webpageObjects'?: Array<CaraerObjectDTO>;
1746
1746
  }
1747
1747
  /**
1748
- * Private app creation request with label and optional description
1748
+ * Private app creator manifest; label is required and internal name is optional
1749
1749
  */
1750
1750
  export interface CreatePrivateAppRequest {
1751
1751
  /**
1752
- * The display label for the private app.
1752
+ * Unique identifier for the entity
1753
+ */
1754
+ 'uuid': string;
1755
+ /**
1756
+ * The name of the entity
1757
+ */
1758
+ 'name': string;
1759
+ /**
1760
+ * Display label for the entity, can be different from name
1753
1761
  */
1754
1762
  'label': string;
1755
1763
  /**
1756
- * Optional description text for the app.
1764
+ * Unix timestamp when the entity was created
1757
1765
  */
1758
- 'description'?: string;
1766
+ 'createdAt'?: number;
1767
+ /**
1768
+ * Identifier of the user who created the entity
1769
+ */
1770
+ 'createdBy'?: ModelRecord;
1771
+ /**
1772
+ * Unix timestamp when the entity was last updated
1773
+ */
1774
+ 'updatedAt'?: number;
1775
+ /**
1776
+ * Identifier of the user who last updated the entity
1777
+ */
1778
+ 'updatedBy'?: ModelRecord;
1779
+ /**
1780
+ * Unix timestamp when the entity was deleted (null if not deleted)
1781
+ */
1782
+ 'deletedAt'?: number;
1783
+ /**
1784
+ * Identifier of the user who deleted the entity
1785
+ */
1786
+ 'deletedBy'?: ModelRecord;
1787
+ /**
1788
+ * Index number for ordering entities
1789
+ */
1790
+ 'index'?: number;
1791
+ /**
1792
+ * Indicates whether this app is private (only available to the creator\'s company)
1793
+ */
1794
+ 'privateApp'?: boolean;
1795
+ /**
1796
+ * Whether to hide the API token field in marketplace installer UI. Defaults to true when omitted. Private apps show the key regardless.
1797
+ */
1798
+ 'hideApiKeyField'?: boolean;
1799
+ /**
1800
+ * Additional details and specifications about the application
1801
+ */
1802
+ 'details'?: AppDetailsDTO;
1803
+ /**
1804
+ * App bars (location-specific configuration and actions)
1805
+ */
1806
+ 'appBars'?: Array<AppBarDTO>;
1807
+ /**
1808
+ * Serverless functions owned by this app
1809
+ */
1810
+ 'serverlessFunctions'?: Array<ServerlessFunctionDTO>;
1811
+ /**
1812
+ * Webhook triggered when the app is installed
1813
+ */
1814
+ 'installWebhook'?: SubscribeWebhookDTO;
1815
+ /**
1816
+ * Webhook triggered when the app is uninstalled
1817
+ */
1818
+ 'uninstallWebhook'?: SubscribeWebhookDTO;
1819
+ /**
1820
+ * Webhook triggered when the app installation token is rotated
1821
+ */
1822
+ 'rotateWebhook'?: SubscribeWebhookDTO;
1823
+ /**
1824
+ * Webhook triggered when an already installed app is saved again
1825
+ */
1826
+ 'updateWebhook'?: SubscribeWebhookDTO;
1827
+ /**
1828
+ * JSON array of AppSettingFieldSchema (app-level setting field definitions)
1829
+ */
1830
+ 'settingsSchema'?: Array<AppSettingFieldSchema>;
1831
+ /**
1832
+ * Optional UI grouping of settingsSchema fields into installer cards
1833
+ */
1834
+ 'settingsSections'?: Array<AppSettingsSection>;
1835
+ /**
1836
+ * External OAuth providers installers can Connect (name/logo only; no secrets)
1837
+ */
1838
+ 'externalOAuthProviders'?: Array<AppExternalOAuthProviderSummaryDTO>;
1839
+ /**
1840
+ * Webhook rate limit per minute
1841
+ */
1842
+ 'webhookRateLimitPerMinute'?: number;
1843
+ /**
1844
+ * App job enqueue rate limit per minute per installation
1845
+ */
1846
+ 'jobRateLimitPerMinute'?: number;
1847
+ /**
1848
+ * Publish and review state for the app in the marketplace (creator view)
1849
+ */
1850
+ 'appPublish'?: AppPublishDTO;
1851
+ /**
1852
+ * Installation link (company–app) with token, scopes, and per-installation settingsValues; present when includeSettings is true
1853
+ */
1854
+ 'hasApp'?: HasAppDTO;
1855
+ /**
1856
+ * URL to the application\'s image or icon (derived from details.image)
1857
+ */
1858
+ 'image'?: string;
1859
+ /**
1860
+ * URL where the application can be accessed (derived from details.url)
1861
+ */
1862
+ 'url'?: string;
1863
+ /**
1864
+ * Category the application belongs to (derived from details.category)
1865
+ */
1866
+ 'category'?: string;
1867
+ /**
1868
+ * Whether the app is installed for the current company
1869
+ */
1870
+ 'installed'?: boolean;
1759
1871
  /**
1760
- * Authentication method (API_KEY default, OAUTH2 for OAuth 2.0)
1872
+ * Required scopes requested by the app (macro patterns or concrete scope strings).
1873
+ */
1874
+ 'requiredScopes'?: Array<string>;
1875
+ /**
1876
+ * Resolved concrete required scopes derived from requiredScopes and dynamic availableScopes.
1877
+ */
1878
+ 'resolvedRequiredScopes'?: Array<string>;
1879
+ /**
1880
+ * App credentials: NONE for platform-managed installation tokens, API_KEY (legacy default), or OAUTH2
1761
1881
  */
1762
1882
  'authMethod'?: CreatePrivateAppRequestAuthMethodEnum;
1763
1883
  /**
1764
- * Registered OAuth redirect URIs (required when authMethod is OAUTH2)
1884
+ * OAuth 2.0 client identifier (OAuth apps only)
1885
+ */
1886
+ 'oauthClientId'?: string;
1887
+ /**
1888
+ * OAuth 2.0 client secret; only returned once on create or secret rotation
1889
+ */
1890
+ 'oauthClientSecret'?: string;
1891
+ /**
1892
+ * Whether an OAuth client secret is stored for this app (plain value is not re-readable)
1893
+ */
1894
+ 'oauthClientSecretConfigured'?: boolean;
1895
+ /**
1896
+ * Registered OAuth redirect URIs (OAuth apps only)
1765
1897
  */
1766
1898
  'oauthRedirectUris'?: Array<string>;
1767
1899
  /**
1768
- * Ignored; new private apps are always platform version 2 (async container runtime).
1900
+ * OAuth authorization endpoint URL
1901
+ */
1902
+ 'oauthAuthorizeUrl'?: string;
1903
+ /**
1904
+ * OAuth token endpoint URL
1905
+ */
1906
+ 'oauthTokenUrl'?: string;
1907
+ /**
1908
+ * External URL where end users install this app (e.g. ChatGPT connector page)
1909
+ */
1910
+ 'installUrl'?: string;
1911
+ /**
1912
+ * Square brandmark URL used in compact app surfaces
1913
+ */
1914
+ 'brandmark'?: string;
1915
+ /**
1916
+ * Internal app description used in Caraer admin views
1917
+ */
1918
+ 'description'?: string;
1919
+ /**
1920
+ * App platform version: 1 = legacy per-function Cloud Functions; 2 = one container per app
1769
1921
  */
1770
1922
  'platformVersion'?: number;
1771
1923
  /**
1772
- * Serverless runtime for the app: nodejs22 or python312. Defaults to nodejs22.
1924
+ * Serverless runtime for platform V2 apps (nodejs22 or python312)
1773
1925
  */
1774
1926
  'runtime'?: string;
1927
+ /**
1928
+ * Base HTTPS URL of the V2 app container runtime
1929
+ */
1930
+ 'runtimeBaseUrl'?: string;
1931
+ /**
1932
+ * Last deployed runtime revision id
1933
+ */
1934
+ 'runtimeRevision'?: string;
1935
+ /**
1936
+ * V2 runtime status: PENDING, PROVISIONING, READY, FAILED
1937
+ */
1938
+ 'runtimeStatus'?: string;
1939
+ /**
1940
+ * Last V2 runtime error message when FAILED
1941
+ */
1942
+ 'runtimeError'?: string;
1943
+ /**
1944
+ * Monotonic generation for async runtime jobs
1945
+ */
1946
+ 'runtimeGeneration'?: number;
1775
1947
  }
1776
1948
  export declare const CreatePrivateAppRequestAuthMethodEnum: {
1777
1949
  readonly None: "NONE";
@@ -2586,9 +2758,9 @@ export declare const EventRsvpRequestScopeEnum: {
2586
2758
  };
2587
2759
  export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof typeof EventRsvpRequestScopeEnum];
2588
2760
  export interface ExistingWidgetSummary {
2589
- 'xproperty'?: string;
2590
- 'ymetric'?: string;
2591
2761
  'yproperty'?: string;
2762
+ 'ymetric'?: string;
2763
+ 'xproperty'?: string;
2592
2764
  'title'?: string;
2593
2765
  'chartType'?: string;
2594
2766
  'xProperty'?: string;
@@ -5833,8 +6005,8 @@ export interface SettingField {
5833
6005
  'hidden'?: boolean;
5834
6006
  'disabled'?: boolean;
5835
6007
  'options'?: Array<SettingOption>;
5836
- 'defaultValue'?: any;
5837
6008
  'value'?: any;
6009
+ 'defaultValue'?: any;
5838
6010
  }
5839
6011
  export declare const SettingFieldTypeEnum: {
5840
6012
  readonly String: "STRING";
@@ -9326,7 +9498,7 @@ export declare const ApplicationsApiAxiosParamCreator: (configuration?: Configur
9326
9498
  */
9327
9499
  createAppWebhookForApp: (appUuid: string, subscribeWebhookDTO: SubscribeWebhookDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9328
9500
  /**
9329
- * Creates a new private app with the provided label and optional description. Private apps are automatically installed for the creating user\'s company. Returns the created app details as a CreateResponse wrapping an AppDTO.
9501
+ * Creates a private app from its creator manifest, validating the supplied name, settings and app bars before saving. An omitted name is generated. Private apps are automatically installed for the creating user\'s company. Returns the created app details as a CreateResponse wrapping an AppDTO.
9330
9502
  * @summary Create a private app
9331
9503
  * @param {CreatePrivateAppRequest} createPrivateAppRequest
9332
9504
  * @param {*} [options] Override http request option.
@@ -9602,7 +9774,7 @@ export declare const ApplicationsApiFp: (configuration?: Configuration) => {
9602
9774
  */
9603
9775
  createAppWebhookForApp(appUuid: string, subscribeWebhookDTO: SubscribeWebhookDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateResponse>>;
9604
9776
  /**
9605
- * Creates a new private app with the provided label and optional description. Private apps are automatically installed for the creating user\'s company. Returns the created app details as a CreateResponse wrapping an AppDTO.
9777
+ * Creates a private app from its creator manifest, validating the supplied name, settings and app bars before saving. An omitted name is generated. Private apps are automatically installed for the creating user\'s company. Returns the created app details as a CreateResponse wrapping an AppDTO.
9606
9778
  * @summary Create a private app
9607
9779
  * @param {CreatePrivateAppRequest} createPrivateAppRequest
9608
9780
  * @param {*} [options] Override http request option.
@@ -9886,7 +10058,7 @@ export declare const ApplicationsApiFactory: (configuration?: Configuration, bas
9886
10058
  */
9887
10059
  createAppWebhookForApp(appUuid: string, subscribeWebhookDTO: SubscribeWebhookDTO, options?: RawAxiosRequestConfig): AxiosPromise<CreateResponse>;
9888
10060
  /**
9889
- * Creates a new private app with the provided label and optional description. Private apps are automatically installed for the creating user\'s company. Returns the created app details as a CreateResponse wrapping an AppDTO.
10061
+ * Creates a private app from its creator manifest, validating the supplied name, settings and app bars before saving. An omitted name is generated. Private apps are automatically installed for the creating user\'s company. Returns the created app details as a CreateResponse wrapping an AppDTO.
9890
10062
  * @summary Create a private app
9891
10063
  * @param {CreatePrivateAppRequest} createPrivateAppRequest
9892
10064
  * @param {*} [options] Override http request option.
@@ -10170,7 +10342,7 @@ export declare class ApplicationsApi extends BaseAPI {
10170
10342
  */
10171
10343
  createAppWebhookForApp(appUuid: string, subscribeWebhookDTO: SubscribeWebhookDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateResponse, any, {}>>;
10172
10344
  /**
10173
- * Creates a new private app with the provided label and optional description. Private apps are automatically installed for the creating user\'s company. Returns the created app details as a CreateResponse wrapping an AppDTO.
10345
+ * Creates a private app from its creator manifest, validating the supplied name, settings and app bars before saving. An omitted name is generated. Private apps are automatically installed for the creating user\'s company. Returns the created app details as a CreateResponse wrapping an AppDTO.
10174
10346
  * @summary Create a private app
10175
10347
  * @param {CreatePrivateAppRequest} createPrivateAppRequest
10176
10348
  * @param {*} [options] Override http request option.
package/dist/api.js CHANGED
@@ -1899,7 +1899,7 @@ const ApplicationsApiAxiosParamCreator = function (configuration) {
1899
1899
  };
1900
1900
  }),
1901
1901
  /**
1902
- * Creates a new private app with the provided label and optional description. Private apps are automatically installed for the creating user\'s company. Returns the created app details as a CreateResponse wrapping an AppDTO.
1902
+ * Creates a private app from its creator manifest, validating the supplied name, settings and app bars before saving. An omitted name is generated. Private apps are automatically installed for the creating user\'s company. Returns the created app details as a CreateResponse wrapping an AppDTO.
1903
1903
  * @summary Create a private app
1904
1904
  * @param {CreatePrivateAppRequest} createPrivateAppRequest
1905
1905
  * @param {*} [options] Override http request option.
@@ -3014,7 +3014,7 @@ const ApplicationsApiFp = function (configuration) {
3014
3014
  });
3015
3015
  },
3016
3016
  /**
3017
- * Creates a new private app with the provided label and optional description. Private apps are automatically installed for the creating user\'s company. Returns the created app details as a CreateResponse wrapping an AppDTO.
3017
+ * Creates a private app from its creator manifest, validating the supplied name, settings and app bars before saving. An omitted name is generated. Private apps are automatically installed for the creating user\'s company. Returns the created app details as a CreateResponse wrapping an AppDTO.
3018
3018
  * @summary Create a private app
3019
3019
  * @param {CreatePrivateAppRequest} createPrivateAppRequest
3020
3020
  * @param {*} [options] Override http request option.
@@ -3536,7 +3536,7 @@ const ApplicationsApiFactory = function (configuration, basePath, axios) {
3536
3536
  return localVarFp.createAppWebhookForApp(appUuid, subscribeWebhookDTO, options).then((request) => request(axios, basePath));
3537
3537
  },
3538
3538
  /**
3539
- * Creates a new private app with the provided label and optional description. Private apps are automatically installed for the creating user\'s company. Returns the created app details as a CreateResponse wrapping an AppDTO.
3539
+ * Creates a private app from its creator manifest, validating the supplied name, settings and app bars before saving. An omitted name is generated. Private apps are automatically installed for the creating user\'s company. Returns the created app details as a CreateResponse wrapping an AppDTO.
3540
3540
  * @summary Create a private app
3541
3541
  * @param {CreatePrivateAppRequest} createPrivateAppRequest
3542
3542
  * @param {*} [options] Override http request option.
@@ -3876,7 +3876,7 @@ class ApplicationsApi extends base_1.BaseAPI {
3876
3876
  return (0, exports.ApplicationsApiFp)(this.configuration).createAppWebhookForApp(appUuid, subscribeWebhookDTO, options).then((request) => request(this.axios, this.basePath));
3877
3877
  }
3878
3878
  /**
3879
- * Creates a new private app with the provided label and optional description. Private apps are automatically installed for the creating user\'s company. Returns the created app details as a CreateResponse wrapping an AppDTO.
3879
+ * Creates a private app from its creator manifest, validating the supplied name, settings and app bars before saving. An omitted name is generated. Private apps are automatically installed for the creating user\'s company. Returns the created app details as a CreateResponse wrapping an AppDTO.
3880
3880
  * @summary Create a private app
3881
3881
  * @param {CreatePrivateAppRequest} createPrivateAppRequest
3882
3882
  * @param {*} [options] Override http request option.
package/dist/esm/api.d.ts CHANGED
@@ -1745,33 +1745,205 @@ export interface CreateOrUpdateEnvironmentRequest {
1745
1745
  'webpageObjects'?: Array<CaraerObjectDTO>;
1746
1746
  }
1747
1747
  /**
1748
- * Private app creation request with label and optional description
1748
+ * Private app creator manifest; label is required and internal name is optional
1749
1749
  */
1750
1750
  export interface CreatePrivateAppRequest {
1751
1751
  /**
1752
- * The display label for the private app.
1752
+ * Unique identifier for the entity
1753
+ */
1754
+ 'uuid': string;
1755
+ /**
1756
+ * The name of the entity
1757
+ */
1758
+ 'name': string;
1759
+ /**
1760
+ * Display label for the entity, can be different from name
1753
1761
  */
1754
1762
  'label': string;
1755
1763
  /**
1756
- * Optional description text for the app.
1764
+ * Unix timestamp when the entity was created
1757
1765
  */
1758
- 'description'?: string;
1766
+ 'createdAt'?: number;
1767
+ /**
1768
+ * Identifier of the user who created the entity
1769
+ */
1770
+ 'createdBy'?: ModelRecord;
1771
+ /**
1772
+ * Unix timestamp when the entity was last updated
1773
+ */
1774
+ 'updatedAt'?: number;
1775
+ /**
1776
+ * Identifier of the user who last updated the entity
1777
+ */
1778
+ 'updatedBy'?: ModelRecord;
1779
+ /**
1780
+ * Unix timestamp when the entity was deleted (null if not deleted)
1781
+ */
1782
+ 'deletedAt'?: number;
1783
+ /**
1784
+ * Identifier of the user who deleted the entity
1785
+ */
1786
+ 'deletedBy'?: ModelRecord;
1787
+ /**
1788
+ * Index number for ordering entities
1789
+ */
1790
+ 'index'?: number;
1791
+ /**
1792
+ * Indicates whether this app is private (only available to the creator\'s company)
1793
+ */
1794
+ 'privateApp'?: boolean;
1795
+ /**
1796
+ * Whether to hide the API token field in marketplace installer UI. Defaults to true when omitted. Private apps show the key regardless.
1797
+ */
1798
+ 'hideApiKeyField'?: boolean;
1799
+ /**
1800
+ * Additional details and specifications about the application
1801
+ */
1802
+ 'details'?: AppDetailsDTO;
1803
+ /**
1804
+ * App bars (location-specific configuration and actions)
1805
+ */
1806
+ 'appBars'?: Array<AppBarDTO>;
1807
+ /**
1808
+ * Serverless functions owned by this app
1809
+ */
1810
+ 'serverlessFunctions'?: Array<ServerlessFunctionDTO>;
1811
+ /**
1812
+ * Webhook triggered when the app is installed
1813
+ */
1814
+ 'installWebhook'?: SubscribeWebhookDTO;
1815
+ /**
1816
+ * Webhook triggered when the app is uninstalled
1817
+ */
1818
+ 'uninstallWebhook'?: SubscribeWebhookDTO;
1819
+ /**
1820
+ * Webhook triggered when the app installation token is rotated
1821
+ */
1822
+ 'rotateWebhook'?: SubscribeWebhookDTO;
1823
+ /**
1824
+ * Webhook triggered when an already installed app is saved again
1825
+ */
1826
+ 'updateWebhook'?: SubscribeWebhookDTO;
1827
+ /**
1828
+ * JSON array of AppSettingFieldSchema (app-level setting field definitions)
1829
+ */
1830
+ 'settingsSchema'?: Array<AppSettingFieldSchema>;
1831
+ /**
1832
+ * Optional UI grouping of settingsSchema fields into installer cards
1833
+ */
1834
+ 'settingsSections'?: Array<AppSettingsSection>;
1835
+ /**
1836
+ * External OAuth providers installers can Connect (name/logo only; no secrets)
1837
+ */
1838
+ 'externalOAuthProviders'?: Array<AppExternalOAuthProviderSummaryDTO>;
1839
+ /**
1840
+ * Webhook rate limit per minute
1841
+ */
1842
+ 'webhookRateLimitPerMinute'?: number;
1843
+ /**
1844
+ * App job enqueue rate limit per minute per installation
1845
+ */
1846
+ 'jobRateLimitPerMinute'?: number;
1847
+ /**
1848
+ * Publish and review state for the app in the marketplace (creator view)
1849
+ */
1850
+ 'appPublish'?: AppPublishDTO;
1851
+ /**
1852
+ * Installation link (company–app) with token, scopes, and per-installation settingsValues; present when includeSettings is true
1853
+ */
1854
+ 'hasApp'?: HasAppDTO;
1855
+ /**
1856
+ * URL to the application\'s image or icon (derived from details.image)
1857
+ */
1858
+ 'image'?: string;
1859
+ /**
1860
+ * URL where the application can be accessed (derived from details.url)
1861
+ */
1862
+ 'url'?: string;
1863
+ /**
1864
+ * Category the application belongs to (derived from details.category)
1865
+ */
1866
+ 'category'?: string;
1867
+ /**
1868
+ * Whether the app is installed for the current company
1869
+ */
1870
+ 'installed'?: boolean;
1759
1871
  /**
1760
- * Authentication method (API_KEY default, OAUTH2 for OAuth 2.0)
1872
+ * Required scopes requested by the app (macro patterns or concrete scope strings).
1873
+ */
1874
+ 'requiredScopes'?: Array<string>;
1875
+ /**
1876
+ * Resolved concrete required scopes derived from requiredScopes and dynamic availableScopes.
1877
+ */
1878
+ 'resolvedRequiredScopes'?: Array<string>;
1879
+ /**
1880
+ * App credentials: NONE for platform-managed installation tokens, API_KEY (legacy default), or OAUTH2
1761
1881
  */
1762
1882
  'authMethod'?: CreatePrivateAppRequestAuthMethodEnum;
1763
1883
  /**
1764
- * Registered OAuth redirect URIs (required when authMethod is OAUTH2)
1884
+ * OAuth 2.0 client identifier (OAuth apps only)
1885
+ */
1886
+ 'oauthClientId'?: string;
1887
+ /**
1888
+ * OAuth 2.0 client secret; only returned once on create or secret rotation
1889
+ */
1890
+ 'oauthClientSecret'?: string;
1891
+ /**
1892
+ * Whether an OAuth client secret is stored for this app (plain value is not re-readable)
1893
+ */
1894
+ 'oauthClientSecretConfigured'?: boolean;
1895
+ /**
1896
+ * Registered OAuth redirect URIs (OAuth apps only)
1765
1897
  */
1766
1898
  'oauthRedirectUris'?: Array<string>;
1767
1899
  /**
1768
- * Ignored; new private apps are always platform version 2 (async container runtime).
1900
+ * OAuth authorization endpoint URL
1901
+ */
1902
+ 'oauthAuthorizeUrl'?: string;
1903
+ /**
1904
+ * OAuth token endpoint URL
1905
+ */
1906
+ 'oauthTokenUrl'?: string;
1907
+ /**
1908
+ * External URL where end users install this app (e.g. ChatGPT connector page)
1909
+ */
1910
+ 'installUrl'?: string;
1911
+ /**
1912
+ * Square brandmark URL used in compact app surfaces
1913
+ */
1914
+ 'brandmark'?: string;
1915
+ /**
1916
+ * Internal app description used in Caraer admin views
1917
+ */
1918
+ 'description'?: string;
1919
+ /**
1920
+ * App platform version: 1 = legacy per-function Cloud Functions; 2 = one container per app
1769
1921
  */
1770
1922
  'platformVersion'?: number;
1771
1923
  /**
1772
- * Serverless runtime for the app: nodejs22 or python312. Defaults to nodejs22.
1924
+ * Serverless runtime for platform V2 apps (nodejs22 or python312)
1773
1925
  */
1774
1926
  'runtime'?: string;
1927
+ /**
1928
+ * Base HTTPS URL of the V2 app container runtime
1929
+ */
1930
+ 'runtimeBaseUrl'?: string;
1931
+ /**
1932
+ * Last deployed runtime revision id
1933
+ */
1934
+ 'runtimeRevision'?: string;
1935
+ /**
1936
+ * V2 runtime status: PENDING, PROVISIONING, READY, FAILED
1937
+ */
1938
+ 'runtimeStatus'?: string;
1939
+ /**
1940
+ * Last V2 runtime error message when FAILED
1941
+ */
1942
+ 'runtimeError'?: string;
1943
+ /**
1944
+ * Monotonic generation for async runtime jobs
1945
+ */
1946
+ 'runtimeGeneration'?: number;
1775
1947
  }
1776
1948
  export declare const CreatePrivateAppRequestAuthMethodEnum: {
1777
1949
  readonly None: "NONE";
@@ -2586,9 +2758,9 @@ export declare const EventRsvpRequestScopeEnum: {
2586
2758
  };
2587
2759
  export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof typeof EventRsvpRequestScopeEnum];
2588
2760
  export interface ExistingWidgetSummary {
2589
- 'xproperty'?: string;
2590
- 'ymetric'?: string;
2591
2761
  'yproperty'?: string;
2762
+ 'ymetric'?: string;
2763
+ 'xproperty'?: string;
2592
2764
  'title'?: string;
2593
2765
  'chartType'?: string;
2594
2766
  'xProperty'?: string;
@@ -5833,8 +6005,8 @@ export interface SettingField {
5833
6005
  'hidden'?: boolean;
5834
6006
  'disabled'?: boolean;
5835
6007
  'options'?: Array<SettingOption>;
5836
- 'defaultValue'?: any;
5837
6008
  'value'?: any;
6009
+ 'defaultValue'?: any;
5838
6010
  }
5839
6011
  export declare const SettingFieldTypeEnum: {
5840
6012
  readonly String: "STRING";
@@ -9326,7 +9498,7 @@ export declare const ApplicationsApiAxiosParamCreator: (configuration?: Configur
9326
9498
  */
9327
9499
  createAppWebhookForApp: (appUuid: string, subscribeWebhookDTO: SubscribeWebhookDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9328
9500
  /**
9329
- * Creates a new private app with the provided label and optional description. Private apps are automatically installed for the creating user\'s company. Returns the created app details as a CreateResponse wrapping an AppDTO.
9501
+ * Creates a private app from its creator manifest, validating the supplied name, settings and app bars before saving. An omitted name is generated. Private apps are automatically installed for the creating user\'s company. Returns the created app details as a CreateResponse wrapping an AppDTO.
9330
9502
  * @summary Create a private app
9331
9503
  * @param {CreatePrivateAppRequest} createPrivateAppRequest
9332
9504
  * @param {*} [options] Override http request option.
@@ -9602,7 +9774,7 @@ export declare const ApplicationsApiFp: (configuration?: Configuration) => {
9602
9774
  */
9603
9775
  createAppWebhookForApp(appUuid: string, subscribeWebhookDTO: SubscribeWebhookDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateResponse>>;
9604
9776
  /**
9605
- * Creates a new private app with the provided label and optional description. Private apps are automatically installed for the creating user\'s company. Returns the created app details as a CreateResponse wrapping an AppDTO.
9777
+ * Creates a private app from its creator manifest, validating the supplied name, settings and app bars before saving. An omitted name is generated. Private apps are automatically installed for the creating user\'s company. Returns the created app details as a CreateResponse wrapping an AppDTO.
9606
9778
  * @summary Create a private app
9607
9779
  * @param {CreatePrivateAppRequest} createPrivateAppRequest
9608
9780
  * @param {*} [options] Override http request option.
@@ -9886,7 +10058,7 @@ export declare const ApplicationsApiFactory: (configuration?: Configuration, bas
9886
10058
  */
9887
10059
  createAppWebhookForApp(appUuid: string, subscribeWebhookDTO: SubscribeWebhookDTO, options?: RawAxiosRequestConfig): AxiosPromise<CreateResponse>;
9888
10060
  /**
9889
- * Creates a new private app with the provided label and optional description. Private apps are automatically installed for the creating user\'s company. Returns the created app details as a CreateResponse wrapping an AppDTO.
10061
+ * Creates a private app from its creator manifest, validating the supplied name, settings and app bars before saving. An omitted name is generated. Private apps are automatically installed for the creating user\'s company. Returns the created app details as a CreateResponse wrapping an AppDTO.
9890
10062
  * @summary Create a private app
9891
10063
  * @param {CreatePrivateAppRequest} createPrivateAppRequest
9892
10064
  * @param {*} [options] Override http request option.
@@ -10170,7 +10342,7 @@ export declare class ApplicationsApi extends BaseAPI {
10170
10342
  */
10171
10343
  createAppWebhookForApp(appUuid: string, subscribeWebhookDTO: SubscribeWebhookDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateResponse, any, {}>>;
10172
10344
  /**
10173
- * Creates a new private app with the provided label and optional description. Private apps are automatically installed for the creating user\'s company. Returns the created app details as a CreateResponse wrapping an AppDTO.
10345
+ * Creates a private app from its creator manifest, validating the supplied name, settings and app bars before saving. An omitted name is generated. Private apps are automatically installed for the creating user\'s company. Returns the created app details as a CreateResponse wrapping an AppDTO.
10174
10346
  * @summary Create a private app
10175
10347
  * @param {CreatePrivateAppRequest} createPrivateAppRequest
10176
10348
  * @param {*} [options] Override http request option.
package/dist/esm/api.js CHANGED
@@ -1881,7 +1881,7 @@ export const ApplicationsApiAxiosParamCreator = function (configuration) {
1881
1881
  };
1882
1882
  }),
1883
1883
  /**
1884
- * Creates a new private app with the provided label and optional description. Private apps are automatically installed for the creating user\'s company. Returns the created app details as a CreateResponse wrapping an AppDTO.
1884
+ * Creates a private app from its creator manifest, validating the supplied name, settings and app bars before saving. An omitted name is generated. Private apps are automatically installed for the creating user\'s company. Returns the created app details as a CreateResponse wrapping an AppDTO.
1885
1885
  * @summary Create a private app
1886
1886
  * @param {CreatePrivateAppRequest} createPrivateAppRequest
1887
1887
  * @param {*} [options] Override http request option.
@@ -2995,7 +2995,7 @@ export const ApplicationsApiFp = function (configuration) {
2995
2995
  });
2996
2996
  },
2997
2997
  /**
2998
- * Creates a new private app with the provided label and optional description. Private apps are automatically installed for the creating user\'s company. Returns the created app details as a CreateResponse wrapping an AppDTO.
2998
+ * Creates a private app from its creator manifest, validating the supplied name, settings and app bars before saving. An omitted name is generated. Private apps are automatically installed for the creating user\'s company. Returns the created app details as a CreateResponse wrapping an AppDTO.
2999
2999
  * @summary Create a private app
3000
3000
  * @param {CreatePrivateAppRequest} createPrivateAppRequest
3001
3001
  * @param {*} [options] Override http request option.
@@ -3516,7 +3516,7 @@ export const ApplicationsApiFactory = function (configuration, basePath, axios)
3516
3516
  return localVarFp.createAppWebhookForApp(appUuid, subscribeWebhookDTO, options).then((request) => request(axios, basePath));
3517
3517
  },
3518
3518
  /**
3519
- * Creates a new private app with the provided label and optional description. Private apps are automatically installed for the creating user\'s company. Returns the created app details as a CreateResponse wrapping an AppDTO.
3519
+ * Creates a private app from its creator manifest, validating the supplied name, settings and app bars before saving. An omitted name is generated. Private apps are automatically installed for the creating user\'s company. Returns the created app details as a CreateResponse wrapping an AppDTO.
3520
3520
  * @summary Create a private app
3521
3521
  * @param {CreatePrivateAppRequest} createPrivateAppRequest
3522
3522
  * @param {*} [options] Override http request option.
@@ -3855,7 +3855,7 @@ export class ApplicationsApi extends BaseAPI {
3855
3855
  return ApplicationsApiFp(this.configuration).createAppWebhookForApp(appUuid, subscribeWebhookDTO, options).then((request) => request(this.axios, this.basePath));
3856
3856
  }
3857
3857
  /**
3858
- * Creates a new private app with the provided label and optional description. Private apps are automatically installed for the creating user\'s company. Returns the created app details as a CreateResponse wrapping an AppDTO.
3858
+ * Creates a private app from its creator manifest, validating the supplied name, settings and app bars before saving. An omitted name is generated. Private apps are automatically installed for the creating user\'s company. Returns the created app details as a CreateResponse wrapping an AppDTO.
3859
3859
  * @summary Create a private app
3860
3860
  * @param {CreatePrivateAppRequest} createPrivateAppRequest
3861
3861
  * @param {*} [options] Override http request option.
@@ -99,7 +99,7 @@ const { status, data } = await apiInstance.createAppWebhookForApp(
99
99
  # **createPrivateApp**
100
100
  > CreateResponse createPrivateApp(createPrivateAppRequest)
101
101
 
102
- Creates a new private app with the provided label and optional description. Private apps are automatically installed for the creating user\'s company. Returns the created app details as a CreateResponse wrapping an AppDTO.
102
+ Creates a private app from its creator manifest, validating the supplied name, settings and app bars before saving. An omitted name is generated. Private apps are automatically installed for the creating user\'s company. Returns the created app details as a CreateResponse wrapping an AppDTO.
103
103
 
104
104
  ### Example
105
105
 
@@ -1,17 +1,60 @@
1
1
  # CreatePrivateAppRequest
2
2
 
3
- Private app creation request with label and optional description
3
+ Private app creator manifest; label is required and internal name is optional
4
4
 
5
5
  ## Properties
6
6
 
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
- **label** | **string** | The display label for the private app. | [default to undefined]
10
- **description** | **string** | Optional description text for the app. | [optional] [default to undefined]
11
- **authMethod** | **string** | Authentication method (API_KEY default, OAUTH2 for OAuth 2.0) | [optional] [default to undefined]
12
- **oauthRedirectUris** | **Array&lt;string&gt;** | Registered OAuth redirect URIs (required when authMethod is OAUTH2) | [optional] [default to undefined]
13
- **platformVersion** | **number** | Ignored; new private apps are always platform version 2 (async container runtime). | [optional] [default to undefined]
14
- **runtime** | **string** | Serverless runtime for the app: nodejs22 or python312. Defaults to nodejs22. | [optional] [default to undefined]
9
+ **uuid** | **string** | Unique identifier for the entity | [default to undefined]
10
+ **name** | **string** | The name of the entity | [default to undefined]
11
+ **label** | **string** | Display label for the entity, can be different from name | [default to undefined]
12
+ **createdAt** | **number** | Unix timestamp when the entity was created | [optional] [default to undefined]
13
+ **createdBy** | [**ModelRecord**](ModelRecord.md) | Identifier of the user who created the entity | [optional] [default to undefined]
14
+ **updatedAt** | **number** | Unix timestamp when the entity was last updated | [optional] [default to undefined]
15
+ **updatedBy** | [**ModelRecord**](ModelRecord.md) | Identifier of the user who last updated the entity | [optional] [default to undefined]
16
+ **deletedAt** | **number** | Unix timestamp when the entity was deleted (null if not deleted) | [optional] [default to undefined]
17
+ **deletedBy** | [**ModelRecord**](ModelRecord.md) | Identifier of the user who deleted the entity | [optional] [default to undefined]
18
+ **index** | **number** | Index number for ordering entities | [optional] [default to undefined]
19
+ **privateApp** | **boolean** | Indicates whether this app is private (only available to the creator\&#39;s company) | [optional] [default to undefined]
20
+ **hideApiKeyField** | **boolean** | Whether to hide the API token field in marketplace installer UI. Defaults to true when omitted. Private apps show the key regardless. | [optional] [default to undefined]
21
+ **details** | [**AppDetailsDTO**](AppDetailsDTO.md) | Additional details and specifications about the application | [optional] [default to undefined]
22
+ **appBars** | [**Array&lt;AppBarDTO&gt;**](AppBarDTO.md) | App bars (location-specific configuration and actions) | [optional] [default to undefined]
23
+ **serverlessFunctions** | [**Array&lt;ServerlessFunctionDTO&gt;**](ServerlessFunctionDTO.md) | Serverless functions owned by this app | [optional] [default to undefined]
24
+ **installWebhook** | [**SubscribeWebhookDTO**](SubscribeWebhookDTO.md) | Webhook triggered when the app is installed | [optional] [default to undefined]
25
+ **uninstallWebhook** | [**SubscribeWebhookDTO**](SubscribeWebhookDTO.md) | Webhook triggered when the app is uninstalled | [optional] [default to undefined]
26
+ **rotateWebhook** | [**SubscribeWebhookDTO**](SubscribeWebhookDTO.md) | Webhook triggered when the app installation token is rotated | [optional] [default to undefined]
27
+ **updateWebhook** | [**SubscribeWebhookDTO**](SubscribeWebhookDTO.md) | Webhook triggered when an already installed app is saved again | [optional] [default to undefined]
28
+ **settingsSchema** | [**Array&lt;AppSettingFieldSchema&gt;**](AppSettingFieldSchema.md) | JSON array of AppSettingFieldSchema (app-level setting field definitions) | [optional] [default to undefined]
29
+ **settingsSections** | [**Array&lt;AppSettingsSection&gt;**](AppSettingsSection.md) | Optional UI grouping of settingsSchema fields into installer cards | [optional] [default to undefined]
30
+ **externalOAuthProviders** | [**Array&lt;AppExternalOAuthProviderSummaryDTO&gt;**](AppExternalOAuthProviderSummaryDTO.md) | External OAuth providers installers can Connect (name/logo only; no secrets) | [optional] [default to undefined]
31
+ **webhookRateLimitPerMinute** | **number** | Webhook rate limit per minute | [optional] [default to undefined]
32
+ **jobRateLimitPerMinute** | **number** | App job enqueue rate limit per minute per installation | [optional] [default to undefined]
33
+ **appPublish** | [**AppPublishDTO**](AppPublishDTO.md) | Publish and review state for the app in the marketplace (creator view) | [optional] [default to undefined]
34
+ **hasApp** | [**HasAppDTO**](HasAppDTO.md) | Installation link (company–app) with token, scopes, and per-installation settingsValues; present when includeSettings is true | [optional] [default to undefined]
35
+ **image** | **string** | URL to the application\&#39;s image or icon (derived from details.image) | [optional] [default to undefined]
36
+ **url** | **string** | URL where the application can be accessed (derived from details.url) | [optional] [default to undefined]
37
+ **category** | **string** | Category the application belongs to (derived from details.category) | [optional] [default to undefined]
38
+ **installed** | **boolean** | Whether the app is installed for the current company | [optional] [default to undefined]
39
+ **requiredScopes** | **Array&lt;string&gt;** | Required scopes requested by the app (macro patterns or concrete scope strings). | [optional] [default to undefined]
40
+ **resolvedRequiredScopes** | **Array&lt;string&gt;** | Resolved concrete required scopes derived from requiredScopes and dynamic availableScopes. | [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
+ **oauthClientId** | **string** | OAuth 2.0 client identifier (OAuth apps only) | [optional] [default to undefined]
43
+ **oauthClientSecret** | **string** | OAuth 2.0 client secret; only returned once on create or secret rotation | [optional] [default to undefined]
44
+ **oauthClientSecretConfigured** | **boolean** | Whether an OAuth client secret is stored for this app (plain value is not re-readable) | [optional] [default to undefined]
45
+ **oauthRedirectUris** | **Array&lt;string&gt;** | Registered OAuth redirect URIs (OAuth apps only) | [optional] [default to undefined]
46
+ **oauthAuthorizeUrl** | **string** | OAuth authorization endpoint URL | [optional] [default to undefined]
47
+ **oauthTokenUrl** | **string** | OAuth token endpoint URL | [optional] [default to undefined]
48
+ **installUrl** | **string** | External URL where end users install this app (e.g. ChatGPT connector page) | [optional] [default to undefined]
49
+ **brandmark** | **string** | Square brandmark URL used in compact app surfaces | [optional] [default to undefined]
50
+ **description** | **string** | Internal app description used in Caraer admin views | [optional] [default to undefined]
51
+ **platformVersion** | **number** | App platform version: 1 &#x3D; legacy per-function Cloud Functions; 2 &#x3D; one container per app | [optional] [default to undefined]
52
+ **runtime** | **string** | Serverless runtime for platform V2 apps (nodejs22 or python312) | [optional] [default to undefined]
53
+ **runtimeBaseUrl** | **string** | Base HTTPS URL of the V2 app container runtime | [optional] [default to undefined]
54
+ **runtimeRevision** | **string** | Last deployed runtime revision id | [optional] [default to undefined]
55
+ **runtimeStatus** | **string** | V2 runtime status: PENDING, PROVISIONING, READY, FAILED | [optional] [default to undefined]
56
+ **runtimeError** | **string** | Last V2 runtime error message when FAILED | [optional] [default to undefined]
57
+ **runtimeGeneration** | **number** | Monotonic generation for async runtime jobs | [optional] [default to undefined]
15
58
 
16
59
  ## Example
17
60
 
@@ -19,12 +62,55 @@ Name | Type | Description | Notes
19
62
  import { CreatePrivateAppRequest } from '@caraer/client';
20
63
 
21
64
  const instance: CreatePrivateAppRequest = {
65
+ uuid,
66
+ name,
22
67
  label,
23
- description,
68
+ createdAt,
69
+ createdBy,
70
+ updatedAt,
71
+ updatedBy,
72
+ deletedAt,
73
+ deletedBy,
74
+ index,
75
+ privateApp,
76
+ hideApiKeyField,
77
+ details,
78
+ appBars,
79
+ serverlessFunctions,
80
+ installWebhook,
81
+ uninstallWebhook,
82
+ rotateWebhook,
83
+ updateWebhook,
84
+ settingsSchema,
85
+ settingsSections,
86
+ externalOAuthProviders,
87
+ webhookRateLimitPerMinute,
88
+ jobRateLimitPerMinute,
89
+ appPublish,
90
+ hasApp,
91
+ image,
92
+ url,
93
+ category,
94
+ installed,
95
+ requiredScopes,
96
+ resolvedRequiredScopes,
24
97
  authMethod,
98
+ oauthClientId,
99
+ oauthClientSecret,
100
+ oauthClientSecretConfigured,
25
101
  oauthRedirectUris,
102
+ oauthAuthorizeUrl,
103
+ oauthTokenUrl,
104
+ installUrl,
105
+ brandmark,
106
+ description,
26
107
  platformVersion,
27
108
  runtime,
109
+ runtimeBaseUrl,
110
+ runtimeRevision,
111
+ runtimeStatus,
112
+ runtimeError,
113
+ runtimeGeneration,
28
114
  };
29
115
  ```
30
116
 
@@ -5,9 +5,9 @@
5
5
 
6
6
  Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
- **xproperty** | **string** | | [optional] [default to undefined]
9
- **ymetric** | **string** | | [optional] [default to undefined]
10
8
  **yproperty** | **string** | | [optional] [default to undefined]
9
+ **ymetric** | **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]
@@ -20,9 +20,9 @@ Name | Type | Description | Notes
20
20
  import { ExistingWidgetSummary } from '@caraer/client';
21
21
 
22
22
  const instance: ExistingWidgetSummary = {
23
- xproperty,
24
- ymetric,
25
23
  yproperty,
24
+ ymetric,
25
+ xproperty,
26
26
  title,
27
27
  chartType,
28
28
  xProperty,
@@ -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
- **defaultValue** | **any** | | [optional] [default to undefined]
18
17
  **value** | **any** | | [optional] [default to undefined]
18
+ **defaultValue** | **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
- defaultValue,
36
35
  value,
36
+ defaultValue,
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.573",
3
+ "version": "2.0.575",
4
4
  "description": "Generated TypeScript client for the Caraer API",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {