@caraer/client 2.0.696 → 2.0.701
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/.openapi-generator/FILES +38 -0
- package/api.ts +1839 -204
- package/dist/api.d.ts +997 -31
- package/dist/api.js +1280 -84
- package/dist/esm/api.d.ts +997 -31
- package/dist/esm/api.js +1268 -80
- package/docs/ApiTokenDTO.md +22 -0
- package/docs/AppBarDTO.md +6 -0
- package/docs/AppBarIframeSessionRequest.md +4 -0
- package/docs/AppBarsApi.md +4 -1
- package/docs/AppDTO.md +4 -0
- package/docs/AppDetailsDTO.md +2 -0
- package/docs/AppSettingFieldSchema.md +2 -2
- package/docs/BrowserAuthExchangeRequest.md +24 -0
- package/docs/BrowserAuthSessionResponse.md +28 -0
- package/docs/BrowserAuthStartRequest.md +28 -0
- package/docs/BrowserAuthStartResponse.md +22 -0
- package/docs/BrowserAuthenticationApi.md +176 -0
- package/docs/BulkEditRecordErrorItem.md +2 -0
- package/docs/CreatePrivateAppRequest.md +4 -0
- package/docs/EnsureRelationDTO.md +27 -0
- package/docs/ErrorResponse.md +2 -0
- package/docs/ExistingWidgetSummary.md +2 -2
- package/docs/FavoriteViewDTO.md +22 -0
- package/docs/NavigationApi.md +280 -0
- package/docs/NavigationDTO.md +27 -0
- package/docs/NavigationObjectDTO.md +38 -0
- package/docs/NavigationViewDTO.md +44 -0
- package/docs/NotificationDeviceReceipt.md +26 -0
- package/docs/NotificationDeviceRegistration.md +28 -0
- package/docs/NotificationsApi.md +172 -0
- package/docs/ObjectReferenceDTO.md +32 -0
- package/docs/ObjectsApi.md +5 -2
- package/docs/Palette.md +22 -0
- package/docs/Record.md +2 -2
- package/docs/RecordsApi.md +119 -0
- package/docs/RelationCapabilities.md +26 -0
- package/docs/RelationCapabilityEdge.md +22 -0
- package/docs/RelationCapabilityEdges.md +22 -0
- package/docs/RelationCapabilityOperation.md +22 -0
- package/docs/RelationCapabilityPair.md +22 -0
- package/docs/RelationCapabilityPairCapability.md +34 -0
- package/docs/RelationCapabilityPrimary.md +22 -0
- package/docs/RelationCapabilityRequest.md +22 -0
- package/docs/SettingField.md +2 -2
- package/docs/ShowResponseBrowserAuthSessionResponse.md +23 -0
- package/docs/ShowResponseBrowserAuthStartResponse.md +23 -0
- package/docs/ShowResponseItem.md +23 -0
- package/docs/ShowResponseNotificationDeviceReceipt.md +23 -0
- package/docs/ShowResponseRelationCapabilities.md +23 -0
- package/docs/ShowResponseWebpageEditorDefaultsDTO.md +23 -0
- package/docs/SimpleCompanyDTO.md +22 -0
- package/docs/SuccessResponseEnsureRelationDTO.md +23 -0
- package/docs/SuccessResponseListFavoriteViewDTO.md +23 -0
- package/docs/SuccessResponseListNavigationViewDTO.md +23 -0
- package/docs/SuccessResponseNavigationDTO.md +23 -0
- package/docs/UserDTO.md +46 -0
- package/docs/ViewNavigationPreferencesRequest.md +23 -0
- package/docs/WebpageEditorDefaultsDTO.md +25 -0
- package/docs/WebpagesApi.md +118 -0
- package/package.json +1 -1
package/dist/esm/api.js
CHANGED
|
@@ -42,6 +42,10 @@ export const AdvancedRecordQueryRequestStrategyEnum = {
|
|
|
42
42
|
Hybrid: 'HYBRID',
|
|
43
43
|
Graph: 'GRAPH',
|
|
44
44
|
};
|
|
45
|
+
export const AppBarDTONavigationPlacementEnum = {
|
|
46
|
+
Suite: 'SUITE',
|
|
47
|
+
Settings: 'SETTINGS',
|
|
48
|
+
};
|
|
45
49
|
export const AppBarDTOLocationEnum = {
|
|
46
50
|
RecordPreview: 'RECORD_PREVIEW',
|
|
47
51
|
RecordOverview: 'RECORD_OVERVIEW',
|
|
@@ -50,11 +54,18 @@ export const AppBarDTOLocationEnum = {
|
|
|
50
54
|
TraitBar: 'TRAIT_BAR',
|
|
51
55
|
RecordTrait: 'RECORD_TRAIT',
|
|
52
56
|
};
|
|
57
|
+
export const AppBarIframeSessionRequestNavigationPlacementEnum = {
|
|
58
|
+
Suite: 'SUITE',
|
|
59
|
+
Settings: 'SETTINGS',
|
|
60
|
+
};
|
|
53
61
|
export const AppDTOAuthMethodEnum = {
|
|
54
62
|
None: 'NONE',
|
|
55
63
|
ApiKey: 'API_KEY',
|
|
56
64
|
Oauth2: 'OAUTH2',
|
|
57
65
|
};
|
|
66
|
+
export const BulkEditRecordErrorItemRecordWriteOutcomeEnum = {
|
|
67
|
+
NotStarted: 'NOT_STARTED',
|
|
68
|
+
};
|
|
58
69
|
export const CaraerErrorTypeTypeEnum = {
|
|
59
70
|
Validation: 'VALIDATION',
|
|
60
71
|
NotFound: 'NOT_FOUND',
|
|
@@ -73,6 +84,13 @@ export const CreatePrivateAppRequestAuthMethodEnum = {
|
|
|
73
84
|
ApiKey: 'API_KEY',
|
|
74
85
|
Oauth2: 'OAUTH2',
|
|
75
86
|
};
|
|
87
|
+
export const EnsureRelationDTOOutcomeEnum = {
|
|
88
|
+
Created: 'CREATED',
|
|
89
|
+
Unchanged: 'UNCHANGED',
|
|
90
|
+
};
|
|
91
|
+
export const ErrorResponseRecordWriteOutcomeEnum = {
|
|
92
|
+
NotStarted: 'NOT_STARTED',
|
|
93
|
+
};
|
|
76
94
|
export const ErrorResponseRolesEnum = {
|
|
77
95
|
User: 'USER',
|
|
78
96
|
Admin: 'ADMIN',
|
|
@@ -91,6 +109,25 @@ export const EventRsvpRequestScopeEnum = {
|
|
|
91
109
|
ThisAndFuture: 'this_and_future',
|
|
92
110
|
All: 'all',
|
|
93
111
|
};
|
|
112
|
+
export const RelationCapabilityEdgePrimaryEnum = {
|
|
113
|
+
Absent: 'ABSENT',
|
|
114
|
+
False: 'FALSE',
|
|
115
|
+
True: 'TRUE',
|
|
116
|
+
Mixed: 'MIXED',
|
|
117
|
+
};
|
|
118
|
+
export const RelationCapabilityOperationFromEnum = {
|
|
119
|
+
Source: 'SOURCE',
|
|
120
|
+
Target: 'TARGET',
|
|
121
|
+
};
|
|
122
|
+
export const RelationCapabilityPairCapabilityStatusEnum = {
|
|
123
|
+
Available: 'AVAILABLE',
|
|
124
|
+
Unavailable: 'UNAVAILABLE',
|
|
125
|
+
Unresolved: 'UNRESOLVED',
|
|
126
|
+
};
|
|
127
|
+
export const RelationCapabilityPairCapabilityReasonEnum = {
|
|
128
|
+
OrientationAmbiguous: 'ORIENTATION_AMBIGUOUS',
|
|
129
|
+
UnsupportedRelationName: 'UNSUPPORTED_RELATION_NAME',
|
|
130
|
+
};
|
|
94
131
|
export const RelationPillSortDirectionEnum = {
|
|
95
132
|
Asc: 'ASC',
|
|
96
133
|
Desc: 'DESC',
|
|
@@ -307,10 +344,11 @@ export const AppBarsApiAxiosParamCreator = function (configuration) {
|
|
|
307
344
|
* @param {string} [viewId] View ID in context
|
|
308
345
|
* @param {string} [trait] Trait name in context
|
|
309
346
|
* @param {string} [suite] Suite selected in the UI. A tool bar is included when this suite is saved on the bar.
|
|
347
|
+
* @param {ListAppBarsNavigationPlacementEnum} [navigationPlacement] TOOL_BAR placement. Omitted means legacy SUITE; SETTINGS is suite-independent.
|
|
310
348
|
* @param {*} [options] Override http request option.
|
|
311
349
|
* @throws {RequiredError}
|
|
312
350
|
*/
|
|
313
|
-
listAppBars: (location_1, object_1, recordUuid_1, viewId_1, trait_1, suite_1, ...args_1) => __awaiter(this, [location_1, object_1, recordUuid_1, viewId_1, trait_1, suite_1, ...args_1], void 0, function* (location, object, recordUuid, viewId, trait, suite, options = {}) {
|
|
351
|
+
listAppBars: (location_1, object_1, recordUuid_1, viewId_1, trait_1, suite_1, navigationPlacement_1, ...args_1) => __awaiter(this, [location_1, object_1, recordUuid_1, viewId_1, trait_1, suite_1, navigationPlacement_1, ...args_1], void 0, function* (location, object, recordUuid, viewId, trait, suite, navigationPlacement, options = {}) {
|
|
314
352
|
// verify required parameter 'location' is not null or undefined
|
|
315
353
|
assertParamExists('listAppBars', 'location', location);
|
|
316
354
|
const localVarPath = `/api/v2/app-bars`;
|
|
@@ -344,6 +382,9 @@ export const AppBarsApiAxiosParamCreator = function (configuration) {
|
|
|
344
382
|
if (suite !== undefined) {
|
|
345
383
|
localVarQueryParameter['suite'] = suite;
|
|
346
384
|
}
|
|
385
|
+
if (navigationPlacement !== undefined) {
|
|
386
|
+
localVarQueryParameter['navigationPlacement'] = navigationPlacement;
|
|
387
|
+
}
|
|
347
388
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
348
389
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
349
390
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -406,13 +447,14 @@ export const AppBarsApiFp = function (configuration) {
|
|
|
406
447
|
* @param {string} [viewId] View ID in context
|
|
407
448
|
* @param {string} [trait] Trait name in context
|
|
408
449
|
* @param {string} [suite] Suite selected in the UI. A tool bar is included when this suite is saved on the bar.
|
|
450
|
+
* @param {ListAppBarsNavigationPlacementEnum} [navigationPlacement] TOOL_BAR placement. Omitted means legacy SUITE; SETTINGS is suite-independent.
|
|
409
451
|
* @param {*} [options] Override http request option.
|
|
410
452
|
* @throws {RequiredError}
|
|
411
453
|
*/
|
|
412
|
-
listAppBars(location, object, recordUuid, viewId, trait, suite, options) {
|
|
454
|
+
listAppBars(location, object, recordUuid, viewId, trait, suite, navigationPlacement, options) {
|
|
413
455
|
return __awaiter(this, void 0, void 0, function* () {
|
|
414
456
|
var _a, _b, _c;
|
|
415
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.listAppBars(location, object, recordUuid, viewId, trait, suite, options);
|
|
457
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listAppBars(location, object, recordUuid, viewId, trait, suite, navigationPlacement, options);
|
|
416
458
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
417
459
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AppBarsApi.listAppBars']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
418
460
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -452,11 +494,12 @@ export const AppBarsApiFactory = function (configuration, basePath, axios) {
|
|
|
452
494
|
* @param {string} [viewId] View ID in context
|
|
453
495
|
* @param {string} [trait] Trait name in context
|
|
454
496
|
* @param {string} [suite] Suite selected in the UI. A tool bar is included when this suite is saved on the bar.
|
|
497
|
+
* @param {ListAppBarsNavigationPlacementEnum} [navigationPlacement] TOOL_BAR placement. Omitted means legacy SUITE; SETTINGS is suite-independent.
|
|
455
498
|
* @param {*} [options] Override http request option.
|
|
456
499
|
* @throws {RequiredError}
|
|
457
500
|
*/
|
|
458
|
-
listAppBars(location, object, recordUuid, viewId, trait, suite, options) {
|
|
459
|
-
return localVarFp.listAppBars(location, object, recordUuid, viewId, trait, suite, options).then((request) => request(axios, basePath));
|
|
501
|
+
listAppBars(location, object, recordUuid, viewId, trait, suite, navigationPlacement, options) {
|
|
502
|
+
return localVarFp.listAppBars(location, object, recordUuid, viewId, trait, suite, navigationPlacement, options).then((request) => request(axios, basePath));
|
|
460
503
|
},
|
|
461
504
|
/**
|
|
462
505
|
* Fires the app bar webhook with optional settings values and record/view context.
|
|
@@ -484,11 +527,12 @@ export class AppBarsApi extends BaseAPI {
|
|
|
484
527
|
* @param {string} [viewId] View ID in context
|
|
485
528
|
* @param {string} [trait] Trait name in context
|
|
486
529
|
* @param {string} [suite] Suite selected in the UI. A tool bar is included when this suite is saved on the bar.
|
|
530
|
+
* @param {ListAppBarsNavigationPlacementEnum} [navigationPlacement] TOOL_BAR placement. Omitted means legacy SUITE; SETTINGS is suite-independent.
|
|
487
531
|
* @param {*} [options] Override http request option.
|
|
488
532
|
* @throws {RequiredError}
|
|
489
533
|
*/
|
|
490
|
-
listAppBars(location, object, recordUuid, viewId, trait, suite, options) {
|
|
491
|
-
return AppBarsApiFp(this.configuration).listAppBars(location, object, recordUuid, viewId, trait, suite, options).then((request) => request(this.axios, this.basePath));
|
|
534
|
+
listAppBars(location, object, recordUuid, viewId, trait, suite, navigationPlacement, options) {
|
|
535
|
+
return AppBarsApiFp(this.configuration).listAppBars(location, object, recordUuid, viewId, trait, suite, navigationPlacement, options).then((request) => request(this.axios, this.basePath));
|
|
492
536
|
}
|
|
493
537
|
/**
|
|
494
538
|
* Fires the app bar webhook with optional settings values and record/view context.
|
|
@@ -510,6 +554,10 @@ export const ListAppBarsLocationEnum = {
|
|
|
510
554
|
TraitBar: 'TRAIT_BAR',
|
|
511
555
|
RecordTrait: 'RECORD_TRAIT',
|
|
512
556
|
};
|
|
557
|
+
export const ListAppBarsNavigationPlacementEnum = {
|
|
558
|
+
Suite: 'SUITE',
|
|
559
|
+
Settings: 'SETTINGS',
|
|
560
|
+
};
|
|
513
561
|
/**
|
|
514
562
|
* AppInstallationRuntimeApi - axios parameter creator
|
|
515
563
|
*/
|
|
@@ -4752,6 +4800,245 @@ export class BillingApi extends BaseAPI {
|
|
|
4752
4800
|
return BillingApiFp(this.configuration).sendSetupEmail(options).then((request) => request(this.axios, this.basePath));
|
|
4753
4801
|
}
|
|
4754
4802
|
}
|
|
4803
|
+
/**
|
|
4804
|
+
* BrowserAuthenticationApi - axios parameter creator
|
|
4805
|
+
*/
|
|
4806
|
+
export const BrowserAuthenticationApiAxiosParamCreator = function (configuration) {
|
|
4807
|
+
return {
|
|
4808
|
+
/**
|
|
4809
|
+
*
|
|
4810
|
+
* @summary Open the browser-owned provider session
|
|
4811
|
+
* @param {string} flow
|
|
4812
|
+
* @param {*} [options] Override http request option.
|
|
4813
|
+
* @throws {RequiredError}
|
|
4814
|
+
*/
|
|
4815
|
+
authorize: (flow_1, ...args_1) => __awaiter(this, [flow_1, ...args_1], void 0, function* (flow, options = {}) {
|
|
4816
|
+
// verify required parameter 'flow' is not null or undefined
|
|
4817
|
+
assertParamExists('authorize', 'flow', flow);
|
|
4818
|
+
const localVarPath = `/api/v2/auth/browser/authorize`;
|
|
4819
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
4820
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
4821
|
+
let baseOptions;
|
|
4822
|
+
if (configuration) {
|
|
4823
|
+
baseOptions = configuration.baseOptions;
|
|
4824
|
+
}
|
|
4825
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
4826
|
+
const localVarHeaderParameter = {};
|
|
4827
|
+
const localVarQueryParameter = {};
|
|
4828
|
+
// authentication bearerAuth required
|
|
4829
|
+
// http bearer authentication required
|
|
4830
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4831
|
+
if (flow !== undefined) {
|
|
4832
|
+
localVarQueryParameter['flow'] = flow;
|
|
4833
|
+
}
|
|
4834
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
4835
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4836
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
4837
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
4838
|
+
return {
|
|
4839
|
+
url: toPathString(localVarUrlObj),
|
|
4840
|
+
options: localVarRequestOptions,
|
|
4841
|
+
};
|
|
4842
|
+
}),
|
|
4843
|
+
/**
|
|
4844
|
+
* Exchanges an unexpired single-use code only after exact redirect and PKCE verifier checks. Access/refresh tokens are returned in JSON and never in callback URLs.
|
|
4845
|
+
* @summary Exchange a native callback code
|
|
4846
|
+
* @param {BrowserAuthExchangeRequest} browserAuthExchangeRequest
|
|
4847
|
+
* @param {*} [options] Override http request option.
|
|
4848
|
+
* @throws {RequiredError}
|
|
4849
|
+
*/
|
|
4850
|
+
exchange: (browserAuthExchangeRequest_1, ...args_1) => __awaiter(this, [browserAuthExchangeRequest_1, ...args_1], void 0, function* (browserAuthExchangeRequest, options = {}) {
|
|
4851
|
+
// verify required parameter 'browserAuthExchangeRequest' is not null or undefined
|
|
4852
|
+
assertParamExists('exchange', 'browserAuthExchangeRequest', browserAuthExchangeRequest);
|
|
4853
|
+
const localVarPath = `/api/v2/auth/browser/exchange`;
|
|
4854
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
4855
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
4856
|
+
let baseOptions;
|
|
4857
|
+
if (configuration) {
|
|
4858
|
+
baseOptions = configuration.baseOptions;
|
|
4859
|
+
}
|
|
4860
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
4861
|
+
const localVarHeaderParameter = {};
|
|
4862
|
+
const localVarQueryParameter = {};
|
|
4863
|
+
// authentication bearerAuth required
|
|
4864
|
+
// http bearer authentication required
|
|
4865
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4866
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
4867
|
+
localVarHeaderParameter['Accept'] = '*/*,application/json';
|
|
4868
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4869
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
4870
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
4871
|
+
localVarRequestOptions.data = serializeDataIfNeeded(browserAuthExchangeRequest, localVarRequestOptions, configuration);
|
|
4872
|
+
return {
|
|
4873
|
+
url: toPathString(localVarUrlObj),
|
|
4874
|
+
options: localVarRequestOptions,
|
|
4875
|
+
};
|
|
4876
|
+
}),
|
|
4877
|
+
/**
|
|
4878
|
+
* Requires an exact configured redirect URI, random client state and S256 PKCE challenge. Open the returned URL in the system browser.
|
|
4879
|
+
* @summary Start browser sign-in
|
|
4880
|
+
* @param {BrowserAuthStartRequest} browserAuthStartRequest
|
|
4881
|
+
* @param {*} [options] Override http request option.
|
|
4882
|
+
* @throws {RequiredError}
|
|
4883
|
+
*/
|
|
4884
|
+
start: (browserAuthStartRequest_1, ...args_1) => __awaiter(this, [browserAuthStartRequest_1, ...args_1], void 0, function* (browserAuthStartRequest, options = {}) {
|
|
4885
|
+
// verify required parameter 'browserAuthStartRequest' is not null or undefined
|
|
4886
|
+
assertParamExists('start', 'browserAuthStartRequest', browserAuthStartRequest);
|
|
4887
|
+
const localVarPath = `/api/v2/auth/browser/start`;
|
|
4888
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
4889
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
4890
|
+
let baseOptions;
|
|
4891
|
+
if (configuration) {
|
|
4892
|
+
baseOptions = configuration.baseOptions;
|
|
4893
|
+
}
|
|
4894
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
4895
|
+
const localVarHeaderParameter = {};
|
|
4896
|
+
const localVarQueryParameter = {};
|
|
4897
|
+
// authentication bearerAuth required
|
|
4898
|
+
// http bearer authentication required
|
|
4899
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4900
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
4901
|
+
localVarHeaderParameter['Accept'] = '*/*,application/json';
|
|
4902
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4903
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
4904
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
4905
|
+
localVarRequestOptions.data = serializeDataIfNeeded(browserAuthStartRequest, localVarRequestOptions, configuration);
|
|
4906
|
+
return {
|
|
4907
|
+
url: toPathString(localVarUrlObj),
|
|
4908
|
+
options: localVarRequestOptions,
|
|
4909
|
+
};
|
|
4910
|
+
}),
|
|
4911
|
+
};
|
|
4912
|
+
};
|
|
4913
|
+
/**
|
|
4914
|
+
* BrowserAuthenticationApi - functional programming interface
|
|
4915
|
+
*/
|
|
4916
|
+
export const BrowserAuthenticationApiFp = function (configuration) {
|
|
4917
|
+
const localVarAxiosParamCreator = BrowserAuthenticationApiAxiosParamCreator(configuration);
|
|
4918
|
+
return {
|
|
4919
|
+
/**
|
|
4920
|
+
*
|
|
4921
|
+
* @summary Open the browser-owned provider session
|
|
4922
|
+
* @param {string} flow
|
|
4923
|
+
* @param {*} [options] Override http request option.
|
|
4924
|
+
* @throws {RequiredError}
|
|
4925
|
+
*/
|
|
4926
|
+
authorize(flow, options) {
|
|
4927
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
4928
|
+
var _a, _b, _c;
|
|
4929
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.authorize(flow, options);
|
|
4930
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
4931
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['BrowserAuthenticationApi.authorize']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
4932
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4933
|
+
});
|
|
4934
|
+
},
|
|
4935
|
+
/**
|
|
4936
|
+
* Exchanges an unexpired single-use code only after exact redirect and PKCE verifier checks. Access/refresh tokens are returned in JSON and never in callback URLs.
|
|
4937
|
+
* @summary Exchange a native callback code
|
|
4938
|
+
* @param {BrowserAuthExchangeRequest} browserAuthExchangeRequest
|
|
4939
|
+
* @param {*} [options] Override http request option.
|
|
4940
|
+
* @throws {RequiredError}
|
|
4941
|
+
*/
|
|
4942
|
+
exchange(browserAuthExchangeRequest, options) {
|
|
4943
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
4944
|
+
var _a, _b, _c;
|
|
4945
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.exchange(browserAuthExchangeRequest, options);
|
|
4946
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
4947
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['BrowserAuthenticationApi.exchange']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
4948
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4949
|
+
});
|
|
4950
|
+
},
|
|
4951
|
+
/**
|
|
4952
|
+
* Requires an exact configured redirect URI, random client state and S256 PKCE challenge. Open the returned URL in the system browser.
|
|
4953
|
+
* @summary Start browser sign-in
|
|
4954
|
+
* @param {BrowserAuthStartRequest} browserAuthStartRequest
|
|
4955
|
+
* @param {*} [options] Override http request option.
|
|
4956
|
+
* @throws {RequiredError}
|
|
4957
|
+
*/
|
|
4958
|
+
start(browserAuthStartRequest, options) {
|
|
4959
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
4960
|
+
var _a, _b, _c;
|
|
4961
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.start(browserAuthStartRequest, options);
|
|
4962
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
4963
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['BrowserAuthenticationApi.start']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
4964
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4965
|
+
});
|
|
4966
|
+
},
|
|
4967
|
+
};
|
|
4968
|
+
};
|
|
4969
|
+
/**
|
|
4970
|
+
* BrowserAuthenticationApi - factory interface
|
|
4971
|
+
*/
|
|
4972
|
+
export const BrowserAuthenticationApiFactory = function (configuration, basePath, axios) {
|
|
4973
|
+
const localVarFp = BrowserAuthenticationApiFp(configuration);
|
|
4974
|
+
return {
|
|
4975
|
+
/**
|
|
4976
|
+
*
|
|
4977
|
+
* @summary Open the browser-owned provider session
|
|
4978
|
+
* @param {string} flow
|
|
4979
|
+
* @param {*} [options] Override http request option.
|
|
4980
|
+
* @throws {RequiredError}
|
|
4981
|
+
*/
|
|
4982
|
+
authorize(flow, options) {
|
|
4983
|
+
return localVarFp.authorize(flow, options).then((request) => request(axios, basePath));
|
|
4984
|
+
},
|
|
4985
|
+
/**
|
|
4986
|
+
* Exchanges an unexpired single-use code only after exact redirect and PKCE verifier checks. Access/refresh tokens are returned in JSON and never in callback URLs.
|
|
4987
|
+
* @summary Exchange a native callback code
|
|
4988
|
+
* @param {BrowserAuthExchangeRequest} browserAuthExchangeRequest
|
|
4989
|
+
* @param {*} [options] Override http request option.
|
|
4990
|
+
* @throws {RequiredError}
|
|
4991
|
+
*/
|
|
4992
|
+
exchange(browserAuthExchangeRequest, options) {
|
|
4993
|
+
return localVarFp.exchange(browserAuthExchangeRequest, options).then((request) => request(axios, basePath));
|
|
4994
|
+
},
|
|
4995
|
+
/**
|
|
4996
|
+
* Requires an exact configured redirect URI, random client state and S256 PKCE challenge. Open the returned URL in the system browser.
|
|
4997
|
+
* @summary Start browser sign-in
|
|
4998
|
+
* @param {BrowserAuthStartRequest} browserAuthStartRequest
|
|
4999
|
+
* @param {*} [options] Override http request option.
|
|
5000
|
+
* @throws {RequiredError}
|
|
5001
|
+
*/
|
|
5002
|
+
start(browserAuthStartRequest, options) {
|
|
5003
|
+
return localVarFp.start(browserAuthStartRequest, options).then((request) => request(axios, basePath));
|
|
5004
|
+
},
|
|
5005
|
+
};
|
|
5006
|
+
};
|
|
5007
|
+
/**
|
|
5008
|
+
* BrowserAuthenticationApi - object-oriented interface
|
|
5009
|
+
*/
|
|
5010
|
+
export class BrowserAuthenticationApi extends BaseAPI {
|
|
5011
|
+
/**
|
|
5012
|
+
*
|
|
5013
|
+
* @summary Open the browser-owned provider session
|
|
5014
|
+
* @param {string} flow
|
|
5015
|
+
* @param {*} [options] Override http request option.
|
|
5016
|
+
* @throws {RequiredError}
|
|
5017
|
+
*/
|
|
5018
|
+
authorize(flow, options) {
|
|
5019
|
+
return BrowserAuthenticationApiFp(this.configuration).authorize(flow, options).then((request) => request(this.axios, this.basePath));
|
|
5020
|
+
}
|
|
5021
|
+
/**
|
|
5022
|
+
* Exchanges an unexpired single-use code only after exact redirect and PKCE verifier checks. Access/refresh tokens are returned in JSON and never in callback URLs.
|
|
5023
|
+
* @summary Exchange a native callback code
|
|
5024
|
+
* @param {BrowserAuthExchangeRequest} browserAuthExchangeRequest
|
|
5025
|
+
* @param {*} [options] Override http request option.
|
|
5026
|
+
* @throws {RequiredError}
|
|
5027
|
+
*/
|
|
5028
|
+
exchange(browserAuthExchangeRequest, options) {
|
|
5029
|
+
return BrowserAuthenticationApiFp(this.configuration).exchange(browserAuthExchangeRequest, options).then((request) => request(this.axios, this.basePath));
|
|
5030
|
+
}
|
|
5031
|
+
/**
|
|
5032
|
+
* Requires an exact configured redirect URI, random client state and S256 PKCE challenge. Open the returned URL in the system browser.
|
|
5033
|
+
* @summary Start browser sign-in
|
|
5034
|
+
* @param {BrowserAuthStartRequest} browserAuthStartRequest
|
|
5035
|
+
* @param {*} [options] Override http request option.
|
|
5036
|
+
* @throws {RequiredError}
|
|
5037
|
+
*/
|
|
5038
|
+
start(browserAuthStartRequest, options) {
|
|
5039
|
+
return BrowserAuthenticationApiFp(this.configuration).start(browserAuthStartRequest, options).then((request) => request(this.axios, this.basePath));
|
|
5040
|
+
}
|
|
5041
|
+
}
|
|
4755
5042
|
/**
|
|
4756
5043
|
* CMSModulesApi - axios parameter creator
|
|
4757
5044
|
*/
|
|
@@ -14018,35 +14305,35 @@ export class ModuleApi extends BaseAPI {
|
|
|
14018
14305
|
}
|
|
14019
14306
|
}
|
|
14020
14307
|
/**
|
|
14021
|
-
*
|
|
14308
|
+
* NavigationApi - axios parameter creator
|
|
14022
14309
|
*/
|
|
14023
|
-
export const
|
|
14310
|
+
export const NavigationApiAxiosParamCreator = function (configuration) {
|
|
14024
14311
|
return {
|
|
14025
14312
|
/**
|
|
14026
|
-
*
|
|
14027
|
-
* @summary
|
|
14028
|
-
* @param {
|
|
14313
|
+
* Selected-company favorites across objects. Archived readable favorites require includeArchived=true. Each result carries only object identity/capability names and view navigation metadata.
|
|
14314
|
+
* @summary Read authorized favorite views
|
|
14315
|
+
* @param {boolean} [includeArchived]
|
|
14029
14316
|
* @param {*} [options] Override http request option.
|
|
14030
14317
|
* @throws {RequiredError}
|
|
14031
14318
|
*/
|
|
14032
|
-
|
|
14033
|
-
|
|
14034
|
-
assertParamExists('dismissNotification', 'notificationId', notificationId);
|
|
14035
|
-
const localVarPath = `/api/v2/notifications/{notificationId}`
|
|
14036
|
-
.replace('{notificationId}', encodeURIComponent(String(notificationId)));
|
|
14319
|
+
favorites: (includeArchived_1, ...args_1) => __awaiter(this, [includeArchived_1, ...args_1], void 0, function* (includeArchived, options = {}) {
|
|
14320
|
+
const localVarPath = `/api/v2/navigation/favorites`;
|
|
14037
14321
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
14038
14322
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
14039
14323
|
let baseOptions;
|
|
14040
14324
|
if (configuration) {
|
|
14041
14325
|
baseOptions = configuration.baseOptions;
|
|
14042
14326
|
}
|
|
14043
|
-
const localVarRequestOptions = Object.assign(Object.assign({ method: '
|
|
14327
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
14044
14328
|
const localVarHeaderParameter = {};
|
|
14045
14329
|
const localVarQueryParameter = {};
|
|
14046
14330
|
// authentication bearerAuth required
|
|
14047
14331
|
// http bearer authentication required
|
|
14048
14332
|
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
14049
|
-
|
|
14333
|
+
if (includeArchived !== undefined) {
|
|
14334
|
+
localVarQueryParameter['includeArchived'] = includeArchived;
|
|
14335
|
+
}
|
|
14336
|
+
localVarHeaderParameter['Accept'] = '*/*,application/json';
|
|
14050
14337
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
14051
14338
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
14052
14339
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
@@ -14056,13 +14343,13 @@ export const NotificationsApiAxiosParamCreator = function (configuration) {
|
|
|
14056
14343
|
};
|
|
14057
14344
|
}),
|
|
14058
14345
|
/**
|
|
14059
|
-
*
|
|
14060
|
-
* @summary
|
|
14346
|
+
* Selected-company object and view summaries with permission-gated menus. Does not load schemas, users, scopes, branding or dashboards.
|
|
14347
|
+
* @summary Read authorized navigation
|
|
14061
14348
|
* @param {*} [options] Override http request option.
|
|
14062
14349
|
* @throws {RequiredError}
|
|
14063
14350
|
*/
|
|
14064
|
-
|
|
14065
|
-
const localVarPath = `/api/v2/
|
|
14351
|
+
navigation: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
|
|
14352
|
+
const localVarPath = `/api/v2/navigation`;
|
|
14066
14353
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
14067
14354
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
14068
14355
|
let baseOptions;
|
|
@@ -14075,7 +14362,7 @@ export const NotificationsApiAxiosParamCreator = function (configuration) {
|
|
|
14075
14362
|
// authentication bearerAuth required
|
|
14076
14363
|
// http bearer authentication required
|
|
14077
14364
|
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
14078
|
-
localVarHeaderParameter['Accept'] = 'application/json';
|
|
14365
|
+
localVarHeaderParameter['Accept'] = '*/*,application/json';
|
|
14079
14366
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
14080
14367
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
14081
14368
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
@@ -14085,63 +14372,64 @@ export const NotificationsApiAxiosParamCreator = function (configuration) {
|
|
|
14085
14372
|
};
|
|
14086
14373
|
}),
|
|
14087
14374
|
/**
|
|
14088
|
-
*
|
|
14089
|
-
* @summary
|
|
14090
|
-
* @param {string}
|
|
14091
|
-
* @param {
|
|
14375
|
+
* Atomic user/company-scoped index and favorite overrides for readable views of this object. Omission preserves; null clears to the legacy default. Does not create sharing edges or change authorization. Requires an actual selected-company user record.
|
|
14376
|
+
* @summary Set personal view navigation preferences
|
|
14377
|
+
* @param {string} objectUuid
|
|
14378
|
+
* @param {ViewNavigationPreferencesRequest} viewNavigationPreferencesRequest
|
|
14092
14379
|
* @param {*} [options] Override http request option.
|
|
14093
14380
|
* @throws {RequiredError}
|
|
14094
14381
|
*/
|
|
14095
|
-
|
|
14096
|
-
|
|
14382
|
+
preferences: (objectUuid_1, viewNavigationPreferencesRequest_1, ...args_1) => __awaiter(this, [objectUuid_1, viewNavigationPreferencesRequest_1, ...args_1], void 0, function* (objectUuid, viewNavigationPreferencesRequest, options = {}) {
|
|
14383
|
+
// verify required parameter 'objectUuid' is not null or undefined
|
|
14384
|
+
assertParamExists('preferences', 'objectUuid', objectUuid);
|
|
14385
|
+
// verify required parameter 'viewNavigationPreferencesRequest' is not null or undefined
|
|
14386
|
+
assertParamExists('preferences', 'viewNavigationPreferencesRequest', viewNavigationPreferencesRequest);
|
|
14387
|
+
const localVarPath = `/api/v2/navigation/objects/{objectUuid}/view-preferences`
|
|
14388
|
+
.replace('{objectUuid}', encodeURIComponent(String(objectUuid)));
|
|
14097
14389
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
14098
14390
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
14099
14391
|
let baseOptions;
|
|
14100
14392
|
if (configuration) {
|
|
14101
14393
|
baseOptions = configuration.baseOptions;
|
|
14102
14394
|
}
|
|
14103
|
-
const localVarRequestOptions = Object.assign(Object.assign({ method: '
|
|
14395
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PUT' }, baseOptions), options);
|
|
14104
14396
|
const localVarHeaderParameter = {};
|
|
14105
14397
|
const localVarQueryParameter = {};
|
|
14106
14398
|
// authentication bearerAuth required
|
|
14107
14399
|
// http bearer authentication required
|
|
14108
14400
|
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
14109
|
-
|
|
14110
|
-
|
|
14111
|
-
}
|
|
14112
|
-
if (limit !== undefined) {
|
|
14113
|
-
localVarQueryParameter['limit'] = limit;
|
|
14114
|
-
}
|
|
14115
|
-
localVarHeaderParameter['Accept'] = 'application/json';
|
|
14401
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
14402
|
+
localVarHeaderParameter['Accept'] = '*/*,application/json';
|
|
14116
14403
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
14117
14404
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
14118
14405
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
14406
|
+
localVarRequestOptions.data = serializeDataIfNeeded(viewNavigationPreferencesRequest, localVarRequestOptions, configuration);
|
|
14119
14407
|
return {
|
|
14120
14408
|
url: toPathString(localVarUrlObj),
|
|
14121
14409
|
options: localVarRequestOptions,
|
|
14122
14410
|
};
|
|
14123
14411
|
}),
|
|
14124
14412
|
/**
|
|
14125
|
-
*
|
|
14126
|
-
* @summary
|
|
14413
|
+
* Scope catalog for managing selected-company user and team permissions. Requires user-management read or app-management write access. App-only callers discover record scopes only for readable objects. This is not a list of the caller\'s granted scopes.
|
|
14414
|
+
* @summary Read available access scopes
|
|
14127
14415
|
* @param {*} [options] Override http request option.
|
|
14128
14416
|
* @throws {RequiredError}
|
|
14129
14417
|
*/
|
|
14130
|
-
|
|
14131
|
-
const localVarPath = `/api/v2/
|
|
14418
|
+
scopes: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
|
|
14419
|
+
const localVarPath = `/api/v2/access/scopes`;
|
|
14132
14420
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
14133
14421
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
14134
14422
|
let baseOptions;
|
|
14135
14423
|
if (configuration) {
|
|
14136
14424
|
baseOptions = configuration.baseOptions;
|
|
14137
14425
|
}
|
|
14138
|
-
const localVarRequestOptions = Object.assign(Object.assign({ method: '
|
|
14426
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
14139
14427
|
const localVarHeaderParameter = {};
|
|
14140
14428
|
const localVarQueryParameter = {};
|
|
14141
14429
|
// authentication bearerAuth required
|
|
14142
14430
|
// http bearer authentication required
|
|
14143
14431
|
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
14144
|
-
localVarHeaderParameter['Accept'] = 'application/json';
|
|
14432
|
+
localVarHeaderParameter['Accept'] = '*/*,application/json';
|
|
14145
14433
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
14146
14434
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
14147
14435
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
@@ -14151,30 +14439,34 @@ export const NotificationsApiAxiosParamCreator = function (configuration) {
|
|
|
14151
14439
|
};
|
|
14152
14440
|
}),
|
|
14153
14441
|
/**
|
|
14154
|
-
*
|
|
14155
|
-
* @summary
|
|
14156
|
-
* @param {string}
|
|
14442
|
+
* Intent-loaded selected-company metadata. Archived readable views are included only with includeArchived=true; no filters, schemas or sharing grants are returned.
|
|
14443
|
+
* @summary Read authorized view navigation summaries
|
|
14444
|
+
* @param {string} objectUuid
|
|
14445
|
+
* @param {boolean} [includeArchived]
|
|
14157
14446
|
* @param {*} [options] Override http request option.
|
|
14158
14447
|
* @throws {RequiredError}
|
|
14159
14448
|
*/
|
|
14160
|
-
|
|
14161
|
-
// verify required parameter '
|
|
14162
|
-
assertParamExists('
|
|
14163
|
-
const localVarPath = `/api/v2/
|
|
14164
|
-
.replace('{
|
|
14449
|
+
views: (objectUuid_1, includeArchived_1, ...args_1) => __awaiter(this, [objectUuid_1, includeArchived_1, ...args_1], void 0, function* (objectUuid, includeArchived, options = {}) {
|
|
14450
|
+
// verify required parameter 'objectUuid' is not null or undefined
|
|
14451
|
+
assertParamExists('views', 'objectUuid', objectUuid);
|
|
14452
|
+
const localVarPath = `/api/v2/navigation/objects/{objectUuid}/views`
|
|
14453
|
+
.replace('{objectUuid}', encodeURIComponent(String(objectUuid)));
|
|
14165
14454
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
14166
14455
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
14167
14456
|
let baseOptions;
|
|
14168
14457
|
if (configuration) {
|
|
14169
14458
|
baseOptions = configuration.baseOptions;
|
|
14170
14459
|
}
|
|
14171
|
-
const localVarRequestOptions = Object.assign(Object.assign({ method: '
|
|
14460
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
14172
14461
|
const localVarHeaderParameter = {};
|
|
14173
14462
|
const localVarQueryParameter = {};
|
|
14174
14463
|
// authentication bearerAuth required
|
|
14175
14464
|
// http bearer authentication required
|
|
14176
14465
|
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
14177
|
-
|
|
14466
|
+
if (includeArchived !== undefined) {
|
|
14467
|
+
localVarQueryParameter['includeArchived'] = includeArchived;
|
|
14468
|
+
}
|
|
14469
|
+
localVarHeaderParameter['Accept'] = '*/*,application/json';
|
|
14178
14470
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
14179
14471
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
14180
14472
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
@@ -14183,25 +14475,465 @@ export const NotificationsApiAxiosParamCreator = function (configuration) {
|
|
|
14183
14475
|
options: localVarRequestOptions,
|
|
14184
14476
|
};
|
|
14185
14477
|
}),
|
|
14478
|
+
};
|
|
14479
|
+
};
|
|
14480
|
+
/**
|
|
14481
|
+
* NavigationApi - functional programming interface
|
|
14482
|
+
*/
|
|
14483
|
+
export const NavigationApiFp = function (configuration) {
|
|
14484
|
+
const localVarAxiosParamCreator = NavigationApiAxiosParamCreator(configuration);
|
|
14485
|
+
return {
|
|
14186
14486
|
/**
|
|
14187
|
-
*
|
|
14188
|
-
* @summary
|
|
14189
|
-
* @param {
|
|
14487
|
+
* Selected-company favorites across objects. Archived readable favorites require includeArchived=true. Each result carries only object identity/capability names and view navigation metadata.
|
|
14488
|
+
* @summary Read authorized favorite views
|
|
14489
|
+
* @param {boolean} [includeArchived]
|
|
14190
14490
|
* @param {*} [options] Override http request option.
|
|
14191
14491
|
* @throws {RequiredError}
|
|
14192
14492
|
*/
|
|
14193
|
-
|
|
14194
|
-
|
|
14195
|
-
|
|
14196
|
-
|
|
14197
|
-
|
|
14198
|
-
|
|
14199
|
-
|
|
14200
|
-
|
|
14201
|
-
|
|
14202
|
-
|
|
14203
|
-
|
|
14204
|
-
|
|
14493
|
+
favorites(includeArchived, options) {
|
|
14494
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
14495
|
+
var _a, _b, _c;
|
|
14496
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.favorites(includeArchived, options);
|
|
14497
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
14498
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['NavigationApi.favorites']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
14499
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
14500
|
+
});
|
|
14501
|
+
},
|
|
14502
|
+
/**
|
|
14503
|
+
* Selected-company object and view summaries with permission-gated menus. Does not load schemas, users, scopes, branding or dashboards.
|
|
14504
|
+
* @summary Read authorized navigation
|
|
14505
|
+
* @param {*} [options] Override http request option.
|
|
14506
|
+
* @throws {RequiredError}
|
|
14507
|
+
*/
|
|
14508
|
+
navigation(options) {
|
|
14509
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
14510
|
+
var _a, _b, _c;
|
|
14511
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.navigation(options);
|
|
14512
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
14513
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['NavigationApi.navigation']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
14514
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
14515
|
+
});
|
|
14516
|
+
},
|
|
14517
|
+
/**
|
|
14518
|
+
* Atomic user/company-scoped index and favorite overrides for readable views of this object. Omission preserves; null clears to the legacy default. Does not create sharing edges or change authorization. Requires an actual selected-company user record.
|
|
14519
|
+
* @summary Set personal view navigation preferences
|
|
14520
|
+
* @param {string} objectUuid
|
|
14521
|
+
* @param {ViewNavigationPreferencesRequest} viewNavigationPreferencesRequest
|
|
14522
|
+
* @param {*} [options] Override http request option.
|
|
14523
|
+
* @throws {RequiredError}
|
|
14524
|
+
*/
|
|
14525
|
+
preferences(objectUuid, viewNavigationPreferencesRequest, options) {
|
|
14526
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
14527
|
+
var _a, _b, _c;
|
|
14528
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.preferences(objectUuid, viewNavigationPreferencesRequest, options);
|
|
14529
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
14530
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['NavigationApi.preferences']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
14531
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
14532
|
+
});
|
|
14533
|
+
},
|
|
14534
|
+
/**
|
|
14535
|
+
* Scope catalog for managing selected-company user and team permissions. Requires user-management read or app-management write access. App-only callers discover record scopes only for readable objects. This is not a list of the caller\'s granted scopes.
|
|
14536
|
+
* @summary Read available access scopes
|
|
14537
|
+
* @param {*} [options] Override http request option.
|
|
14538
|
+
* @throws {RequiredError}
|
|
14539
|
+
*/
|
|
14540
|
+
scopes(options) {
|
|
14541
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
14542
|
+
var _a, _b, _c;
|
|
14543
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.scopes(options);
|
|
14544
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
14545
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['NavigationApi.scopes']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
14546
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
14547
|
+
});
|
|
14548
|
+
},
|
|
14549
|
+
/**
|
|
14550
|
+
* Intent-loaded selected-company metadata. Archived readable views are included only with includeArchived=true; no filters, schemas or sharing grants are returned.
|
|
14551
|
+
* @summary Read authorized view navigation summaries
|
|
14552
|
+
* @param {string} objectUuid
|
|
14553
|
+
* @param {boolean} [includeArchived]
|
|
14554
|
+
* @param {*} [options] Override http request option.
|
|
14555
|
+
* @throws {RequiredError}
|
|
14556
|
+
*/
|
|
14557
|
+
views(objectUuid, includeArchived, options) {
|
|
14558
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
14559
|
+
var _a, _b, _c;
|
|
14560
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.views(objectUuid, includeArchived, options);
|
|
14561
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
14562
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['NavigationApi.views']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
14563
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
14564
|
+
});
|
|
14565
|
+
},
|
|
14566
|
+
};
|
|
14567
|
+
};
|
|
14568
|
+
/**
|
|
14569
|
+
* NavigationApi - factory interface
|
|
14570
|
+
*/
|
|
14571
|
+
export const NavigationApiFactory = function (configuration, basePath, axios) {
|
|
14572
|
+
const localVarFp = NavigationApiFp(configuration);
|
|
14573
|
+
return {
|
|
14574
|
+
/**
|
|
14575
|
+
* Selected-company favorites across objects. Archived readable favorites require includeArchived=true. Each result carries only object identity/capability names and view navigation metadata.
|
|
14576
|
+
* @summary Read authorized favorite views
|
|
14577
|
+
* @param {boolean} [includeArchived]
|
|
14578
|
+
* @param {*} [options] Override http request option.
|
|
14579
|
+
* @throws {RequiredError}
|
|
14580
|
+
*/
|
|
14581
|
+
favorites(includeArchived, options) {
|
|
14582
|
+
return localVarFp.favorites(includeArchived, options).then((request) => request(axios, basePath));
|
|
14583
|
+
},
|
|
14584
|
+
/**
|
|
14585
|
+
* Selected-company object and view summaries with permission-gated menus. Does not load schemas, users, scopes, branding or dashboards.
|
|
14586
|
+
* @summary Read authorized navigation
|
|
14587
|
+
* @param {*} [options] Override http request option.
|
|
14588
|
+
* @throws {RequiredError}
|
|
14589
|
+
*/
|
|
14590
|
+
navigation(options) {
|
|
14591
|
+
return localVarFp.navigation(options).then((request) => request(axios, basePath));
|
|
14592
|
+
},
|
|
14593
|
+
/**
|
|
14594
|
+
* Atomic user/company-scoped index and favorite overrides for readable views of this object. Omission preserves; null clears to the legacy default. Does not create sharing edges or change authorization. Requires an actual selected-company user record.
|
|
14595
|
+
* @summary Set personal view navigation preferences
|
|
14596
|
+
* @param {string} objectUuid
|
|
14597
|
+
* @param {ViewNavigationPreferencesRequest} viewNavigationPreferencesRequest
|
|
14598
|
+
* @param {*} [options] Override http request option.
|
|
14599
|
+
* @throws {RequiredError}
|
|
14600
|
+
*/
|
|
14601
|
+
preferences(objectUuid, viewNavigationPreferencesRequest, options) {
|
|
14602
|
+
return localVarFp.preferences(objectUuid, viewNavigationPreferencesRequest, options).then((request) => request(axios, basePath));
|
|
14603
|
+
},
|
|
14604
|
+
/**
|
|
14605
|
+
* Scope catalog for managing selected-company user and team permissions. Requires user-management read or app-management write access. App-only callers discover record scopes only for readable objects. This is not a list of the caller\'s granted scopes.
|
|
14606
|
+
* @summary Read available access scopes
|
|
14607
|
+
* @param {*} [options] Override http request option.
|
|
14608
|
+
* @throws {RequiredError}
|
|
14609
|
+
*/
|
|
14610
|
+
scopes(options) {
|
|
14611
|
+
return localVarFp.scopes(options).then((request) => request(axios, basePath));
|
|
14612
|
+
},
|
|
14613
|
+
/**
|
|
14614
|
+
* Intent-loaded selected-company metadata. Archived readable views are included only with includeArchived=true; no filters, schemas or sharing grants are returned.
|
|
14615
|
+
* @summary Read authorized view navigation summaries
|
|
14616
|
+
* @param {string} objectUuid
|
|
14617
|
+
* @param {boolean} [includeArchived]
|
|
14618
|
+
* @param {*} [options] Override http request option.
|
|
14619
|
+
* @throws {RequiredError}
|
|
14620
|
+
*/
|
|
14621
|
+
views(objectUuid, includeArchived, options) {
|
|
14622
|
+
return localVarFp.views(objectUuid, includeArchived, options).then((request) => request(axios, basePath));
|
|
14623
|
+
},
|
|
14624
|
+
};
|
|
14625
|
+
};
|
|
14626
|
+
/**
|
|
14627
|
+
* NavigationApi - object-oriented interface
|
|
14628
|
+
*/
|
|
14629
|
+
export class NavigationApi extends BaseAPI {
|
|
14630
|
+
/**
|
|
14631
|
+
* Selected-company favorites across objects. Archived readable favorites require includeArchived=true. Each result carries only object identity/capability names and view navigation metadata.
|
|
14632
|
+
* @summary Read authorized favorite views
|
|
14633
|
+
* @param {boolean} [includeArchived]
|
|
14634
|
+
* @param {*} [options] Override http request option.
|
|
14635
|
+
* @throws {RequiredError}
|
|
14636
|
+
*/
|
|
14637
|
+
favorites(includeArchived, options) {
|
|
14638
|
+
return NavigationApiFp(this.configuration).favorites(includeArchived, options).then((request) => request(this.axios, this.basePath));
|
|
14639
|
+
}
|
|
14640
|
+
/**
|
|
14641
|
+
* Selected-company object and view summaries with permission-gated menus. Does not load schemas, users, scopes, branding or dashboards.
|
|
14642
|
+
* @summary Read authorized navigation
|
|
14643
|
+
* @param {*} [options] Override http request option.
|
|
14644
|
+
* @throws {RequiredError}
|
|
14645
|
+
*/
|
|
14646
|
+
navigation(options) {
|
|
14647
|
+
return NavigationApiFp(this.configuration).navigation(options).then((request) => request(this.axios, this.basePath));
|
|
14648
|
+
}
|
|
14649
|
+
/**
|
|
14650
|
+
* Atomic user/company-scoped index and favorite overrides for readable views of this object. Omission preserves; null clears to the legacy default. Does not create sharing edges or change authorization. Requires an actual selected-company user record.
|
|
14651
|
+
* @summary Set personal view navigation preferences
|
|
14652
|
+
* @param {string} objectUuid
|
|
14653
|
+
* @param {ViewNavigationPreferencesRequest} viewNavigationPreferencesRequest
|
|
14654
|
+
* @param {*} [options] Override http request option.
|
|
14655
|
+
* @throws {RequiredError}
|
|
14656
|
+
*/
|
|
14657
|
+
preferences(objectUuid, viewNavigationPreferencesRequest, options) {
|
|
14658
|
+
return NavigationApiFp(this.configuration).preferences(objectUuid, viewNavigationPreferencesRequest, options).then((request) => request(this.axios, this.basePath));
|
|
14659
|
+
}
|
|
14660
|
+
/**
|
|
14661
|
+
* Scope catalog for managing selected-company user and team permissions. Requires user-management read or app-management write access. App-only callers discover record scopes only for readable objects. This is not a list of the caller\'s granted scopes.
|
|
14662
|
+
* @summary Read available access scopes
|
|
14663
|
+
* @param {*} [options] Override http request option.
|
|
14664
|
+
* @throws {RequiredError}
|
|
14665
|
+
*/
|
|
14666
|
+
scopes(options) {
|
|
14667
|
+
return NavigationApiFp(this.configuration).scopes(options).then((request) => request(this.axios, this.basePath));
|
|
14668
|
+
}
|
|
14669
|
+
/**
|
|
14670
|
+
* Intent-loaded selected-company metadata. Archived readable views are included only with includeArchived=true; no filters, schemas or sharing grants are returned.
|
|
14671
|
+
* @summary Read authorized view navigation summaries
|
|
14672
|
+
* @param {string} objectUuid
|
|
14673
|
+
* @param {boolean} [includeArchived]
|
|
14674
|
+
* @param {*} [options] Override http request option.
|
|
14675
|
+
* @throws {RequiredError}
|
|
14676
|
+
*/
|
|
14677
|
+
views(objectUuid, includeArchived, options) {
|
|
14678
|
+
return NavigationApiFp(this.configuration).views(objectUuid, includeArchived, options).then((request) => request(this.axios, this.basePath));
|
|
14679
|
+
}
|
|
14680
|
+
}
|
|
14681
|
+
/**
|
|
14682
|
+
* NotificationsApi - axios parameter creator
|
|
14683
|
+
*/
|
|
14684
|
+
export const NotificationsApiAxiosParamCreator = function (configuration) {
|
|
14685
|
+
return {
|
|
14686
|
+
/**
|
|
14687
|
+
*
|
|
14688
|
+
* @summary Dismiss a notification
|
|
14689
|
+
* @param {string} notificationId Firestore notification document ID
|
|
14690
|
+
* @param {*} [options] Override http request option.
|
|
14691
|
+
* @throws {RequiredError}
|
|
14692
|
+
*/
|
|
14693
|
+
dismissNotification: (notificationId_1, ...args_1) => __awaiter(this, [notificationId_1, ...args_1], void 0, function* (notificationId, options = {}) {
|
|
14694
|
+
// verify required parameter 'notificationId' is not null or undefined
|
|
14695
|
+
assertParamExists('dismissNotification', 'notificationId', notificationId);
|
|
14696
|
+
const localVarPath = `/api/v2/notifications/{notificationId}`
|
|
14697
|
+
.replace('{notificationId}', encodeURIComponent(String(notificationId)));
|
|
14698
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
14699
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
14700
|
+
let baseOptions;
|
|
14701
|
+
if (configuration) {
|
|
14702
|
+
baseOptions = configuration.baseOptions;
|
|
14703
|
+
}
|
|
14704
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
|
|
14705
|
+
const localVarHeaderParameter = {};
|
|
14706
|
+
const localVarQueryParameter = {};
|
|
14707
|
+
// authentication bearerAuth required
|
|
14708
|
+
// http bearer authentication required
|
|
14709
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
14710
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
14711
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
14712
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
14713
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
14714
|
+
return {
|
|
14715
|
+
url: toPathString(localVarUrlObj),
|
|
14716
|
+
options: localVarRequestOptions,
|
|
14717
|
+
};
|
|
14718
|
+
}),
|
|
14719
|
+
/**
|
|
14720
|
+
*
|
|
14721
|
+
* @summary Mint a Firebase custom token so the app can listen to its inbox
|
|
14722
|
+
* @param {*} [options] Override http request option.
|
|
14723
|
+
* @throws {RequiredError}
|
|
14724
|
+
*/
|
|
14725
|
+
firebaseToken: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
|
|
14726
|
+
const localVarPath = `/api/v2/notifications/firebase-token`;
|
|
14727
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
14728
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
14729
|
+
let baseOptions;
|
|
14730
|
+
if (configuration) {
|
|
14731
|
+
baseOptions = configuration.baseOptions;
|
|
14732
|
+
}
|
|
14733
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
14734
|
+
const localVarHeaderParameter = {};
|
|
14735
|
+
const localVarQueryParameter = {};
|
|
14736
|
+
// authentication bearerAuth required
|
|
14737
|
+
// http bearer authentication required
|
|
14738
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
14739
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
14740
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
14741
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
14742
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
14743
|
+
return {
|
|
14744
|
+
url: toPathString(localVarUrlObj),
|
|
14745
|
+
options: localVarRequestOptions,
|
|
14746
|
+
};
|
|
14747
|
+
}),
|
|
14748
|
+
/**
|
|
14749
|
+
* Returns an inbox entry only for its human recipient in the authorized selected company, including entries outside the inbox page.
|
|
14750
|
+
* @summary Get an authoritative notification by ID
|
|
14751
|
+
* @param {string} notificationId
|
|
14752
|
+
* @param {*} [options] Override http request option.
|
|
14753
|
+
* @throws {RequiredError}
|
|
14754
|
+
*/
|
|
14755
|
+
getNotification: (notificationId_1, ...args_1) => __awaiter(this, [notificationId_1, ...args_1], void 0, function* (notificationId, options = {}) {
|
|
14756
|
+
// verify required parameter 'notificationId' is not null or undefined
|
|
14757
|
+
assertParamExists('getNotification', 'notificationId', notificationId);
|
|
14758
|
+
const localVarPath = `/api/v2/notifications/{notificationId}`
|
|
14759
|
+
.replace('{notificationId}', encodeURIComponent(String(notificationId)));
|
|
14760
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
14761
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
14762
|
+
let baseOptions;
|
|
14763
|
+
if (configuration) {
|
|
14764
|
+
baseOptions = configuration.baseOptions;
|
|
14765
|
+
}
|
|
14766
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
14767
|
+
const localVarHeaderParameter = {};
|
|
14768
|
+
const localVarQueryParameter = {};
|
|
14769
|
+
// authentication bearerAuth required
|
|
14770
|
+
// http bearer authentication required
|
|
14771
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
14772
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
14773
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
14774
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
14775
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
14776
|
+
return {
|
|
14777
|
+
url: toPathString(localVarUrlObj),
|
|
14778
|
+
options: localVarRequestOptions,
|
|
14779
|
+
};
|
|
14780
|
+
}),
|
|
14781
|
+
/**
|
|
14782
|
+
* Returns notifications for the selected company plus user-general notifications that have no company. Other companies are never included.
|
|
14783
|
+
* @summary List in-app notifications for the logged-in user
|
|
14784
|
+
* @param {string} [company]
|
|
14785
|
+
* @param {number} [limit]
|
|
14786
|
+
* @param {*} [options] Override http request option.
|
|
14787
|
+
* @throws {RequiredError}
|
|
14788
|
+
*/
|
|
14789
|
+
listNotifications: (company_1, limit_1, ...args_1) => __awaiter(this, [company_1, limit_1, ...args_1], void 0, function* (company, limit, options = {}) {
|
|
14790
|
+
const localVarPath = `/api/v2/notifications`;
|
|
14791
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
14792
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
14793
|
+
let baseOptions;
|
|
14794
|
+
if (configuration) {
|
|
14795
|
+
baseOptions = configuration.baseOptions;
|
|
14796
|
+
}
|
|
14797
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
14798
|
+
const localVarHeaderParameter = {};
|
|
14799
|
+
const localVarQueryParameter = {};
|
|
14800
|
+
// authentication bearerAuth required
|
|
14801
|
+
// http bearer authentication required
|
|
14802
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
14803
|
+
if (company !== undefined) {
|
|
14804
|
+
localVarQueryParameter['company'] = company;
|
|
14805
|
+
}
|
|
14806
|
+
if (limit !== undefined) {
|
|
14807
|
+
localVarQueryParameter['limit'] = limit;
|
|
14808
|
+
}
|
|
14809
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
14810
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
14811
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
14812
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
14813
|
+
return {
|
|
14814
|
+
url: toPathString(localVarUrlObj),
|
|
14815
|
+
options: localVarRequestOptions,
|
|
14816
|
+
};
|
|
14817
|
+
}),
|
|
14818
|
+
/**
|
|
14819
|
+
*
|
|
14820
|
+
* @summary Mark all notifications as read
|
|
14821
|
+
* @param {*} [options] Override http request option.
|
|
14822
|
+
* @throws {RequiredError}
|
|
14823
|
+
*/
|
|
14824
|
+
markAllAsRead: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
|
|
14825
|
+
const localVarPath = `/api/v2/notifications/read-all`;
|
|
14826
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
14827
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
14828
|
+
let baseOptions;
|
|
14829
|
+
if (configuration) {
|
|
14830
|
+
baseOptions = configuration.baseOptions;
|
|
14831
|
+
}
|
|
14832
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PATCH' }, baseOptions), options);
|
|
14833
|
+
const localVarHeaderParameter = {};
|
|
14834
|
+
const localVarQueryParameter = {};
|
|
14835
|
+
// authentication bearerAuth required
|
|
14836
|
+
// http bearer authentication required
|
|
14837
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
14838
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
14839
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
14840
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
14841
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
14842
|
+
return {
|
|
14843
|
+
url: toPathString(localVarUrlObj),
|
|
14844
|
+
options: localVarRequestOptions,
|
|
14845
|
+
};
|
|
14846
|
+
}),
|
|
14847
|
+
/**
|
|
14848
|
+
*
|
|
14849
|
+
* @summary Mark a notification as read
|
|
14850
|
+
* @param {string} notificationId Firestore notification document ID
|
|
14851
|
+
* @param {*} [options] Override http request option.
|
|
14852
|
+
* @throws {RequiredError}
|
|
14853
|
+
*/
|
|
14854
|
+
markAsRead: (notificationId_1, ...args_1) => __awaiter(this, [notificationId_1, ...args_1], void 0, function* (notificationId, options = {}) {
|
|
14855
|
+
// verify required parameter 'notificationId' is not null or undefined
|
|
14856
|
+
assertParamExists('markAsRead', 'notificationId', notificationId);
|
|
14857
|
+
const localVarPath = `/api/v2/notifications/{notificationId}/read`
|
|
14858
|
+
.replace('{notificationId}', encodeURIComponent(String(notificationId)));
|
|
14859
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
14860
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
14861
|
+
let baseOptions;
|
|
14862
|
+
if (configuration) {
|
|
14863
|
+
baseOptions = configuration.baseOptions;
|
|
14864
|
+
}
|
|
14865
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PATCH' }, baseOptions), options);
|
|
14866
|
+
const localVarHeaderParameter = {};
|
|
14867
|
+
const localVarQueryParameter = {};
|
|
14868
|
+
// authentication bearerAuth required
|
|
14869
|
+
// http bearer authentication required
|
|
14870
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
14871
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
14872
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
14873
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
14874
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
14875
|
+
return {
|
|
14876
|
+
url: toPathString(localVarUrlObj),
|
|
14877
|
+
options: localVarRequestOptions,
|
|
14878
|
+
};
|
|
14879
|
+
}),
|
|
14880
|
+
/**
|
|
14881
|
+
* Idempotently registers an allowed native application. Human authentication required. Does not accept a target user or company. Rotate the registration when moving between accounts.
|
|
14882
|
+
* @summary Register this user\'s native notification device
|
|
14883
|
+
* @param {string} deviceInstallationId
|
|
14884
|
+
* @param {NotificationDeviceRegistration} notificationDeviceRegistration
|
|
14885
|
+
* @param {*} [options] Override http request option.
|
|
14886
|
+
* @throws {RequiredError}
|
|
14887
|
+
*/
|
|
14888
|
+
registerDevice: (deviceInstallationId_1, notificationDeviceRegistration_1, ...args_1) => __awaiter(this, [deviceInstallationId_1, notificationDeviceRegistration_1, ...args_1], void 0, function* (deviceInstallationId, notificationDeviceRegistration, options = {}) {
|
|
14889
|
+
// verify required parameter 'deviceInstallationId' is not null or undefined
|
|
14890
|
+
assertParamExists('registerDevice', 'deviceInstallationId', deviceInstallationId);
|
|
14891
|
+
// verify required parameter 'notificationDeviceRegistration' is not null or undefined
|
|
14892
|
+
assertParamExists('registerDevice', 'notificationDeviceRegistration', notificationDeviceRegistration);
|
|
14893
|
+
const localVarPath = `/api/v2/notifications/devices/{deviceInstallationId}`
|
|
14894
|
+
.replace('{deviceInstallationId}', encodeURIComponent(String(deviceInstallationId)));
|
|
14895
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
14896
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
14897
|
+
let baseOptions;
|
|
14898
|
+
if (configuration) {
|
|
14899
|
+
baseOptions = configuration.baseOptions;
|
|
14900
|
+
}
|
|
14901
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PUT' }, baseOptions), options);
|
|
14902
|
+
const localVarHeaderParameter = {};
|
|
14903
|
+
const localVarQueryParameter = {};
|
|
14904
|
+
// authentication bearerAuth required
|
|
14905
|
+
// http bearer authentication required
|
|
14906
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
14907
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
14908
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
14909
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
14910
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
14911
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
14912
|
+
localVarRequestOptions.data = serializeDataIfNeeded(notificationDeviceRegistration, localVarRequestOptions, configuration);
|
|
14913
|
+
return {
|
|
14914
|
+
url: toPathString(localVarUrlObj),
|
|
14915
|
+
options: localVarRequestOptions,
|
|
14916
|
+
};
|
|
14917
|
+
}),
|
|
14918
|
+
/**
|
|
14919
|
+
* Installed apps call this endpoint after async work completes. Authenticate with the installation token (Authorization: Bearer or X-CARAER-TOKEN). Every notification is scoped to the app\'s company. Omit targetUserUuid to notify every user in that company, or set it to aim the notification at one member.
|
|
14920
|
+
* @summary Send a notification (app token)
|
|
14921
|
+
* @param {SendNotificationRequest} sendNotificationRequest
|
|
14922
|
+
* @param {*} [options] Override http request option.
|
|
14923
|
+
* @throws {RequiredError}
|
|
14924
|
+
*/
|
|
14925
|
+
sendNotification: (sendNotificationRequest_1, ...args_1) => __awaiter(this, [sendNotificationRequest_1, ...args_1], void 0, function* (sendNotificationRequest, options = {}) {
|
|
14926
|
+
// verify required parameter 'sendNotificationRequest' is not null or undefined
|
|
14927
|
+
assertParamExists('sendNotification', 'sendNotificationRequest', sendNotificationRequest);
|
|
14928
|
+
const localVarPath = `/api/v2/notifications`;
|
|
14929
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
14930
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
14931
|
+
let baseOptions;
|
|
14932
|
+
if (configuration) {
|
|
14933
|
+
baseOptions = configuration.baseOptions;
|
|
14934
|
+
}
|
|
14935
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
14936
|
+
const localVarHeaderParameter = {};
|
|
14205
14937
|
const localVarQueryParameter = {};
|
|
14206
14938
|
// authentication bearerAuth required
|
|
14207
14939
|
// http bearer authentication required
|
|
@@ -14217,6 +14949,39 @@ export const NotificationsApiAxiosParamCreator = function (configuration) {
|
|
|
14217
14949
|
options: localVarRequestOptions,
|
|
14218
14950
|
};
|
|
14219
14951
|
}),
|
|
14952
|
+
/**
|
|
14953
|
+
* Idempotent. Call before logout; other users\' device registrations are inaccessible.
|
|
14954
|
+
* @summary Unregister this user\'s native notification device
|
|
14955
|
+
* @param {string} deviceInstallationId
|
|
14956
|
+
* @param {*} [options] Override http request option.
|
|
14957
|
+
* @throws {RequiredError}
|
|
14958
|
+
*/
|
|
14959
|
+
unregisterDevice: (deviceInstallationId_1, ...args_1) => __awaiter(this, [deviceInstallationId_1, ...args_1], void 0, function* (deviceInstallationId, options = {}) {
|
|
14960
|
+
// verify required parameter 'deviceInstallationId' is not null or undefined
|
|
14961
|
+
assertParamExists('unregisterDevice', 'deviceInstallationId', deviceInstallationId);
|
|
14962
|
+
const localVarPath = `/api/v2/notifications/devices/{deviceInstallationId}`
|
|
14963
|
+
.replace('{deviceInstallationId}', encodeURIComponent(String(deviceInstallationId)));
|
|
14964
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
14965
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
14966
|
+
let baseOptions;
|
|
14967
|
+
if (configuration) {
|
|
14968
|
+
baseOptions = configuration.baseOptions;
|
|
14969
|
+
}
|
|
14970
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
|
|
14971
|
+
const localVarHeaderParameter = {};
|
|
14972
|
+
const localVarQueryParameter = {};
|
|
14973
|
+
// authentication bearerAuth required
|
|
14974
|
+
// http bearer authentication required
|
|
14975
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
14976
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
14977
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
14978
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
14979
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
14980
|
+
return {
|
|
14981
|
+
url: toPathString(localVarUrlObj),
|
|
14982
|
+
options: localVarRequestOptions,
|
|
14983
|
+
};
|
|
14984
|
+
}),
|
|
14220
14985
|
};
|
|
14221
14986
|
};
|
|
14222
14987
|
/**
|
|
@@ -14256,6 +15021,22 @@ export const NotificationsApiFp = function (configuration) {
|
|
|
14256
15021
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
14257
15022
|
});
|
|
14258
15023
|
},
|
|
15024
|
+
/**
|
|
15025
|
+
* Returns an inbox entry only for its human recipient in the authorized selected company, including entries outside the inbox page.
|
|
15026
|
+
* @summary Get an authoritative notification by ID
|
|
15027
|
+
* @param {string} notificationId
|
|
15028
|
+
* @param {*} [options] Override http request option.
|
|
15029
|
+
* @throws {RequiredError}
|
|
15030
|
+
*/
|
|
15031
|
+
getNotification(notificationId, options) {
|
|
15032
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
15033
|
+
var _a, _b, _c;
|
|
15034
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getNotification(notificationId, options);
|
|
15035
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
15036
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['NotificationsApi.getNotification']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
15037
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15038
|
+
});
|
|
15039
|
+
},
|
|
14259
15040
|
/**
|
|
14260
15041
|
* Returns notifications for the selected company plus user-general notifications that have no company. Other companies are never included.
|
|
14261
15042
|
* @summary List in-app notifications for the logged-in user
|
|
@@ -14304,6 +15085,23 @@ export const NotificationsApiFp = function (configuration) {
|
|
|
14304
15085
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
14305
15086
|
});
|
|
14306
15087
|
},
|
|
15088
|
+
/**
|
|
15089
|
+
* Idempotently registers an allowed native application. Human authentication required. Does not accept a target user or company. Rotate the registration when moving between accounts.
|
|
15090
|
+
* @summary Register this user\'s native notification device
|
|
15091
|
+
* @param {string} deviceInstallationId
|
|
15092
|
+
* @param {NotificationDeviceRegistration} notificationDeviceRegistration
|
|
15093
|
+
* @param {*} [options] Override http request option.
|
|
15094
|
+
* @throws {RequiredError}
|
|
15095
|
+
*/
|
|
15096
|
+
registerDevice(deviceInstallationId, notificationDeviceRegistration, options) {
|
|
15097
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
15098
|
+
var _a, _b, _c;
|
|
15099
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.registerDevice(deviceInstallationId, notificationDeviceRegistration, options);
|
|
15100
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
15101
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['NotificationsApi.registerDevice']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
15102
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15103
|
+
});
|
|
15104
|
+
},
|
|
14307
15105
|
/**
|
|
14308
15106
|
* Installed apps call this endpoint after async work completes. Authenticate with the installation token (Authorization: Bearer or X-CARAER-TOKEN). Every notification is scoped to the app\'s company. Omit targetUserUuid to notify every user in that company, or set it to aim the notification at one member.
|
|
14309
15107
|
* @summary Send a notification (app token)
|
|
@@ -14320,6 +15118,22 @@ export const NotificationsApiFp = function (configuration) {
|
|
|
14320
15118
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
14321
15119
|
});
|
|
14322
15120
|
},
|
|
15121
|
+
/**
|
|
15122
|
+
* Idempotent. Call before logout; other users\' device registrations are inaccessible.
|
|
15123
|
+
* @summary Unregister this user\'s native notification device
|
|
15124
|
+
* @param {string} deviceInstallationId
|
|
15125
|
+
* @param {*} [options] Override http request option.
|
|
15126
|
+
* @throws {RequiredError}
|
|
15127
|
+
*/
|
|
15128
|
+
unregisterDevice(deviceInstallationId, options) {
|
|
15129
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
15130
|
+
var _a, _b, _c;
|
|
15131
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.unregisterDevice(deviceInstallationId, options);
|
|
15132
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
15133
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['NotificationsApi.unregisterDevice']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
15134
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15135
|
+
});
|
|
15136
|
+
},
|
|
14323
15137
|
};
|
|
14324
15138
|
};
|
|
14325
15139
|
/**
|
|
@@ -14347,6 +15161,16 @@ export const NotificationsApiFactory = function (configuration, basePath, axios)
|
|
|
14347
15161
|
firebaseToken(options) {
|
|
14348
15162
|
return localVarFp.firebaseToken(options).then((request) => request(axios, basePath));
|
|
14349
15163
|
},
|
|
15164
|
+
/**
|
|
15165
|
+
* Returns an inbox entry only for its human recipient in the authorized selected company, including entries outside the inbox page.
|
|
15166
|
+
* @summary Get an authoritative notification by ID
|
|
15167
|
+
* @param {string} notificationId
|
|
15168
|
+
* @param {*} [options] Override http request option.
|
|
15169
|
+
* @throws {RequiredError}
|
|
15170
|
+
*/
|
|
15171
|
+
getNotification(notificationId, options) {
|
|
15172
|
+
return localVarFp.getNotification(notificationId, options).then((request) => request(axios, basePath));
|
|
15173
|
+
},
|
|
14350
15174
|
/**
|
|
14351
15175
|
* Returns notifications for the selected company plus user-general notifications that have no company. Other companies are never included.
|
|
14352
15176
|
* @summary List in-app notifications for the logged-in user
|
|
@@ -14377,6 +15201,17 @@ export const NotificationsApiFactory = function (configuration, basePath, axios)
|
|
|
14377
15201
|
markAsRead(notificationId, options) {
|
|
14378
15202
|
return localVarFp.markAsRead(notificationId, options).then((request) => request(axios, basePath));
|
|
14379
15203
|
},
|
|
15204
|
+
/**
|
|
15205
|
+
* Idempotently registers an allowed native application. Human authentication required. Does not accept a target user or company. Rotate the registration when moving between accounts.
|
|
15206
|
+
* @summary Register this user\'s native notification device
|
|
15207
|
+
* @param {string} deviceInstallationId
|
|
15208
|
+
* @param {NotificationDeviceRegistration} notificationDeviceRegistration
|
|
15209
|
+
* @param {*} [options] Override http request option.
|
|
15210
|
+
* @throws {RequiredError}
|
|
15211
|
+
*/
|
|
15212
|
+
registerDevice(deviceInstallationId, notificationDeviceRegistration, options) {
|
|
15213
|
+
return localVarFp.registerDevice(deviceInstallationId, notificationDeviceRegistration, options).then((request) => request(axios, basePath));
|
|
15214
|
+
},
|
|
14380
15215
|
/**
|
|
14381
15216
|
* Installed apps call this endpoint after async work completes. Authenticate with the installation token (Authorization: Bearer or X-CARAER-TOKEN). Every notification is scoped to the app\'s company. Omit targetUserUuid to notify every user in that company, or set it to aim the notification at one member.
|
|
14382
15217
|
* @summary Send a notification (app token)
|
|
@@ -14387,6 +15222,16 @@ export const NotificationsApiFactory = function (configuration, basePath, axios)
|
|
|
14387
15222
|
sendNotification(sendNotificationRequest, options) {
|
|
14388
15223
|
return localVarFp.sendNotification(sendNotificationRequest, options).then((request) => request(axios, basePath));
|
|
14389
15224
|
},
|
|
15225
|
+
/**
|
|
15226
|
+
* Idempotent. Call before logout; other users\' device registrations are inaccessible.
|
|
15227
|
+
* @summary Unregister this user\'s native notification device
|
|
15228
|
+
* @param {string} deviceInstallationId
|
|
15229
|
+
* @param {*} [options] Override http request option.
|
|
15230
|
+
* @throws {RequiredError}
|
|
15231
|
+
*/
|
|
15232
|
+
unregisterDevice(deviceInstallationId, options) {
|
|
15233
|
+
return localVarFp.unregisterDevice(deviceInstallationId, options).then((request) => request(axios, basePath));
|
|
15234
|
+
},
|
|
14390
15235
|
};
|
|
14391
15236
|
};
|
|
14392
15237
|
/**
|
|
@@ -14412,6 +15257,16 @@ export class NotificationsApi extends BaseAPI {
|
|
|
14412
15257
|
firebaseToken(options) {
|
|
14413
15258
|
return NotificationsApiFp(this.configuration).firebaseToken(options).then((request) => request(this.axios, this.basePath));
|
|
14414
15259
|
}
|
|
15260
|
+
/**
|
|
15261
|
+
* Returns an inbox entry only for its human recipient in the authorized selected company, including entries outside the inbox page.
|
|
15262
|
+
* @summary Get an authoritative notification by ID
|
|
15263
|
+
* @param {string} notificationId
|
|
15264
|
+
* @param {*} [options] Override http request option.
|
|
15265
|
+
* @throws {RequiredError}
|
|
15266
|
+
*/
|
|
15267
|
+
getNotification(notificationId, options) {
|
|
15268
|
+
return NotificationsApiFp(this.configuration).getNotification(notificationId, options).then((request) => request(this.axios, this.basePath));
|
|
15269
|
+
}
|
|
14415
15270
|
/**
|
|
14416
15271
|
* Returns notifications for the selected company plus user-general notifications that have no company. Other companies are never included.
|
|
14417
15272
|
* @summary List in-app notifications for the logged-in user
|
|
@@ -14442,6 +15297,17 @@ export class NotificationsApi extends BaseAPI {
|
|
|
14442
15297
|
markAsRead(notificationId, options) {
|
|
14443
15298
|
return NotificationsApiFp(this.configuration).markAsRead(notificationId, options).then((request) => request(this.axios, this.basePath));
|
|
14444
15299
|
}
|
|
15300
|
+
/**
|
|
15301
|
+
* Idempotently registers an allowed native application. Human authentication required. Does not accept a target user or company. Rotate the registration when moving between accounts.
|
|
15302
|
+
* @summary Register this user\'s native notification device
|
|
15303
|
+
* @param {string} deviceInstallationId
|
|
15304
|
+
* @param {NotificationDeviceRegistration} notificationDeviceRegistration
|
|
15305
|
+
* @param {*} [options] Override http request option.
|
|
15306
|
+
* @throws {RequiredError}
|
|
15307
|
+
*/
|
|
15308
|
+
registerDevice(deviceInstallationId, notificationDeviceRegistration, options) {
|
|
15309
|
+
return NotificationsApiFp(this.configuration).registerDevice(deviceInstallationId, notificationDeviceRegistration, options).then((request) => request(this.axios, this.basePath));
|
|
15310
|
+
}
|
|
14445
15311
|
/**
|
|
14446
15312
|
* Installed apps call this endpoint after async work completes. Authenticate with the installation token (Authorization: Bearer or X-CARAER-TOKEN). Every notification is scoped to the app\'s company. Omit targetUserUuid to notify every user in that company, or set it to aim the notification at one member.
|
|
14447
15313
|
* @summary Send a notification (app token)
|
|
@@ -14452,6 +15318,16 @@ export class NotificationsApi extends BaseAPI {
|
|
|
14452
15318
|
sendNotification(sendNotificationRequest, options) {
|
|
14453
15319
|
return NotificationsApiFp(this.configuration).sendNotification(sendNotificationRequest, options).then((request) => request(this.axios, this.basePath));
|
|
14454
15320
|
}
|
|
15321
|
+
/**
|
|
15322
|
+
* Idempotent. Call before logout; other users\' device registrations are inaccessible.
|
|
15323
|
+
* @summary Unregister this user\'s native notification device
|
|
15324
|
+
* @param {string} deviceInstallationId
|
|
15325
|
+
* @param {*} [options] Override http request option.
|
|
15326
|
+
* @throws {RequiredError}
|
|
15327
|
+
*/
|
|
15328
|
+
unregisterDevice(deviceInstallationId, options) {
|
|
15329
|
+
return NotificationsApiFp(this.configuration).unregisterDevice(deviceInstallationId, options).then((request) => request(this.axios, this.basePath));
|
|
15330
|
+
}
|
|
14455
15331
|
}
|
|
14456
15332
|
/**
|
|
14457
15333
|
* ObjectsApi - axios parameter creator
|
|
@@ -14567,16 +15443,17 @@ export const ObjectsApiAxiosParamCreator = function (configuration) {
|
|
|
14567
15443
|
};
|
|
14568
15444
|
}),
|
|
14569
15445
|
/**
|
|
14570
|
-
* Fetches a single object by its UUID. Optional parameters determine whether to include views, properties, and relations in the response.
|
|
15446
|
+
* Fetches a single object by its UUID. Optional parameters determine whether to include views, properties, and relations in the response. Hidden property definitions require includeHiddenProperties=true together with properties=true; property read authorization still applies and archived definitions remain excluded.
|
|
14571
15447
|
* @summary Get object by UUID
|
|
14572
15448
|
* @param {string} uuid
|
|
14573
15449
|
* @param {string} [views]
|
|
14574
15450
|
* @param {string} [properties]
|
|
14575
15451
|
* @param {string} [relations]
|
|
15452
|
+
* @param {boolean} [includeHiddenProperties]
|
|
14576
15453
|
* @param {*} [options] Override http request option.
|
|
14577
15454
|
* @throws {RequiredError}
|
|
14578
15455
|
*/
|
|
14579
|
-
getObject: (uuid_1, views_1, properties_1, relations_1, ...args_1) => __awaiter(this, [uuid_1, views_1, properties_1, relations_1, ...args_1], void 0, function* (uuid, views, properties, relations, options = {}) {
|
|
15456
|
+
getObject: (uuid_1, views_1, properties_1, relations_1, includeHiddenProperties_1, ...args_1) => __awaiter(this, [uuid_1, views_1, properties_1, relations_1, includeHiddenProperties_1, ...args_1], void 0, function* (uuid, views, properties, relations, includeHiddenProperties, options = {}) {
|
|
14580
15457
|
// verify required parameter 'uuid' is not null or undefined
|
|
14581
15458
|
assertParamExists('getObject', 'uuid', uuid);
|
|
14582
15459
|
const localVarPath = `/api/v2/objects/{uuid}`
|
|
@@ -14602,6 +15479,9 @@ export const ObjectsApiAxiosParamCreator = function (configuration) {
|
|
|
14602
15479
|
if (relations !== undefined) {
|
|
14603
15480
|
localVarQueryParameter['relations'] = relations;
|
|
14604
15481
|
}
|
|
15482
|
+
if (includeHiddenProperties !== undefined) {
|
|
15483
|
+
localVarQueryParameter['includeHiddenProperties'] = includeHiddenProperties;
|
|
15484
|
+
}
|
|
14605
15485
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
14606
15486
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
14607
15487
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -15104,19 +15984,20 @@ export const ObjectsApiFp = function (configuration) {
|
|
|
15104
15984
|
});
|
|
15105
15985
|
},
|
|
15106
15986
|
/**
|
|
15107
|
-
* Fetches a single object by its UUID. Optional parameters determine whether to include views, properties, and relations in the response.
|
|
15987
|
+
* Fetches a single object by its UUID. Optional parameters determine whether to include views, properties, and relations in the response. Hidden property definitions require includeHiddenProperties=true together with properties=true; property read authorization still applies and archived definitions remain excluded.
|
|
15108
15988
|
* @summary Get object by UUID
|
|
15109
15989
|
* @param {string} uuid
|
|
15110
15990
|
* @param {string} [views]
|
|
15111
15991
|
* @param {string} [properties]
|
|
15112
15992
|
* @param {string} [relations]
|
|
15993
|
+
* @param {boolean} [includeHiddenProperties]
|
|
15113
15994
|
* @param {*} [options] Override http request option.
|
|
15114
15995
|
* @throws {RequiredError}
|
|
15115
15996
|
*/
|
|
15116
|
-
getObject(uuid, views, properties, relations, options) {
|
|
15997
|
+
getObject(uuid, views, properties, relations, includeHiddenProperties, options) {
|
|
15117
15998
|
return __awaiter(this, void 0, void 0, function* () {
|
|
15118
15999
|
var _a, _b, _c;
|
|
15119
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getObject(uuid, views, properties, relations, options);
|
|
16000
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getObject(uuid, views, properties, relations, includeHiddenProperties, options);
|
|
15120
16001
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
15121
16002
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ObjectsApi.getObject']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
15122
16003
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -15355,17 +16236,18 @@ export const ObjectsApiFactory = function (configuration, basePath, axios) {
|
|
|
15355
16236
|
return localVarFp.getAccessGrantCandidates(options).then((request) => request(axios, basePath));
|
|
15356
16237
|
},
|
|
15357
16238
|
/**
|
|
15358
|
-
* Fetches a single object by its UUID. Optional parameters determine whether to include views, properties, and relations in the response.
|
|
16239
|
+
* Fetches a single object by its UUID. Optional parameters determine whether to include views, properties, and relations in the response. Hidden property definitions require includeHiddenProperties=true together with properties=true; property read authorization still applies and archived definitions remain excluded.
|
|
15359
16240
|
* @summary Get object by UUID
|
|
15360
16241
|
* @param {string} uuid
|
|
15361
16242
|
* @param {string} [views]
|
|
15362
16243
|
* @param {string} [properties]
|
|
15363
16244
|
* @param {string} [relations]
|
|
16245
|
+
* @param {boolean} [includeHiddenProperties]
|
|
15364
16246
|
* @param {*} [options] Override http request option.
|
|
15365
16247
|
* @throws {RequiredError}
|
|
15366
16248
|
*/
|
|
15367
|
-
getObject(uuid, views, properties, relations, options) {
|
|
15368
|
-
return localVarFp.getObject(uuid, views, properties, relations, options).then((request) => request(axios, basePath));
|
|
16249
|
+
getObject(uuid, views, properties, relations, includeHiddenProperties, options) {
|
|
16250
|
+
return localVarFp.getObject(uuid, views, properties, relations, includeHiddenProperties, options).then((request) => request(axios, basePath));
|
|
15369
16251
|
},
|
|
15370
16252
|
/**
|
|
15371
16253
|
* Fetches a paginated list of objects, optionally including views, properties, and/or relations. The request body should contain pagination details such as limit, page, filters, sort, and query.
|
|
@@ -15532,17 +16414,18 @@ export class ObjectsApi extends BaseAPI {
|
|
|
15532
16414
|
return ObjectsApiFp(this.configuration).getAccessGrantCandidates(options).then((request) => request(this.axios, this.basePath));
|
|
15533
16415
|
}
|
|
15534
16416
|
/**
|
|
15535
|
-
* Fetches a single object by its UUID. Optional parameters determine whether to include views, properties, and relations in the response.
|
|
16417
|
+
* Fetches a single object by its UUID. Optional parameters determine whether to include views, properties, and relations in the response. Hidden property definitions require includeHiddenProperties=true together with properties=true; property read authorization still applies and archived definitions remain excluded.
|
|
15536
16418
|
* @summary Get object by UUID
|
|
15537
16419
|
* @param {string} uuid
|
|
15538
16420
|
* @param {string} [views]
|
|
15539
16421
|
* @param {string} [properties]
|
|
15540
16422
|
* @param {string} [relations]
|
|
16423
|
+
* @param {boolean} [includeHiddenProperties]
|
|
15541
16424
|
* @param {*} [options] Override http request option.
|
|
15542
16425
|
* @throws {RequiredError}
|
|
15543
16426
|
*/
|
|
15544
|
-
getObject(uuid, views, properties, relations, options) {
|
|
15545
|
-
return ObjectsApiFp(this.configuration).getObject(uuid, views, properties, relations, options).then((request) => request(this.axios, this.basePath));
|
|
16427
|
+
getObject(uuid, views, properties, relations, includeHiddenProperties, options) {
|
|
16428
|
+
return ObjectsApiFp(this.configuration).getObject(uuid, views, properties, relations, includeHiddenProperties, options).then((request) => request(this.axios, this.basePath));
|
|
15546
16429
|
}
|
|
15547
16430
|
/**
|
|
15548
16431
|
* Fetches a paginated list of objects, optionally including views, properties, and/or relations. The request body should contain pagination details such as limit, page, filters, sort, and query.
|
|
@@ -16980,6 +17863,40 @@ export const RecordsApiAxiosParamCreator = function (configuration) {
|
|
|
16980
17863
|
options: localVarRequestOptions,
|
|
16981
17864
|
};
|
|
16982
17865
|
}),
|
|
17866
|
+
/**
|
|
17867
|
+
* Read-only current eligibility for up to 50 explicit pairs. Uses ordinary record visibility and named-relation scopes; never a mutation grant. Unavailable items disclose no edge state.
|
|
17868
|
+
* @summary Inspect bounded record relation operations
|
|
17869
|
+
* @param {RelationCapabilityRequest} relationCapabilityRequest
|
|
17870
|
+
* @param {*} [options] Override http request option.
|
|
17871
|
+
* @throws {RequiredError}
|
|
17872
|
+
*/
|
|
17873
|
+
capabilities: (relationCapabilityRequest_1, ...args_1) => __awaiter(this, [relationCapabilityRequest_1, ...args_1], void 0, function* (relationCapabilityRequest, options = {}) {
|
|
17874
|
+
// verify required parameter 'relationCapabilityRequest' is not null or undefined
|
|
17875
|
+
assertParamExists('capabilities', 'relationCapabilityRequest', relationCapabilityRequest);
|
|
17876
|
+
const localVarPath = `/api/v2/records/relations/capabilities`;
|
|
17877
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
17878
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
17879
|
+
let baseOptions;
|
|
17880
|
+
if (configuration) {
|
|
17881
|
+
baseOptions = configuration.baseOptions;
|
|
17882
|
+
}
|
|
17883
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
17884
|
+
const localVarHeaderParameter = {};
|
|
17885
|
+
const localVarQueryParameter = {};
|
|
17886
|
+
// authentication bearerAuth required
|
|
17887
|
+
// http bearer authentication required
|
|
17888
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
17889
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
17890
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
17891
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
17892
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
17893
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
17894
|
+
localVarRequestOptions.data = serializeDataIfNeeded(relationCapabilityRequest, localVarRequestOptions, configuration);
|
|
17895
|
+
return {
|
|
17896
|
+
url: toPathString(localVarUrlObj),
|
|
17897
|
+
options: localVarRequestOptions,
|
|
17898
|
+
};
|
|
17899
|
+
}),
|
|
16983
17900
|
/**
|
|
16984
17901
|
* Creates a new record for the specified object using the provided RecordDTO data. Returns a CreateResponse with the newly created record. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc.
|
|
16985
17902
|
* @summary Create a new record
|
|
@@ -17171,6 +18088,47 @@ export const RecordsApiAxiosParamCreator = function (configuration) {
|
|
|
17171
18088
|
options: localVarRequestOptions,
|
|
17172
18089
|
};
|
|
17173
18090
|
}),
|
|
18091
|
+
/**
|
|
18092
|
+
* Bodyless atomic ensure-link using ordinary record reads, relation normalization, immutability and exact relation-write scopes. Existing edges retain all properties and primary flags. New edges are non-primary. No edge-property/primary settings are accepted by this operation; use the existing POST/PATCH operations to change edge values. Receipt identities echo request endpoints.
|
|
18093
|
+
* @summary Ensure a relation without changing an existing edge
|
|
18094
|
+
* @param {string} fromUuid
|
|
18095
|
+
* @param {string} relationName
|
|
18096
|
+
* @param {string} toUuid
|
|
18097
|
+
* @param {*} [options] Override http request option.
|
|
18098
|
+
* @throws {RequiredError}
|
|
18099
|
+
*/
|
|
18100
|
+
ensure: (fromUuid_1, relationName_1, toUuid_1, ...args_1) => __awaiter(this, [fromUuid_1, relationName_1, toUuid_1, ...args_1], void 0, function* (fromUuid, relationName, toUuid, options = {}) {
|
|
18101
|
+
// verify required parameter 'fromUuid' is not null or undefined
|
|
18102
|
+
assertParamExists('ensure', 'fromUuid', fromUuid);
|
|
18103
|
+
// verify required parameter 'relationName' is not null or undefined
|
|
18104
|
+
assertParamExists('ensure', 'relationName', relationName);
|
|
18105
|
+
// verify required parameter 'toUuid' is not null or undefined
|
|
18106
|
+
assertParamExists('ensure', 'toUuid', toUuid);
|
|
18107
|
+
const localVarPath = `/api/v2/records/relations/{fromUuid}/{relationName}/{toUuid}`
|
|
18108
|
+
.replace('{fromUuid}', encodeURIComponent(String(fromUuid)))
|
|
18109
|
+
.replace('{relationName}', encodeURIComponent(String(relationName)))
|
|
18110
|
+
.replace('{toUuid}', encodeURIComponent(String(toUuid)));
|
|
18111
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
18112
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
18113
|
+
let baseOptions;
|
|
18114
|
+
if (configuration) {
|
|
18115
|
+
baseOptions = configuration.baseOptions;
|
|
18116
|
+
}
|
|
18117
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PUT' }, baseOptions), options);
|
|
18118
|
+
const localVarHeaderParameter = {};
|
|
18119
|
+
const localVarQueryParameter = {};
|
|
18120
|
+
// authentication bearerAuth required
|
|
18121
|
+
// http bearer authentication required
|
|
18122
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
18123
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
18124
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
18125
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
18126
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
18127
|
+
return {
|
|
18128
|
+
url: toPathString(localVarUrlObj),
|
|
18129
|
+
options: localVarRequestOptions,
|
|
18130
|
+
};
|
|
18131
|
+
}),
|
|
17174
18132
|
/**
|
|
17175
18133
|
* Extends a record identified by its UUID to one or more objects. You can use this to move a record or add it to another object so it\'ll be visible in the new object.Returns a SuccessResponse confirming that the record has been extended.
|
|
17176
18134
|
* @summary Extend a record
|
|
@@ -17990,6 +18948,22 @@ export const RecordsApiFp = function (configuration) {
|
|
|
17990
18948
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
17991
18949
|
});
|
|
17992
18950
|
},
|
|
18951
|
+
/**
|
|
18952
|
+
* Read-only current eligibility for up to 50 explicit pairs. Uses ordinary record visibility and named-relation scopes; never a mutation grant. Unavailable items disclose no edge state.
|
|
18953
|
+
* @summary Inspect bounded record relation operations
|
|
18954
|
+
* @param {RelationCapabilityRequest} relationCapabilityRequest
|
|
18955
|
+
* @param {*} [options] Override http request option.
|
|
18956
|
+
* @throws {RequiredError}
|
|
18957
|
+
*/
|
|
18958
|
+
capabilities(relationCapabilityRequest, options) {
|
|
18959
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
18960
|
+
var _a, _b, _c;
|
|
18961
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.capabilities(relationCapabilityRequest, options);
|
|
18962
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
18963
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['RecordsApi.capabilities']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
18964
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
18965
|
+
});
|
|
18966
|
+
},
|
|
17993
18967
|
/**
|
|
17994
18968
|
* Creates a new record for the specified object using the provided RecordDTO data. Returns a CreateResponse with the newly created record. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc.
|
|
17995
18969
|
* @summary Create a new record
|
|
@@ -18068,6 +19042,24 @@ export const RecordsApiFp = function (configuration) {
|
|
|
18068
19042
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
18069
19043
|
});
|
|
18070
19044
|
},
|
|
19045
|
+
/**
|
|
19046
|
+
* Bodyless atomic ensure-link using ordinary record reads, relation normalization, immutability and exact relation-write scopes. Existing edges retain all properties and primary flags. New edges are non-primary. No edge-property/primary settings are accepted by this operation; use the existing POST/PATCH operations to change edge values. Receipt identities echo request endpoints.
|
|
19047
|
+
* @summary Ensure a relation without changing an existing edge
|
|
19048
|
+
* @param {string} fromUuid
|
|
19049
|
+
* @param {string} relationName
|
|
19050
|
+
* @param {string} toUuid
|
|
19051
|
+
* @param {*} [options] Override http request option.
|
|
19052
|
+
* @throws {RequiredError}
|
|
19053
|
+
*/
|
|
19054
|
+
ensure(fromUuid, relationName, toUuid, options) {
|
|
19055
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
19056
|
+
var _a, _b, _c;
|
|
19057
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.ensure(fromUuid, relationName, toUuid, options);
|
|
19058
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
19059
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['RecordsApi.ensure']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
19060
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
19061
|
+
});
|
|
19062
|
+
},
|
|
18071
19063
|
/**
|
|
18072
19064
|
* Extends a record identified by its UUID to one or more objects. You can use this to move a record or add it to another object so it\'ll be visible in the new object.Returns a SuccessResponse confirming that the record has been extended.
|
|
18073
19065
|
* @summary Extend a record
|
|
@@ -18438,6 +19430,16 @@ export const RecordsApiFactory = function (configuration, basePath, axios) {
|
|
|
18438
19430
|
bulkEdit(objectName, bulkEditRecordsRequest, ignoreErrors, options) {
|
|
18439
19431
|
return localVarFp.bulkEdit(objectName, bulkEditRecordsRequest, ignoreErrors, options).then((request) => request(axios, basePath));
|
|
18440
19432
|
},
|
|
19433
|
+
/**
|
|
19434
|
+
* Read-only current eligibility for up to 50 explicit pairs. Uses ordinary record visibility and named-relation scopes; never a mutation grant. Unavailable items disclose no edge state.
|
|
19435
|
+
* @summary Inspect bounded record relation operations
|
|
19436
|
+
* @param {RelationCapabilityRequest} relationCapabilityRequest
|
|
19437
|
+
* @param {*} [options] Override http request option.
|
|
19438
|
+
* @throws {RequiredError}
|
|
19439
|
+
*/
|
|
19440
|
+
capabilities(relationCapabilityRequest, options) {
|
|
19441
|
+
return localVarFp.capabilities(relationCapabilityRequest, options).then((request) => request(axios, basePath));
|
|
19442
|
+
},
|
|
18441
19443
|
/**
|
|
18442
19444
|
* Creates a new record for the specified object using the provided RecordDTO data. Returns a CreateResponse with the newly created record. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc.
|
|
18443
19445
|
* @summary Create a new record
|
|
@@ -18492,6 +19494,18 @@ export const RecordsApiFactory = function (configuration, basePath, axios) {
|
|
|
18492
19494
|
deleteRelation(fromUuid, relationName, toUuid, options) {
|
|
18493
19495
|
return localVarFp.deleteRelation(fromUuid, relationName, toUuid, options).then((request) => request(axios, basePath));
|
|
18494
19496
|
},
|
|
19497
|
+
/**
|
|
19498
|
+
* Bodyless atomic ensure-link using ordinary record reads, relation normalization, immutability and exact relation-write scopes. Existing edges retain all properties and primary flags. New edges are non-primary. No edge-property/primary settings are accepted by this operation; use the existing POST/PATCH operations to change edge values. Receipt identities echo request endpoints.
|
|
19499
|
+
* @summary Ensure a relation without changing an existing edge
|
|
19500
|
+
* @param {string} fromUuid
|
|
19501
|
+
* @param {string} relationName
|
|
19502
|
+
* @param {string} toUuid
|
|
19503
|
+
* @param {*} [options] Override http request option.
|
|
19504
|
+
* @throws {RequiredError}
|
|
19505
|
+
*/
|
|
19506
|
+
ensure(fromUuid, relationName, toUuid, options) {
|
|
19507
|
+
return localVarFp.ensure(fromUuid, relationName, toUuid, options).then((request) => request(axios, basePath));
|
|
19508
|
+
},
|
|
18495
19509
|
/**
|
|
18496
19510
|
* Extends a record identified by its UUID to one or more objects. You can use this to move a record or add it to another object so it\'ll be visible in the new object.Returns a SuccessResponse confirming that the record has been extended.
|
|
18497
19511
|
* @summary Extend a record
|
|
@@ -18764,6 +19778,16 @@ export class RecordsApi extends BaseAPI {
|
|
|
18764
19778
|
bulkEdit(objectName, bulkEditRecordsRequest, ignoreErrors, options) {
|
|
18765
19779
|
return RecordsApiFp(this.configuration).bulkEdit(objectName, bulkEditRecordsRequest, ignoreErrors, options).then((request) => request(this.axios, this.basePath));
|
|
18766
19780
|
}
|
|
19781
|
+
/**
|
|
19782
|
+
* Read-only current eligibility for up to 50 explicit pairs. Uses ordinary record visibility and named-relation scopes; never a mutation grant. Unavailable items disclose no edge state.
|
|
19783
|
+
* @summary Inspect bounded record relation operations
|
|
19784
|
+
* @param {RelationCapabilityRequest} relationCapabilityRequest
|
|
19785
|
+
* @param {*} [options] Override http request option.
|
|
19786
|
+
* @throws {RequiredError}
|
|
19787
|
+
*/
|
|
19788
|
+
capabilities(relationCapabilityRequest, options) {
|
|
19789
|
+
return RecordsApiFp(this.configuration).capabilities(relationCapabilityRequest, options).then((request) => request(this.axios, this.basePath));
|
|
19790
|
+
}
|
|
18767
19791
|
/**
|
|
18768
19792
|
* Creates a new record for the specified object using the provided RecordDTO data. Returns a CreateResponse with the newly created record. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc.
|
|
18769
19793
|
* @summary Create a new record
|
|
@@ -18818,6 +19842,18 @@ export class RecordsApi extends BaseAPI {
|
|
|
18818
19842
|
deleteRelation(fromUuid, relationName, toUuid, options) {
|
|
18819
19843
|
return RecordsApiFp(this.configuration).deleteRelation(fromUuid, relationName, toUuid, options).then((request) => request(this.axios, this.basePath));
|
|
18820
19844
|
}
|
|
19845
|
+
/**
|
|
19846
|
+
* Bodyless atomic ensure-link using ordinary record reads, relation normalization, immutability and exact relation-write scopes. Existing edges retain all properties and primary flags. New edges are non-primary. No edge-property/primary settings are accepted by this operation; use the existing POST/PATCH operations to change edge values. Receipt identities echo request endpoints.
|
|
19847
|
+
* @summary Ensure a relation without changing an existing edge
|
|
19848
|
+
* @param {string} fromUuid
|
|
19849
|
+
* @param {string} relationName
|
|
19850
|
+
* @param {string} toUuid
|
|
19851
|
+
* @param {*} [options] Override http request option.
|
|
19852
|
+
* @throws {RequiredError}
|
|
19853
|
+
*/
|
|
19854
|
+
ensure(fromUuid, relationName, toUuid, options) {
|
|
19855
|
+
return RecordsApiFp(this.configuration).ensure(fromUuid, relationName, toUuid, options).then((request) => request(this.axios, this.basePath));
|
|
19856
|
+
}
|
|
18821
19857
|
/**
|
|
18822
19858
|
* Extends a record identified by its UUID to one or more objects. You can use this to move a record or add it to another object so it\'ll be visible in the new object.Returns a SuccessResponse confirming that the record has been extended.
|
|
18823
19859
|
* @summary Extend a record
|
|
@@ -24171,6 +25207,43 @@ export const WebpagesApiAxiosParamCreator = function (configuration) {
|
|
|
24171
25207
|
options: localVarRequestOptions,
|
|
24172
25208
|
};
|
|
24173
25209
|
}),
|
|
25210
|
+
/**
|
|
25211
|
+
* Returns only public component styling, color tokens and custom fonts for the selected company. Uses the same page, record and environment-property read checks as reading this webpage; company administration access is not required.
|
|
25212
|
+
* @summary Get authorized webpage editor defaults
|
|
25213
|
+
* @param {string} uuid
|
|
25214
|
+
* @param {string} [environment]
|
|
25215
|
+
* @param {*} [options] Override http request option.
|
|
25216
|
+
* @throws {RequiredError}
|
|
25217
|
+
*/
|
|
25218
|
+
page: (uuid_1, environment_1, ...args_1) => __awaiter(this, [uuid_1, environment_1, ...args_1], void 0, function* (uuid, environment, options = {}) {
|
|
25219
|
+
// verify required parameter 'uuid' is not null or undefined
|
|
25220
|
+
assertParamExists('page', 'uuid', uuid);
|
|
25221
|
+
const localVarPath = `/api/v2/webpages/{uuid}/editor-defaults`
|
|
25222
|
+
.replace('{uuid}', encodeURIComponent(String(uuid)));
|
|
25223
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
25224
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
25225
|
+
let baseOptions;
|
|
25226
|
+
if (configuration) {
|
|
25227
|
+
baseOptions = configuration.baseOptions;
|
|
25228
|
+
}
|
|
25229
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
25230
|
+
const localVarHeaderParameter = {};
|
|
25231
|
+
const localVarQueryParameter = {};
|
|
25232
|
+
// authentication bearerAuth required
|
|
25233
|
+
// http bearer authentication required
|
|
25234
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
25235
|
+
if (environment !== undefined) {
|
|
25236
|
+
localVarQueryParameter['environment'] = environment;
|
|
25237
|
+
}
|
|
25238
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
25239
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
25240
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
25241
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
25242
|
+
return {
|
|
25243
|
+
url: toPathString(localVarUrlObj),
|
|
25244
|
+
options: localVarRequestOptions,
|
|
25245
|
+
};
|
|
25246
|
+
}),
|
|
24174
25247
|
/**
|
|
24175
25248
|
* Makes an existing company file public and returns its stable public URL. The file is not copied and is not tied to a webpage.
|
|
24176
25249
|
* @summary Public URL for a library file
|
|
@@ -24358,6 +25431,43 @@ export const WebpagesApiAxiosParamCreator = function (configuration) {
|
|
|
24358
25431
|
options: localVarRequestOptions,
|
|
24359
25432
|
};
|
|
24360
25433
|
}),
|
|
25434
|
+
/**
|
|
25435
|
+
* Returns only public component styling, color tokens and custom fonts for the selected company after its ordinary template-read and tenant object/template resolution checks. No template, lease, company setting or publication is changed.
|
|
25436
|
+
* @summary Get authorized template editor defaults
|
|
25437
|
+
* @param {string} objectName
|
|
25438
|
+
* @param {string} environment
|
|
25439
|
+
* @param {*} [options] Override http request option.
|
|
25440
|
+
* @throws {RequiredError}
|
|
25441
|
+
*/
|
|
25442
|
+
template: (objectName_1, environment_1, ...args_1) => __awaiter(this, [objectName_1, environment_1, ...args_1], void 0, function* (objectName, environment, options = {}) {
|
|
25443
|
+
// verify required parameter 'objectName' is not null or undefined
|
|
25444
|
+
assertParamExists('template', 'objectName', objectName);
|
|
25445
|
+
// verify required parameter 'environment' is not null or undefined
|
|
25446
|
+
assertParamExists('template', 'environment', environment);
|
|
25447
|
+
const localVarPath = `/api/v2/webpages/template/{objectName}/{environment}/editor-defaults`
|
|
25448
|
+
.replace('{objectName}', encodeURIComponent(String(objectName)))
|
|
25449
|
+
.replace('{environment}', encodeURIComponent(String(environment)));
|
|
25450
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
25451
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
25452
|
+
let baseOptions;
|
|
25453
|
+
if (configuration) {
|
|
25454
|
+
baseOptions = configuration.baseOptions;
|
|
25455
|
+
}
|
|
25456
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
25457
|
+
const localVarHeaderParameter = {};
|
|
25458
|
+
const localVarQueryParameter = {};
|
|
25459
|
+
// authentication bearerAuth required
|
|
25460
|
+
// http bearer authentication required
|
|
25461
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
25462
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
25463
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
25464
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
25465
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
25466
|
+
return {
|
|
25467
|
+
url: toPathString(localVarUrlObj),
|
|
25468
|
+
options: localVarRequestOptions,
|
|
25469
|
+
};
|
|
25470
|
+
}),
|
|
24361
25471
|
/**
|
|
24362
25472
|
* Validates password and returns a short-lived access token.
|
|
24363
25473
|
* @summary Unlock password-protected webpage
|
|
@@ -25074,6 +26184,23 @@ export const WebpagesApiFp = function (configuration) {
|
|
|
25074
26184
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
25075
26185
|
});
|
|
25076
26186
|
},
|
|
26187
|
+
/**
|
|
26188
|
+
* Returns only public component styling, color tokens and custom fonts for the selected company. Uses the same page, record and environment-property read checks as reading this webpage; company administration access is not required.
|
|
26189
|
+
* @summary Get authorized webpage editor defaults
|
|
26190
|
+
* @param {string} uuid
|
|
26191
|
+
* @param {string} [environment]
|
|
26192
|
+
* @param {*} [options] Override http request option.
|
|
26193
|
+
* @throws {RequiredError}
|
|
26194
|
+
*/
|
|
26195
|
+
page(uuid, environment, options) {
|
|
26196
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
26197
|
+
var _a, _b, _c;
|
|
26198
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.page(uuid, environment, options);
|
|
26199
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
26200
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['WebpagesApi.page']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
26201
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
26202
|
+
});
|
|
26203
|
+
},
|
|
25077
26204
|
/**
|
|
25078
26205
|
* Makes an existing company file public and returns its stable public URL. The file is not copied and is not tied to a webpage.
|
|
25079
26206
|
* @summary Public URL for a library file
|
|
@@ -25159,6 +26286,23 @@ export const WebpagesApiFp = function (configuration) {
|
|
|
25159
26286
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
25160
26287
|
});
|
|
25161
26288
|
},
|
|
26289
|
+
/**
|
|
26290
|
+
* Returns only public component styling, color tokens and custom fonts for the selected company after its ordinary template-read and tenant object/template resolution checks. No template, lease, company setting or publication is changed.
|
|
26291
|
+
* @summary Get authorized template editor defaults
|
|
26292
|
+
* @param {string} objectName
|
|
26293
|
+
* @param {string} environment
|
|
26294
|
+
* @param {*} [options] Override http request option.
|
|
26295
|
+
* @throws {RequiredError}
|
|
26296
|
+
*/
|
|
26297
|
+
template(objectName, environment, options) {
|
|
26298
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
26299
|
+
var _a, _b, _c;
|
|
26300
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.template(objectName, environment, options);
|
|
26301
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
26302
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['WebpagesApi.template']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
26303
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
26304
|
+
});
|
|
26305
|
+
},
|
|
25162
26306
|
/**
|
|
25163
26307
|
* Validates password and returns a short-lived access token.
|
|
25164
26308
|
* @summary Unlock password-protected webpage
|
|
@@ -25595,6 +26739,17 @@ export const WebpagesApiFactory = function (configuration, basePath, axios) {
|
|
|
25595
26739
|
listProtectionGrants(uuid, environment, options) {
|
|
25596
26740
|
return localVarFp.listProtectionGrants(uuid, environment, options).then((request) => request(axios, basePath));
|
|
25597
26741
|
},
|
|
26742
|
+
/**
|
|
26743
|
+
* Returns only public component styling, color tokens and custom fonts for the selected company. Uses the same page, record and environment-property read checks as reading this webpage; company administration access is not required.
|
|
26744
|
+
* @summary Get authorized webpage editor defaults
|
|
26745
|
+
* @param {string} uuid
|
|
26746
|
+
* @param {string} [environment]
|
|
26747
|
+
* @param {*} [options] Override http request option.
|
|
26748
|
+
* @throws {RequiredError}
|
|
26749
|
+
*/
|
|
26750
|
+
page(uuid, environment, options) {
|
|
26751
|
+
return localVarFp.page(uuid, environment, options).then((request) => request(axios, basePath));
|
|
26752
|
+
},
|
|
25598
26753
|
/**
|
|
25599
26754
|
* Makes an existing company file public and returns its stable public URL. The file is not copied and is not tied to a webpage.
|
|
25600
26755
|
* @summary Public URL for a library file
|
|
@@ -25650,6 +26805,17 @@ export const WebpagesApiFactory = function (configuration, basePath, axios) {
|
|
|
25650
26805
|
revokeProtectionGrant(uuid, grantUuid, environment, options) {
|
|
25651
26806
|
return localVarFp.revokeProtectionGrant(uuid, grantUuid, environment, options).then((request) => request(axios, basePath));
|
|
25652
26807
|
},
|
|
26808
|
+
/**
|
|
26809
|
+
* Returns only public component styling, color tokens and custom fonts for the selected company after its ordinary template-read and tenant object/template resolution checks. No template, lease, company setting or publication is changed.
|
|
26810
|
+
* @summary Get authorized template editor defaults
|
|
26811
|
+
* @param {string} objectName
|
|
26812
|
+
* @param {string} environment
|
|
26813
|
+
* @param {*} [options] Override http request option.
|
|
26814
|
+
* @throws {RequiredError}
|
|
26815
|
+
*/
|
|
26816
|
+
template(objectName, environment, options) {
|
|
26817
|
+
return localVarFp.template(objectName, environment, options).then((request) => request(axios, basePath));
|
|
26818
|
+
},
|
|
25653
26819
|
/**
|
|
25654
26820
|
* Validates password and returns a short-lived access token.
|
|
25655
26821
|
* @summary Unlock password-protected webpage
|
|
@@ -26054,6 +27220,17 @@ export class WebpagesApi extends BaseAPI {
|
|
|
26054
27220
|
listProtectionGrants(uuid, environment, options) {
|
|
26055
27221
|
return WebpagesApiFp(this.configuration).listProtectionGrants(uuid, environment, options).then((request) => request(this.axios, this.basePath));
|
|
26056
27222
|
}
|
|
27223
|
+
/**
|
|
27224
|
+
* Returns only public component styling, color tokens and custom fonts for the selected company. Uses the same page, record and environment-property read checks as reading this webpage; company administration access is not required.
|
|
27225
|
+
* @summary Get authorized webpage editor defaults
|
|
27226
|
+
* @param {string} uuid
|
|
27227
|
+
* @param {string} [environment]
|
|
27228
|
+
* @param {*} [options] Override http request option.
|
|
27229
|
+
* @throws {RequiredError}
|
|
27230
|
+
*/
|
|
27231
|
+
page(uuid, environment, options) {
|
|
27232
|
+
return WebpagesApiFp(this.configuration).page(uuid, environment, options).then((request) => request(this.axios, this.basePath));
|
|
27233
|
+
}
|
|
26057
27234
|
/**
|
|
26058
27235
|
* Makes an existing company file public and returns its stable public URL. The file is not copied and is not tied to a webpage.
|
|
26059
27236
|
* @summary Public URL for a library file
|
|
@@ -26109,6 +27286,17 @@ export class WebpagesApi extends BaseAPI {
|
|
|
26109
27286
|
revokeProtectionGrant(uuid, grantUuid, environment, options) {
|
|
26110
27287
|
return WebpagesApiFp(this.configuration).revokeProtectionGrant(uuid, grantUuid, environment, options).then((request) => request(this.axios, this.basePath));
|
|
26111
27288
|
}
|
|
27289
|
+
/**
|
|
27290
|
+
* Returns only public component styling, color tokens and custom fonts for the selected company after its ordinary template-read and tenant object/template resolution checks. No template, lease, company setting or publication is changed.
|
|
27291
|
+
* @summary Get authorized template editor defaults
|
|
27292
|
+
* @param {string} objectName
|
|
27293
|
+
* @param {string} environment
|
|
27294
|
+
* @param {*} [options] Override http request option.
|
|
27295
|
+
* @throws {RequiredError}
|
|
27296
|
+
*/
|
|
27297
|
+
template(objectName, environment, options) {
|
|
27298
|
+
return WebpagesApiFp(this.configuration).template(objectName, environment, options).then((request) => request(this.axios, this.basePath));
|
|
27299
|
+
}
|
|
26112
27300
|
/**
|
|
26113
27301
|
* Validates password and returns a short-lived access token.
|
|
26114
27302
|
* @summary Unlock password-protected webpage
|