@connectedxm/admin-sdk 11.9.0 → 11.10.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +6 -0
- package/README.md +2 -2
- package/api.ts +145 -5
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +86 -5
- package/dist/api.js +115 -25
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +86 -5
- package/dist/esm/api.js +95 -5
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/docs/EventsPassesAttributesApi.md +56 -0
- package/docs/ImportEventPassAttributes200Response.md +24 -0
- package/docs/PassAttributeImportResult.md +26 -0
- package/docs/PassAttributeImportSummary.md +26 -0
- package/docs/PassAttributesImportInputs.md +20 -0
- package/docs/PassAttributesImportInputsRowsInner.md +22 -0
- package/docs/SelfApikeysApi.md +1 -1
- package/docs/UserApiKey.md +2 -0
- package/docs/UserApiKeyCreateInputs.md +2 -0
- package/docs/UserApiKeyScope.md +10 -0
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
|
@@ -1120,6 +1120,7 @@ docs/ImageWCopyUri.md
|
|
|
1120
1120
|
docs/Import.md
|
|
1121
1121
|
docs/ImportAllOfCount.md
|
|
1122
1122
|
docs/ImportCreateInputs.md
|
|
1123
|
+
docs/ImportEventPassAttributes200Response.md
|
|
1123
1124
|
docs/ImportItem.md
|
|
1124
1125
|
docs/ImportItemStatus.md
|
|
1125
1126
|
docs/ImportRooms200Response.md
|
|
@@ -1284,6 +1285,10 @@ docs/OrganizationWebhooksApi.md
|
|
|
1284
1285
|
docs/PageType.md
|
|
1285
1286
|
docs/PassAddOn.md
|
|
1286
1287
|
docs/PassAttribute.md
|
|
1288
|
+
docs/PassAttributeImportResult.md
|
|
1289
|
+
docs/PassAttributeImportSummary.md
|
|
1290
|
+
docs/PassAttributesImportInputs.md
|
|
1291
|
+
docs/PassAttributesImportInputsRowsInner.md
|
|
1287
1292
|
docs/PassAttributesUpdateInputs.md
|
|
1288
1293
|
docs/PassAttributesUpdateInputsValuesInner.md
|
|
1289
1294
|
docs/PassChange.md
|
|
@@ -1594,6 +1599,7 @@ docs/UpsertLinkPreviewRequest.md
|
|
|
1594
1599
|
docs/User.md
|
|
1595
1600
|
docs/UserApiKey.md
|
|
1596
1601
|
docs/UserApiKeyCreateInputs.md
|
|
1602
|
+
docs/UserApiKeyScope.md
|
|
1597
1603
|
docs/UserImageUpdateInputs.md
|
|
1598
1604
|
docs/UserImageUpdateInputsImageDataUri.md
|
|
1599
1605
|
docs/UserRole.md
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @connectedxm/admin-sdk@11.
|
|
1
|
+
## @connectedxm/admin-sdk@11.10.0
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @connectedxm/admin-sdk@11.
|
|
39
|
+
npm install @connectedxm/admin-sdk@11.10.0 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
package/api.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Connected Admin API
|
|
5
5
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 11.
|
|
7
|
+
* The version of the OpenAPI document: 11.10.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -10831,6 +10831,16 @@ export interface ImportCreateInputs {
|
|
|
10831
10831
|
}
|
|
10832
10832
|
|
|
10833
10833
|
|
|
10834
|
+
export interface ImportEventPassAttributes200Response {
|
|
10835
|
+
'status': ImportEventPassAttributes200ResponseStatusEnum;
|
|
10836
|
+
'message': string;
|
|
10837
|
+
'data': PassAttributeImportSummary;
|
|
10838
|
+
}
|
|
10839
|
+
|
|
10840
|
+
export enum ImportEventPassAttributes200ResponseStatusEnum {
|
|
10841
|
+
Ok = 'ok'
|
|
10842
|
+
}
|
|
10843
|
+
|
|
10834
10844
|
export interface ImportItem {
|
|
10835
10845
|
'id': string;
|
|
10836
10846
|
'importId': string;
|
|
@@ -12383,6 +12393,31 @@ export interface PassAttribute {
|
|
|
12383
12393
|
'createdAt': string;
|
|
12384
12394
|
'updatedAt': string;
|
|
12385
12395
|
}
|
|
12396
|
+
export interface PassAttributeImportResult {
|
|
12397
|
+
'index': number;
|
|
12398
|
+
'passId': string;
|
|
12399
|
+
'status': PassAttributeImportResultStatusEnum;
|
|
12400
|
+
'message': string | null;
|
|
12401
|
+
}
|
|
12402
|
+
|
|
12403
|
+
export enum PassAttributeImportResultStatusEnum {
|
|
12404
|
+
Resolved = 'resolved',
|
|
12405
|
+
Invalid = 'invalid'
|
|
12406
|
+
}
|
|
12407
|
+
|
|
12408
|
+
export interface PassAttributeImportSummary {
|
|
12409
|
+
'created': number;
|
|
12410
|
+
'updated': number;
|
|
12411
|
+
'unchanged': number;
|
|
12412
|
+
'results': Array<PassAttributeImportResult>;
|
|
12413
|
+
}
|
|
12414
|
+
export interface PassAttributesImportInputs {
|
|
12415
|
+
'rows': Array<PassAttributesImportInputsRowsInner>;
|
|
12416
|
+
}
|
|
12417
|
+
export interface PassAttributesImportInputsRowsInner {
|
|
12418
|
+
'passId': string;
|
|
12419
|
+
'values': Array<PassAttributesUpdateInputsValuesInner>;
|
|
12420
|
+
}
|
|
12386
12421
|
export interface PassAttributesUpdateInputs {
|
|
12387
12422
|
'values': Array<PassAttributesUpdateInputsValuesInner>;
|
|
12388
12423
|
}
|
|
@@ -15283,18 +15318,31 @@ export interface UserApiKey {
|
|
|
15283
15318
|
'key': string;
|
|
15284
15319
|
'name': string;
|
|
15285
15320
|
'description'?: string;
|
|
15321
|
+
'scope': UserApiKeyScope;
|
|
15286
15322
|
'startDate': string;
|
|
15287
15323
|
'endDate': string;
|
|
15288
15324
|
'createdAt': string;
|
|
15289
15325
|
'updatedAt': string;
|
|
15290
15326
|
'lastUsedAt'?: string;
|
|
15291
15327
|
}
|
|
15328
|
+
|
|
15329
|
+
|
|
15292
15330
|
export interface UserApiKeyCreateInputs {
|
|
15293
15331
|
'name': string;
|
|
15332
|
+
'scope'?: UserApiKeyScope;
|
|
15294
15333
|
'startDate': string;
|
|
15295
15334
|
'endDate'?: string;
|
|
15296
15335
|
'description'?: string | null;
|
|
15297
15336
|
}
|
|
15337
|
+
|
|
15338
|
+
|
|
15339
|
+
|
|
15340
|
+
export enum UserApiKeyScope {
|
|
15341
|
+
Read = 'read',
|
|
15342
|
+
Full = 'full'
|
|
15343
|
+
}
|
|
15344
|
+
|
|
15345
|
+
|
|
15298
15346
|
export interface UserImageUpdateInputs {
|
|
15299
15347
|
'imageDataUri'?: UserImageUpdateInputsImageDataUri;
|
|
15300
15348
|
'userId'?: UserImageUpdateInputsImageDataUri;
|
|
@@ -67249,6 +67297,51 @@ export const EventsPassesAttributesApiAxiosParamCreator = function (configuratio
|
|
|
67249
67297
|
options: localVarRequestOptions,
|
|
67250
67298
|
};
|
|
67251
67299
|
},
|
|
67300
|
+
/**
|
|
67301
|
+
* Creates or updates attribute values on up to 500 passes in one call, the write half of a CSV import. Each row\'s passId may be a pass id or the pass\'s alternateId, and each attributeId may be an attribute id or its name. Rows whose pass or attribute cannot be resolved are reported back as invalid and skipped rather than failing the batch. Requires read permission on events and read/update permission on attendees.
|
|
67302
|
+
* @summary Bulk set custom attribute values across many passes
|
|
67303
|
+
* @param {string} eventId The event identifier
|
|
67304
|
+
* @param {PassAttributesImportInputs} passAttributesImportInputs
|
|
67305
|
+
* @param {*} [options] Override http request option.
|
|
67306
|
+
* @throws {RequiredError}
|
|
67307
|
+
*/
|
|
67308
|
+
importEventPassAttributes: async (eventId: string, passAttributesImportInputs: PassAttributesImportInputs, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
67309
|
+
// verify required parameter 'eventId' is not null or undefined
|
|
67310
|
+
assertParamExists('importEventPassAttributes', 'eventId', eventId)
|
|
67311
|
+
// verify required parameter 'passAttributesImportInputs' is not null or undefined
|
|
67312
|
+
assertParamExists('importEventPassAttributes', 'passAttributesImportInputs', passAttributesImportInputs)
|
|
67313
|
+
const localVarPath = `/events/{eventId}/passes/attributes/import`
|
|
67314
|
+
.replace('{eventId}', encodeURIComponent(String(eventId)));
|
|
67315
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
67316
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
67317
|
+
let baseOptions;
|
|
67318
|
+
if (configuration) {
|
|
67319
|
+
baseOptions = configuration.baseOptions;
|
|
67320
|
+
}
|
|
67321
|
+
|
|
67322
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
67323
|
+
const localVarHeaderParameter = {} as any;
|
|
67324
|
+
const localVarQueryParameter = {} as any;
|
|
67325
|
+
|
|
67326
|
+
// authentication ApiKeyAuth required
|
|
67327
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
67328
|
+
|
|
67329
|
+
// authentication OrganizationId required
|
|
67330
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
67331
|
+
|
|
67332
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
67333
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
67334
|
+
|
|
67335
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
67336
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
67337
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
67338
|
+
localVarRequestOptions.data = serializeDataIfNeeded(passAttributesImportInputs, localVarRequestOptions, configuration)
|
|
67339
|
+
|
|
67340
|
+
return {
|
|
67341
|
+
url: toPathString(localVarUrlObj),
|
|
67342
|
+
options: localVarRequestOptions,
|
|
67343
|
+
};
|
|
67344
|
+
},
|
|
67252
67345
|
/**
|
|
67253
67346
|
* Deletes a single custom attribute value that had been set on the specified event pass, requires read permission on events and read/update permission on attendees.
|
|
67254
67347
|
* @summary Remove a custom attribute from a pass
|
|
@@ -67373,6 +67466,20 @@ export const EventsPassesAttributesApiFp = function(configuration?: Configuratio
|
|
|
67373
67466
|
const localVarOperationServerBasePath = operationServerMap['EventsPassesAttributesApi.getEventPassAttributes']?.[localVarOperationServerIndex]?.url;
|
|
67374
67467
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
67375
67468
|
},
|
|
67469
|
+
/**
|
|
67470
|
+
* Creates or updates attribute values on up to 500 passes in one call, the write half of a CSV import. Each row\'s passId may be a pass id or the pass\'s alternateId, and each attributeId may be an attribute id or its name. Rows whose pass or attribute cannot be resolved are reported back as invalid and skipped rather than failing the batch. Requires read permission on events and read/update permission on attendees.
|
|
67471
|
+
* @summary Bulk set custom attribute values across many passes
|
|
67472
|
+
* @param {string} eventId The event identifier
|
|
67473
|
+
* @param {PassAttributesImportInputs} passAttributesImportInputs
|
|
67474
|
+
* @param {*} [options] Override http request option.
|
|
67475
|
+
* @throws {RequiredError}
|
|
67476
|
+
*/
|
|
67477
|
+
async importEventPassAttributes(eventId: string, passAttributesImportInputs: PassAttributesImportInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImportEventPassAttributes200Response>> {
|
|
67478
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.importEventPassAttributes(eventId, passAttributesImportInputs, options);
|
|
67479
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
67480
|
+
const localVarOperationServerBasePath = operationServerMap['EventsPassesAttributesApi.importEventPassAttributes']?.[localVarOperationServerIndex]?.url;
|
|
67481
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
67482
|
+
},
|
|
67376
67483
|
/**
|
|
67377
67484
|
* Deletes a single custom attribute value that had been set on the specified event pass, requires read permission on events and read/update permission on attendees.
|
|
67378
67485
|
* @summary Remove a custom attribute from a pass
|
|
@@ -67422,6 +67529,16 @@ export const EventsPassesAttributesApiFactory = function (configuration?: Config
|
|
|
67422
67529
|
getEventPassAttributes(requestParameters: EventsPassesAttributesApiGetEventPassAttributesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetEventPassAttributes200Response> {
|
|
67423
67530
|
return localVarFp.getEventPassAttributes(requestParameters.eventId, requestParameters.passId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
67424
67531
|
},
|
|
67532
|
+
/**
|
|
67533
|
+
* Creates or updates attribute values on up to 500 passes in one call, the write half of a CSV import. Each row\'s passId may be a pass id or the pass\'s alternateId, and each attributeId may be an attribute id or its name. Rows whose pass or attribute cannot be resolved are reported back as invalid and skipped rather than failing the batch. Requires read permission on events and read/update permission on attendees.
|
|
67534
|
+
* @summary Bulk set custom attribute values across many passes
|
|
67535
|
+
* @param {EventsPassesAttributesApiImportEventPassAttributesRequest} requestParameters Request parameters.
|
|
67536
|
+
* @param {*} [options] Override http request option.
|
|
67537
|
+
* @throws {RequiredError}
|
|
67538
|
+
*/
|
|
67539
|
+
importEventPassAttributes(requestParameters: EventsPassesAttributesApiImportEventPassAttributesRequest, options?: RawAxiosRequestConfig): AxiosPromise<ImportEventPassAttributes200Response> {
|
|
67540
|
+
return localVarFp.importEventPassAttributes(requestParameters.eventId, requestParameters.passAttributesImportInputs, options).then((request) => request(axios, basePath));
|
|
67541
|
+
},
|
|
67425
67542
|
/**
|
|
67426
67543
|
* Deletes a single custom attribute value that had been set on the specified event pass, requires read permission on events and read/update permission on attendees.
|
|
67427
67544
|
* @summary Remove a custom attribute from a pass
|
|
@@ -67480,6 +67597,18 @@ export interface EventsPassesAttributesApiGetEventPassAttributesRequest {
|
|
|
67480
67597
|
readonly search?: string
|
|
67481
67598
|
}
|
|
67482
67599
|
|
|
67600
|
+
/**
|
|
67601
|
+
* Request parameters for importEventPassAttributes operation in EventsPassesAttributesApi.
|
|
67602
|
+
*/
|
|
67603
|
+
export interface EventsPassesAttributesApiImportEventPassAttributesRequest {
|
|
67604
|
+
/**
|
|
67605
|
+
* The event identifier
|
|
67606
|
+
*/
|
|
67607
|
+
readonly eventId: string
|
|
67608
|
+
|
|
67609
|
+
readonly passAttributesImportInputs: PassAttributesImportInputs
|
|
67610
|
+
}
|
|
67611
|
+
|
|
67483
67612
|
/**
|
|
67484
67613
|
* Request parameters for removeEventPassAttribute operation in EventsPassesAttributesApi.
|
|
67485
67614
|
*/
|
|
@@ -67532,6 +67661,17 @@ export class EventsPassesAttributesApi extends BaseAPI {
|
|
|
67532
67661
|
return EventsPassesAttributesApiFp(this.configuration).getEventPassAttributes(requestParameters.eventId, requestParameters.passId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
67533
67662
|
}
|
|
67534
67663
|
|
|
67664
|
+
/**
|
|
67665
|
+
* Creates or updates attribute values on up to 500 passes in one call, the write half of a CSV import. Each row\'s passId may be a pass id or the pass\'s alternateId, and each attributeId may be an attribute id or its name. Rows whose pass or attribute cannot be resolved are reported back as invalid and skipped rather than failing the batch. Requires read permission on events and read/update permission on attendees.
|
|
67666
|
+
* @summary Bulk set custom attribute values across many passes
|
|
67667
|
+
* @param {EventsPassesAttributesApiImportEventPassAttributesRequest} requestParameters Request parameters.
|
|
67668
|
+
* @param {*} [options] Override http request option.
|
|
67669
|
+
* @throws {RequiredError}
|
|
67670
|
+
*/
|
|
67671
|
+
public importEventPassAttributes(requestParameters: EventsPassesAttributesApiImportEventPassAttributesRequest, options?: RawAxiosRequestConfig) {
|
|
67672
|
+
return EventsPassesAttributesApiFp(this.configuration).importEventPassAttributes(requestParameters.eventId, requestParameters.passAttributesImportInputs, options).then((request) => request(this.axios, this.basePath));
|
|
67673
|
+
}
|
|
67674
|
+
|
|
67535
67675
|
/**
|
|
67536
67676
|
* Deletes a single custom attribute value that had been set on the specified event pass, requires read permission on events and read/update permission on attendees.
|
|
67537
67677
|
* @summary Remove a custom attribute from a pass
|
|
@@ -134493,7 +134633,7 @@ export class SelfApi extends BaseAPI {
|
|
|
134493
134633
|
export const SelfApikeysApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
134494
134634
|
return {
|
|
134495
134635
|
/**
|
|
134496
|
-
* Generates a new personal API key for the authenticated user with the given name, description, and validity window, returning the full key value only once at creation time.
|
|
134636
|
+
* Generates a new personal API key for the authenticated user with the given name, description, scope, and validity window, returning the full key value only once at creation time.
|
|
134497
134637
|
* @summary Create an API key for the current user
|
|
134498
134638
|
* @param {UserApiKeyCreateInputs} userApiKeyCreateInputs
|
|
134499
134639
|
* @param {*} [options] Override http request option.
|
|
@@ -134679,7 +134819,7 @@ export const SelfApikeysApiFp = function(configuration?: Configuration) {
|
|
|
134679
134819
|
const localVarAxiosParamCreator = SelfApikeysApiAxiosParamCreator(configuration)
|
|
134680
134820
|
return {
|
|
134681
134821
|
/**
|
|
134682
|
-
* Generates a new personal API key for the authenticated user with the given name, description, and validity window, returning the full key value only once at creation time.
|
|
134822
|
+
* Generates a new personal API key for the authenticated user with the given name, description, scope, and validity window, returning the full key value only once at creation time.
|
|
134683
134823
|
* @summary Create an API key for the current user
|
|
134684
134824
|
* @param {UserApiKeyCreateInputs} userApiKeyCreateInputs
|
|
134685
134825
|
* @param {*} [options] Override http request option.
|
|
@@ -134743,7 +134883,7 @@ export const SelfApikeysApiFactory = function (configuration?: Configuration, ba
|
|
|
134743
134883
|
const localVarFp = SelfApikeysApiFp(configuration)
|
|
134744
134884
|
return {
|
|
134745
134885
|
/**
|
|
134746
|
-
* Generates a new personal API key for the authenticated user with the given name, description, and validity window, returning the full key value only once at creation time.
|
|
134886
|
+
* Generates a new personal API key for the authenticated user with the given name, description, scope, and validity window, returning the full key value only once at creation time.
|
|
134747
134887
|
* @summary Create an API key for the current user
|
|
134748
134888
|
* @param {SelfApikeysApiCreateSelfApiKeyRequest} requestParameters Request parameters.
|
|
134749
134889
|
* @param {*} [options] Override http request option.
|
|
@@ -134842,7 +134982,7 @@ export interface SelfApikeysApiGetSelfApiKeysRequest {
|
|
|
134842
134982
|
*/
|
|
134843
134983
|
export class SelfApikeysApi extends BaseAPI {
|
|
134844
134984
|
/**
|
|
134845
|
-
* Generates a new personal API key for the authenticated user with the given name, description, and validity window, returning the full key value only once at creation time.
|
|
134985
|
+
* Generates a new personal API key for the authenticated user with the given name, description, scope, and validity window, returning the full key value only once at creation time.
|
|
134846
134986
|
* @summary Create an API key for the current user
|
|
134847
134987
|
* @param {SelfApikeysApiCreateSelfApiKeyRequest} requestParameters Request parameters.
|
|
134848
134988
|
* @param {*} [options] Override http request option.
|
package/base.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Connected Admin API
|
|
5
5
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 11.
|
|
7
|
+
* The version of the OpenAPI document: 11.10.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/common.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Connected Admin API
|
|
5
5
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 11.
|
|
7
|
+
* The version of the OpenAPI document: 11.10.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/configuration.ts
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
* Connected Admin API
|
|
4
4
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
5
5
|
*
|
|
6
|
-
* The version of the OpenAPI document: 11.
|
|
6
|
+
* The version of the OpenAPI document: 11.10.0
|
|
7
7
|
*
|
|
8
8
|
*
|
|
9
9
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Connected Admin API
|
|
3
3
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 11.
|
|
5
|
+
* The version of the OpenAPI document: 11.10.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -9561,6 +9561,14 @@ export interface ImportCreateInputs {
|
|
|
9561
9561
|
'values'?: Array<AddEventAccessUserRequest> | null;
|
|
9562
9562
|
'type'?: ImportType | null;
|
|
9563
9563
|
}
|
|
9564
|
+
export interface ImportEventPassAttributes200Response {
|
|
9565
|
+
'status': ImportEventPassAttributes200ResponseStatusEnum;
|
|
9566
|
+
'message': string;
|
|
9567
|
+
'data': PassAttributeImportSummary;
|
|
9568
|
+
}
|
|
9569
|
+
export declare enum ImportEventPassAttributes200ResponseStatusEnum {
|
|
9570
|
+
Ok = "ok"
|
|
9571
|
+
}
|
|
9564
9572
|
export interface ImportItem {
|
|
9565
9573
|
'id': string;
|
|
9566
9574
|
'importId': string;
|
|
@@ -10999,6 +11007,29 @@ export interface PassAttribute {
|
|
|
10999
11007
|
'createdAt': string;
|
|
11000
11008
|
'updatedAt': string;
|
|
11001
11009
|
}
|
|
11010
|
+
export interface PassAttributeImportResult {
|
|
11011
|
+
'index': number;
|
|
11012
|
+
'passId': string;
|
|
11013
|
+
'status': PassAttributeImportResultStatusEnum;
|
|
11014
|
+
'message': string | null;
|
|
11015
|
+
}
|
|
11016
|
+
export declare enum PassAttributeImportResultStatusEnum {
|
|
11017
|
+
Resolved = "resolved",
|
|
11018
|
+
Invalid = "invalid"
|
|
11019
|
+
}
|
|
11020
|
+
export interface PassAttributeImportSummary {
|
|
11021
|
+
'created': number;
|
|
11022
|
+
'updated': number;
|
|
11023
|
+
'unchanged': number;
|
|
11024
|
+
'results': Array<PassAttributeImportResult>;
|
|
11025
|
+
}
|
|
11026
|
+
export interface PassAttributesImportInputs {
|
|
11027
|
+
'rows': Array<PassAttributesImportInputsRowsInner>;
|
|
11028
|
+
}
|
|
11029
|
+
export interface PassAttributesImportInputsRowsInner {
|
|
11030
|
+
'passId': string;
|
|
11031
|
+
'values': Array<PassAttributesUpdateInputsValuesInner>;
|
|
11032
|
+
}
|
|
11002
11033
|
export interface PassAttributesUpdateInputs {
|
|
11003
11034
|
'values': Array<PassAttributesUpdateInputsValuesInner>;
|
|
11004
11035
|
}
|
|
@@ -13638,6 +13669,7 @@ export interface UserApiKey {
|
|
|
13638
13669
|
'key': string;
|
|
13639
13670
|
'name': string;
|
|
13640
13671
|
'description'?: string;
|
|
13672
|
+
'scope': UserApiKeyScope;
|
|
13641
13673
|
'startDate': string;
|
|
13642
13674
|
'endDate': string;
|
|
13643
13675
|
'createdAt': string;
|
|
@@ -13646,10 +13678,15 @@ export interface UserApiKey {
|
|
|
13646
13678
|
}
|
|
13647
13679
|
export interface UserApiKeyCreateInputs {
|
|
13648
13680
|
'name': string;
|
|
13681
|
+
'scope'?: UserApiKeyScope;
|
|
13649
13682
|
'startDate': string;
|
|
13650
13683
|
'endDate'?: string;
|
|
13651
13684
|
'description'?: string | null;
|
|
13652
13685
|
}
|
|
13686
|
+
export declare enum UserApiKeyScope {
|
|
13687
|
+
Read = "read",
|
|
13688
|
+
Full = "full"
|
|
13689
|
+
}
|
|
13653
13690
|
export interface UserImageUpdateInputs {
|
|
13654
13691
|
'imageDataUri'?: UserImageUpdateInputsImageDataUri;
|
|
13655
13692
|
'userId'?: UserImageUpdateInputsImageDataUri;
|
|
@@ -39945,6 +39982,15 @@ export declare const EventsPassesAttributesApiAxiosParamCreator: (configuration?
|
|
|
39945
39982
|
* @throws {RequiredError}
|
|
39946
39983
|
*/
|
|
39947
39984
|
getEventPassAttributes: (eventId: string, passId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
39985
|
+
/**
|
|
39986
|
+
* Creates or updates attribute values on up to 500 passes in one call, the write half of a CSV import. Each row\'s passId may be a pass id or the pass\'s alternateId, and each attributeId may be an attribute id or its name. Rows whose pass or attribute cannot be resolved are reported back as invalid and skipped rather than failing the batch. Requires read permission on events and read/update permission on attendees.
|
|
39987
|
+
* @summary Bulk set custom attribute values across many passes
|
|
39988
|
+
* @param {string} eventId The event identifier
|
|
39989
|
+
* @param {PassAttributesImportInputs} passAttributesImportInputs
|
|
39990
|
+
* @param {*} [options] Override http request option.
|
|
39991
|
+
* @throws {RequiredError}
|
|
39992
|
+
*/
|
|
39993
|
+
importEventPassAttributes: (eventId: string, passAttributesImportInputs: PassAttributesImportInputs, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
39948
39994
|
/**
|
|
39949
39995
|
* Deletes a single custom attribute value that had been set on the specified event pass, requires read permission on events and read/update permission on attendees.
|
|
39950
39996
|
* @summary Remove a custom attribute from a pass
|
|
@@ -39983,6 +40029,15 @@ export declare const EventsPassesAttributesApiFp: (configuration?: Configuration
|
|
|
39983
40029
|
* @throws {RequiredError}
|
|
39984
40030
|
*/
|
|
39985
40031
|
getEventPassAttributes(eventId: string, passId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEventPassAttributes200Response>>;
|
|
40032
|
+
/**
|
|
40033
|
+
* Creates or updates attribute values on up to 500 passes in one call, the write half of a CSV import. Each row\'s passId may be a pass id or the pass\'s alternateId, and each attributeId may be an attribute id or its name. Rows whose pass or attribute cannot be resolved are reported back as invalid and skipped rather than failing the batch. Requires read permission on events and read/update permission on attendees.
|
|
40034
|
+
* @summary Bulk set custom attribute values across many passes
|
|
40035
|
+
* @param {string} eventId The event identifier
|
|
40036
|
+
* @param {PassAttributesImportInputs} passAttributesImportInputs
|
|
40037
|
+
* @param {*} [options] Override http request option.
|
|
40038
|
+
* @throws {RequiredError}
|
|
40039
|
+
*/
|
|
40040
|
+
importEventPassAttributes(eventId: string, passAttributesImportInputs: PassAttributesImportInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImportEventPassAttributes200Response>>;
|
|
39986
40041
|
/**
|
|
39987
40042
|
* Deletes a single custom attribute value that had been set on the specified event pass, requires read permission on events and read/update permission on attendees.
|
|
39988
40043
|
* @summary Remove a custom attribute from a pass
|
|
@@ -40016,6 +40071,14 @@ export declare const EventsPassesAttributesApiFactory: (configuration?: Configur
|
|
|
40016
40071
|
* @throws {RequiredError}
|
|
40017
40072
|
*/
|
|
40018
40073
|
getEventPassAttributes(requestParameters: EventsPassesAttributesApiGetEventPassAttributesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetEventPassAttributes200Response>;
|
|
40074
|
+
/**
|
|
40075
|
+
* Creates or updates attribute values on up to 500 passes in one call, the write half of a CSV import. Each row\'s passId may be a pass id or the pass\'s alternateId, and each attributeId may be an attribute id or its name. Rows whose pass or attribute cannot be resolved are reported back as invalid and skipped rather than failing the batch. Requires read permission on events and read/update permission on attendees.
|
|
40076
|
+
* @summary Bulk set custom attribute values across many passes
|
|
40077
|
+
* @param {EventsPassesAttributesApiImportEventPassAttributesRequest} requestParameters Request parameters.
|
|
40078
|
+
* @param {*} [options] Override http request option.
|
|
40079
|
+
* @throws {RequiredError}
|
|
40080
|
+
*/
|
|
40081
|
+
importEventPassAttributes(requestParameters: EventsPassesAttributesApiImportEventPassAttributesRequest, options?: RawAxiosRequestConfig): AxiosPromise<ImportEventPassAttributes200Response>;
|
|
40019
40082
|
/**
|
|
40020
40083
|
* Deletes a single custom attribute value that had been set on the specified event pass, requires read permission on events and read/update permission on attendees.
|
|
40021
40084
|
* @summary Remove a custom attribute from a pass
|
|
@@ -40062,6 +40125,16 @@ export interface EventsPassesAttributesApiGetEventPassAttributesRequest {
|
|
|
40062
40125
|
*/
|
|
40063
40126
|
readonly search?: string;
|
|
40064
40127
|
}
|
|
40128
|
+
/**
|
|
40129
|
+
* Request parameters for importEventPassAttributes operation in EventsPassesAttributesApi.
|
|
40130
|
+
*/
|
|
40131
|
+
export interface EventsPassesAttributesApiImportEventPassAttributesRequest {
|
|
40132
|
+
/**
|
|
40133
|
+
* The event identifier
|
|
40134
|
+
*/
|
|
40135
|
+
readonly eventId: string;
|
|
40136
|
+
readonly passAttributesImportInputs: PassAttributesImportInputs;
|
|
40137
|
+
}
|
|
40065
40138
|
/**
|
|
40066
40139
|
* Request parameters for removeEventPassAttribute operation in EventsPassesAttributesApi.
|
|
40067
40140
|
*/
|
|
@@ -40105,6 +40178,14 @@ export declare class EventsPassesAttributesApi extends BaseAPI {
|
|
|
40105
40178
|
* @throws {RequiredError}
|
|
40106
40179
|
*/
|
|
40107
40180
|
getEventPassAttributes(requestParameters: EventsPassesAttributesApiGetEventPassAttributesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEventPassAttributes200Response, any, {}, any>>;
|
|
40181
|
+
/**
|
|
40182
|
+
* Creates or updates attribute values on up to 500 passes in one call, the write half of a CSV import. Each row\'s passId may be a pass id or the pass\'s alternateId, and each attributeId may be an attribute id or its name. Rows whose pass or attribute cannot be resolved are reported back as invalid and skipped rather than failing the batch. Requires read permission on events and read/update permission on attendees.
|
|
40183
|
+
* @summary Bulk set custom attribute values across many passes
|
|
40184
|
+
* @param {EventsPassesAttributesApiImportEventPassAttributesRequest} requestParameters Request parameters.
|
|
40185
|
+
* @param {*} [options] Override http request option.
|
|
40186
|
+
* @throws {RequiredError}
|
|
40187
|
+
*/
|
|
40188
|
+
importEventPassAttributes(requestParameters: EventsPassesAttributesApiImportEventPassAttributesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ImportEventPassAttributes200Response, any, {}, any>>;
|
|
40108
40189
|
/**
|
|
40109
40190
|
* Deletes a single custom attribute value that had been set on the specified event pass, requires read permission on events and read/update permission on attendees.
|
|
40110
40191
|
* @summary Remove a custom attribute from a pass
|
|
@@ -73967,7 +74048,7 @@ export declare class SelfApi extends BaseAPI {
|
|
|
73967
74048
|
*/
|
|
73968
74049
|
export declare const SelfApikeysApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
73969
74050
|
/**
|
|
73970
|
-
* Generates a new personal API key for the authenticated user with the given name, description, and validity window, returning the full key value only once at creation time.
|
|
74051
|
+
* Generates a new personal API key for the authenticated user with the given name, description, scope, and validity window, returning the full key value only once at creation time.
|
|
73971
74052
|
* @summary Create an API key for the current user
|
|
73972
74053
|
* @param {UserApiKeyCreateInputs} userApiKeyCreateInputs
|
|
73973
74054
|
* @param {*} [options] Override http request option.
|
|
@@ -74007,7 +74088,7 @@ export declare const SelfApikeysApiAxiosParamCreator: (configuration?: Configura
|
|
|
74007
74088
|
*/
|
|
74008
74089
|
export declare const SelfApikeysApiFp: (configuration?: Configuration) => {
|
|
74009
74090
|
/**
|
|
74010
|
-
* Generates a new personal API key for the authenticated user with the given name, description, and validity window, returning the full key value only once at creation time.
|
|
74091
|
+
* Generates a new personal API key for the authenticated user with the given name, description, scope, and validity window, returning the full key value only once at creation time.
|
|
74011
74092
|
* @summary Create an API key for the current user
|
|
74012
74093
|
* @param {UserApiKeyCreateInputs} userApiKeyCreateInputs
|
|
74013
74094
|
* @param {*} [options] Override http request option.
|
|
@@ -74047,7 +74128,7 @@ export declare const SelfApikeysApiFp: (configuration?: Configuration) => {
|
|
|
74047
74128
|
*/
|
|
74048
74129
|
export declare const SelfApikeysApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
74049
74130
|
/**
|
|
74050
|
-
* Generates a new personal API key for the authenticated user with the given name, description, and validity window, returning the full key value only once at creation time.
|
|
74131
|
+
* Generates a new personal API key for the authenticated user with the given name, description, scope, and validity window, returning the full key value only once at creation time.
|
|
74051
74132
|
* @summary Create an API key for the current user
|
|
74052
74133
|
* @param {SelfApikeysApiCreateSelfApiKeyRequest} requestParameters Request parameters.
|
|
74053
74134
|
* @param {*} [options] Override http request option.
|
|
@@ -74129,7 +74210,7 @@ export interface SelfApikeysApiGetSelfApiKeysRequest {
|
|
|
74129
74210
|
*/
|
|
74130
74211
|
export declare class SelfApikeysApi extends BaseAPI {
|
|
74131
74212
|
/**
|
|
74132
|
-
* Generates a new personal API key for the authenticated user with the given name, description, and validity window, returning the full key value only once at creation time.
|
|
74213
|
+
* Generates a new personal API key for the authenticated user with the given name, description, scope, and validity window, returning the full key value only once at creation time.
|
|
74133
74214
|
* @summary Create an API key for the current user
|
|
74134
74215
|
* @param {SelfApikeysApiCreateSelfApiKeyRequest} requestParameters Request parameters.
|
|
74135
74216
|
* @param {*} [options] Override http request option.
|