@connectedxm/admin-sdk 11.7.0 → 11.8.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 +4 -1
- package/AdminApi.ts +3 -3
- package/README.md +2 -2
- package/api.ts +192 -38
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/AdminApi.d.ts +2 -2
- package/dist/AdminApi.js +1 -1
- package/dist/api.d.ts +116 -27
- package/dist/api.js +154 -54
- 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/AdminApi.d.ts +2 -2
- package/dist/esm/AdminApi.js +2 -2
- package/dist/esm/api.d.ts +116 -27
- package/dist/esm/api.js +126 -26
- 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/EventPassChange.md +38 -0
- package/docs/{EventsPasschangewebhooksApi.md → EventsPasschangesApi.md} +71 -10
- package/docs/GetEventPassChanges200Response.md +24 -0
- package/docs/PassChangeLogType.md +22 -0
- package/package.json +1 -1
package/dist/esm/api.js
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.8.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1196,6 +1196,10 @@ export var GetEventPassChangeWebhooks200ResponseStatusEnum;
|
|
|
1196
1196
|
(function (GetEventPassChangeWebhooks200ResponseStatusEnum) {
|
|
1197
1197
|
GetEventPassChangeWebhooks200ResponseStatusEnum["Ok"] = "ok";
|
|
1198
1198
|
})(GetEventPassChangeWebhooks200ResponseStatusEnum || (GetEventPassChangeWebhooks200ResponseStatusEnum = {}));
|
|
1199
|
+
export var GetEventPassChanges200ResponseStatusEnum;
|
|
1200
|
+
(function (GetEventPassChanges200ResponseStatusEnum) {
|
|
1201
|
+
GetEventPassChanges200ResponseStatusEnum["Ok"] = "ok";
|
|
1202
|
+
})(GetEventPassChanges200ResponseStatusEnum || (GetEventPassChanges200ResponseStatusEnum = {}));
|
|
1199
1203
|
export var GetEventPassMatches200ResponseStatusEnum;
|
|
1200
1204
|
(function (GetEventPassMatches200ResponseStatusEnum) {
|
|
1201
1205
|
GetEventPassMatches200ResponseStatusEnum["Ok"] = "ok";
|
|
@@ -2334,6 +2338,17 @@ export var PageType;
|
|
|
2334
2338
|
PageType["Terms"] = "terms";
|
|
2335
2339
|
PageType["Team"] = "team";
|
|
2336
2340
|
})(PageType || (PageType = {}));
|
|
2341
|
+
export var PassChangeLogType;
|
|
2342
|
+
(function (PassChangeLogType) {
|
|
2343
|
+
PassChangeLogType["Status"] = "status";
|
|
2344
|
+
PassChangeLogType["PassType"] = "passType";
|
|
2345
|
+
PassChangeLogType["Response"] = "response";
|
|
2346
|
+
PassChangeLogType["AddOn"] = "addOn";
|
|
2347
|
+
PassChangeLogType["Session"] = "session";
|
|
2348
|
+
PassChangeLogType["Registration"] = "registration";
|
|
2349
|
+
PassChangeLogType["Email"] = "email";
|
|
2350
|
+
PassChangeLogType["InternalRefId"] = "internalRefId";
|
|
2351
|
+
})(PassChangeLogType || (PassChangeLogType = {}));
|
|
2337
2352
|
export var PassTypeAccessLevel;
|
|
2338
2353
|
(function (PassTypeAccessLevel) {
|
|
2339
2354
|
PassTypeAccessLevel["Regular"] = "regular";
|
|
@@ -39772,9 +39787,9 @@ export class EventsPagesTranslationsApi extends BaseAPI {
|
|
|
39772
39787
|
}
|
|
39773
39788
|
}
|
|
39774
39789
|
/**
|
|
39775
|
-
*
|
|
39790
|
+
* EventsPasschangesApi - axios parameter creator
|
|
39776
39791
|
*/
|
|
39777
|
-
export const
|
|
39792
|
+
export const EventsPasschangesApiAxiosParamCreator = function (configuration) {
|
|
39778
39793
|
return {
|
|
39779
39794
|
/**
|
|
39780
39795
|
* Connects the specified webhook so it receives the event\'s pass change log rows, and requires update permission on events; the webhook must be verified.
|
|
@@ -39789,7 +39804,7 @@ export const EventsPasschangewebhooksApiAxiosParamCreator = function (configurat
|
|
|
39789
39804
|
assertParamExists('addEventPassChangeWebhook', 'eventId', eventId);
|
|
39790
39805
|
// verify required parameter 'webhookId' is not null or undefined
|
|
39791
39806
|
assertParamExists('addEventPassChangeWebhook', 'webhookId', webhookId);
|
|
39792
|
-
const localVarPath = `/events/{eventId}/
|
|
39807
|
+
const localVarPath = `/events/{eventId}/passChanges/webhooks/{webhookId}`
|
|
39793
39808
|
.replace('{eventId}', encodeURIComponent(String(eventId)))
|
|
39794
39809
|
.replace('{webhookId}', encodeURIComponent(String(webhookId)));
|
|
39795
39810
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -39828,7 +39843,7 @@ export const EventsPasschangewebhooksApiAxiosParamCreator = function (configurat
|
|
|
39828
39843
|
getEventPassChangeWebhooks: (eventId_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1) => __awaiter(this, [eventId_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1], void 0, function* (eventId, page, pageSize, orderBy, search, options = {}) {
|
|
39829
39844
|
// verify required parameter 'eventId' is not null or undefined
|
|
39830
39845
|
assertParamExists('getEventPassChangeWebhooks', 'eventId', eventId);
|
|
39831
|
-
const localVarPath = `/events/{eventId}/
|
|
39846
|
+
const localVarPath = `/events/{eventId}/passChanges/webhooks`
|
|
39832
39847
|
.replace('{eventId}', encodeURIComponent(String(eventId)));
|
|
39833
39848
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
39834
39849
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -39864,6 +39879,52 @@ export const EventsPasschangewebhooksApiAxiosParamCreator = function (configurat
|
|
|
39864
39879
|
options: localVarRequestOptions,
|
|
39865
39880
|
};
|
|
39866
39881
|
}),
|
|
39882
|
+
/**
|
|
39883
|
+
* Returns a cursor-paginated feed of the event\'s pass change log rows in ascending order; pass the last returned cursor on the next call to tail new changes. Optionally filter by subjectId or change type. Requires read permission on events.
|
|
39884
|
+
* @summary Poll an event\'s pass changes
|
|
39885
|
+
* @param {string} eventId The event identifier
|
|
39886
|
+
* @param {string} [subjectId] Filter by subjectId
|
|
39887
|
+
* @param {PassChangeLogType} [type] Filter by type
|
|
39888
|
+
* @param {string} [passId] Filter by passId
|
|
39889
|
+
* @param {*} [options] Override http request option.
|
|
39890
|
+
* @throws {RequiredError}
|
|
39891
|
+
*/
|
|
39892
|
+
getEventPassChanges: (eventId_1, subjectId_1, type_1, passId_1, ...args_1) => __awaiter(this, [eventId_1, subjectId_1, type_1, passId_1, ...args_1], void 0, function* (eventId, subjectId, type, passId, options = {}) {
|
|
39893
|
+
// verify required parameter 'eventId' is not null or undefined
|
|
39894
|
+
assertParamExists('getEventPassChanges', 'eventId', eventId);
|
|
39895
|
+
const localVarPath = `/events/{eventId}/passChanges`
|
|
39896
|
+
.replace('{eventId}', encodeURIComponent(String(eventId)));
|
|
39897
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
39898
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
39899
|
+
let baseOptions;
|
|
39900
|
+
if (configuration) {
|
|
39901
|
+
baseOptions = configuration.baseOptions;
|
|
39902
|
+
}
|
|
39903
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
39904
|
+
const localVarHeaderParameter = {};
|
|
39905
|
+
const localVarQueryParameter = {};
|
|
39906
|
+
// authentication ApiKeyAuth required
|
|
39907
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
39908
|
+
// authentication OrganizationId required
|
|
39909
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
39910
|
+
if (subjectId !== undefined) {
|
|
39911
|
+
localVarQueryParameter['subjectId'] = subjectId;
|
|
39912
|
+
}
|
|
39913
|
+
if (type !== undefined) {
|
|
39914
|
+
localVarQueryParameter['type'] = type;
|
|
39915
|
+
}
|
|
39916
|
+
if (passId !== undefined) {
|
|
39917
|
+
localVarQueryParameter['passId'] = passId;
|
|
39918
|
+
}
|
|
39919
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
39920
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
39921
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
39922
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
39923
|
+
return {
|
|
39924
|
+
url: toPathString(localVarUrlObj),
|
|
39925
|
+
options: localVarRequestOptions,
|
|
39926
|
+
};
|
|
39927
|
+
}),
|
|
39867
39928
|
/**
|
|
39868
39929
|
* Disconnects the specified webhook from the given event\'s pass change log and requires update permission on events.
|
|
39869
39930
|
* @summary Disconnect a webhook from an event\'s pass change log
|
|
@@ -39877,7 +39938,7 @@ export const EventsPasschangewebhooksApiAxiosParamCreator = function (configurat
|
|
|
39877
39938
|
assertParamExists('removeEventPassChangeWebhook', 'eventId', eventId);
|
|
39878
39939
|
// verify required parameter 'webhookId' is not null or undefined
|
|
39879
39940
|
assertParamExists('removeEventPassChangeWebhook', 'webhookId', webhookId);
|
|
39880
|
-
const localVarPath = `/events/{eventId}/
|
|
39941
|
+
const localVarPath = `/events/{eventId}/passChanges/webhooks/{webhookId}`
|
|
39881
39942
|
.replace('{eventId}', encodeURIComponent(String(eventId)))
|
|
39882
39943
|
.replace('{webhookId}', encodeURIComponent(String(webhookId)));
|
|
39883
39944
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -39905,10 +39966,10 @@ export const EventsPasschangewebhooksApiAxiosParamCreator = function (configurat
|
|
|
39905
39966
|
};
|
|
39906
39967
|
};
|
|
39907
39968
|
/**
|
|
39908
|
-
*
|
|
39969
|
+
* EventsPasschangesApi - functional programming interface
|
|
39909
39970
|
*/
|
|
39910
|
-
export const
|
|
39911
|
-
const localVarAxiosParamCreator =
|
|
39971
|
+
export const EventsPasschangesApiFp = function (configuration) {
|
|
39972
|
+
const localVarAxiosParamCreator = EventsPasschangesApiAxiosParamCreator(configuration);
|
|
39912
39973
|
return {
|
|
39913
39974
|
/**
|
|
39914
39975
|
* Connects the specified webhook so it receives the event\'s pass change log rows, and requires update permission on events; the webhook must be verified.
|
|
@@ -39923,7 +39984,7 @@ export const EventsPasschangewebhooksApiFp = function (configuration) {
|
|
|
39923
39984
|
var _a, _b, _c;
|
|
39924
39985
|
const localVarAxiosArgs = yield localVarAxiosParamCreator.addEventPassChangeWebhook(eventId, webhookId, options);
|
|
39925
39986
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
39926
|
-
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['
|
|
39987
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['EventsPasschangesApi.addEventPassChangeWebhook']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
39927
39988
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
39928
39989
|
});
|
|
39929
39990
|
},
|
|
@@ -39943,7 +40004,26 @@ export const EventsPasschangewebhooksApiFp = function (configuration) {
|
|
|
39943
40004
|
var _a, _b, _c;
|
|
39944
40005
|
const localVarAxiosArgs = yield localVarAxiosParamCreator.getEventPassChangeWebhooks(eventId, page, pageSize, orderBy, search, options);
|
|
39945
40006
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
39946
|
-
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['
|
|
40007
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['EventsPasschangesApi.getEventPassChangeWebhooks']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
40008
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
40009
|
+
});
|
|
40010
|
+
},
|
|
40011
|
+
/**
|
|
40012
|
+
* Returns a cursor-paginated feed of the event\'s pass change log rows in ascending order; pass the last returned cursor on the next call to tail new changes. Optionally filter by subjectId or change type. Requires read permission on events.
|
|
40013
|
+
* @summary Poll an event\'s pass changes
|
|
40014
|
+
* @param {string} eventId The event identifier
|
|
40015
|
+
* @param {string} [subjectId] Filter by subjectId
|
|
40016
|
+
* @param {PassChangeLogType} [type] Filter by type
|
|
40017
|
+
* @param {string} [passId] Filter by passId
|
|
40018
|
+
* @param {*} [options] Override http request option.
|
|
40019
|
+
* @throws {RequiredError}
|
|
40020
|
+
*/
|
|
40021
|
+
getEventPassChanges(eventId, subjectId, type, passId, options) {
|
|
40022
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
40023
|
+
var _a, _b, _c;
|
|
40024
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getEventPassChanges(eventId, subjectId, type, passId, options);
|
|
40025
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
40026
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['EventsPasschangesApi.getEventPassChanges']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
39947
40027
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
39948
40028
|
});
|
|
39949
40029
|
},
|
|
@@ -39960,22 +40040,22 @@ export const EventsPasschangewebhooksApiFp = function (configuration) {
|
|
|
39960
40040
|
var _a, _b, _c;
|
|
39961
40041
|
const localVarAxiosArgs = yield localVarAxiosParamCreator.removeEventPassChangeWebhook(eventId, webhookId, options);
|
|
39962
40042
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
39963
|
-
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['
|
|
40043
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['EventsPasschangesApi.removeEventPassChangeWebhook']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
39964
40044
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
39965
40045
|
});
|
|
39966
40046
|
},
|
|
39967
40047
|
};
|
|
39968
40048
|
};
|
|
39969
40049
|
/**
|
|
39970
|
-
*
|
|
40050
|
+
* EventsPasschangesApi - factory interface
|
|
39971
40051
|
*/
|
|
39972
|
-
export const
|
|
39973
|
-
const localVarFp =
|
|
40052
|
+
export const EventsPasschangesApiFactory = function (configuration, basePath, axios) {
|
|
40053
|
+
const localVarFp = EventsPasschangesApiFp(configuration);
|
|
39974
40054
|
return {
|
|
39975
40055
|
/**
|
|
39976
40056
|
* Connects the specified webhook so it receives the event\'s pass change log rows, and requires update permission on events; the webhook must be verified.
|
|
39977
40057
|
* @summary Connect a webhook to an event\'s pass change log
|
|
39978
|
-
* @param {
|
|
40058
|
+
* @param {EventsPasschangesApiAddEventPassChangeWebhookRequest} requestParameters Request parameters.
|
|
39979
40059
|
* @param {*} [options] Override http request option.
|
|
39980
40060
|
* @throws {RequiredError}
|
|
39981
40061
|
*/
|
|
@@ -39985,17 +40065,27 @@ export const EventsPasschangewebhooksApiFactory = function (configuration, baseP
|
|
|
39985
40065
|
/**
|
|
39986
40066
|
* Returns a paginated list of the webhooks connected to the given event\'s pass change log; requires \"read\" permission on events.
|
|
39987
40067
|
* @summary List an event\'s pass change log webhooks
|
|
39988
|
-
* @param {
|
|
40068
|
+
* @param {EventsPasschangesApiGetEventPassChangeWebhooksRequest} requestParameters Request parameters.
|
|
39989
40069
|
* @param {*} [options] Override http request option.
|
|
39990
40070
|
* @throws {RequiredError}
|
|
39991
40071
|
*/
|
|
39992
40072
|
getEventPassChangeWebhooks(requestParameters, options) {
|
|
39993
40073
|
return localVarFp.getEventPassChangeWebhooks(requestParameters.eventId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
39994
40074
|
},
|
|
40075
|
+
/**
|
|
40076
|
+
* Returns a cursor-paginated feed of the event\'s pass change log rows in ascending order; pass the last returned cursor on the next call to tail new changes. Optionally filter by subjectId or change type. Requires read permission on events.
|
|
40077
|
+
* @summary Poll an event\'s pass changes
|
|
40078
|
+
* @param {EventsPasschangesApiGetEventPassChangesRequest} requestParameters Request parameters.
|
|
40079
|
+
* @param {*} [options] Override http request option.
|
|
40080
|
+
* @throws {RequiredError}
|
|
40081
|
+
*/
|
|
40082
|
+
getEventPassChanges(requestParameters, options) {
|
|
40083
|
+
return localVarFp.getEventPassChanges(requestParameters.eventId, requestParameters.subjectId, requestParameters.type, requestParameters.passId, options).then((request) => request(axios, basePath));
|
|
40084
|
+
},
|
|
39995
40085
|
/**
|
|
39996
40086
|
* Disconnects the specified webhook from the given event\'s pass change log and requires update permission on events.
|
|
39997
40087
|
* @summary Disconnect a webhook from an event\'s pass change log
|
|
39998
|
-
* @param {
|
|
40088
|
+
* @param {EventsPasschangesApiRemoveEventPassChangeWebhookRequest} requestParameters Request parameters.
|
|
39999
40089
|
* @param {*} [options] Override http request option.
|
|
40000
40090
|
* @throws {RequiredError}
|
|
40001
40091
|
*/
|
|
@@ -40005,38 +40095,48 @@ export const EventsPasschangewebhooksApiFactory = function (configuration, baseP
|
|
|
40005
40095
|
};
|
|
40006
40096
|
};
|
|
40007
40097
|
/**
|
|
40008
|
-
*
|
|
40098
|
+
* EventsPasschangesApi - object-oriented interface
|
|
40009
40099
|
*/
|
|
40010
|
-
export class
|
|
40100
|
+
export class EventsPasschangesApi extends BaseAPI {
|
|
40011
40101
|
/**
|
|
40012
40102
|
* Connects the specified webhook so it receives the event\'s pass change log rows, and requires update permission on events; the webhook must be verified.
|
|
40013
40103
|
* @summary Connect a webhook to an event\'s pass change log
|
|
40014
|
-
* @param {
|
|
40104
|
+
* @param {EventsPasschangesApiAddEventPassChangeWebhookRequest} requestParameters Request parameters.
|
|
40015
40105
|
* @param {*} [options] Override http request option.
|
|
40016
40106
|
* @throws {RequiredError}
|
|
40017
40107
|
*/
|
|
40018
40108
|
addEventPassChangeWebhook(requestParameters, options) {
|
|
40019
|
-
return
|
|
40109
|
+
return EventsPasschangesApiFp(this.configuration).addEventPassChangeWebhook(requestParameters.eventId, requestParameters.webhookId, options).then((request) => request(this.axios, this.basePath));
|
|
40020
40110
|
}
|
|
40021
40111
|
/**
|
|
40022
40112
|
* Returns a paginated list of the webhooks connected to the given event\'s pass change log; requires \"read\" permission on events.
|
|
40023
40113
|
* @summary List an event\'s pass change log webhooks
|
|
40024
|
-
* @param {
|
|
40114
|
+
* @param {EventsPasschangesApiGetEventPassChangeWebhooksRequest} requestParameters Request parameters.
|
|
40025
40115
|
* @param {*} [options] Override http request option.
|
|
40026
40116
|
* @throws {RequiredError}
|
|
40027
40117
|
*/
|
|
40028
40118
|
getEventPassChangeWebhooks(requestParameters, options) {
|
|
40029
|
-
return
|
|
40119
|
+
return EventsPasschangesApiFp(this.configuration).getEventPassChangeWebhooks(requestParameters.eventId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
40120
|
+
}
|
|
40121
|
+
/**
|
|
40122
|
+
* Returns a cursor-paginated feed of the event\'s pass change log rows in ascending order; pass the last returned cursor on the next call to tail new changes. Optionally filter by subjectId or change type. Requires read permission on events.
|
|
40123
|
+
* @summary Poll an event\'s pass changes
|
|
40124
|
+
* @param {EventsPasschangesApiGetEventPassChangesRequest} requestParameters Request parameters.
|
|
40125
|
+
* @param {*} [options] Override http request option.
|
|
40126
|
+
* @throws {RequiredError}
|
|
40127
|
+
*/
|
|
40128
|
+
getEventPassChanges(requestParameters, options) {
|
|
40129
|
+
return EventsPasschangesApiFp(this.configuration).getEventPassChanges(requestParameters.eventId, requestParameters.subjectId, requestParameters.type, requestParameters.passId, options).then((request) => request(this.axios, this.basePath));
|
|
40030
40130
|
}
|
|
40031
40131
|
/**
|
|
40032
40132
|
* Disconnects the specified webhook from the given event\'s pass change log and requires update permission on events.
|
|
40033
40133
|
* @summary Disconnect a webhook from an event\'s pass change log
|
|
40034
|
-
* @param {
|
|
40134
|
+
* @param {EventsPasschangesApiRemoveEventPassChangeWebhookRequest} requestParameters Request parameters.
|
|
40035
40135
|
* @param {*} [options] Override http request option.
|
|
40036
40136
|
* @throws {RequiredError}
|
|
40037
40137
|
*/
|
|
40038
40138
|
removeEventPassChangeWebhook(requestParameters, options) {
|
|
40039
|
-
return
|
|
40139
|
+
return EventsPasschangesApiFp(this.configuration).removeEventPassChangeWebhook(requestParameters.eventId, requestParameters.webhookId, options).then((request) => request(this.axios, this.basePath));
|
|
40040
40140
|
}
|
|
40041
40141
|
}
|
|
40042
40142
|
/**
|
package/dist/esm/base.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.8.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/base.js
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.8.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/common.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.8.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/common.js
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.8.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -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.8.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -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.8.0
|
|
7
7
|
*
|
|
8
8
|
*
|
|
9
9
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# EventPassChange
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | | [default to undefined]
|
|
9
|
+
**alternateId** | **number** | | [default to undefined]
|
|
10
|
+
**type** | [**PassChangeLogType**](PassChangeLogType.md) | | [default to undefined]
|
|
11
|
+
**description** | **string** | | [default to undefined]
|
|
12
|
+
**subjectId** | **string** | | [default to undefined]
|
|
13
|
+
**oldValue** | **string** | | [default to undefined]
|
|
14
|
+
**newValue** | **string** | | [default to undefined]
|
|
15
|
+
**occurredAt** | **string** | | [default to undefined]
|
|
16
|
+
**passId** | **string** | | [default to undefined]
|
|
17
|
+
**createdAt** | **string** | | [default to undefined]
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import { EventPassChange } from '@connectedxm/admin-sdk';
|
|
23
|
+
|
|
24
|
+
const instance: EventPassChange = {
|
|
25
|
+
id,
|
|
26
|
+
alternateId,
|
|
27
|
+
type,
|
|
28
|
+
description,
|
|
29
|
+
subjectId,
|
|
30
|
+
oldValue,
|
|
31
|
+
newValue,
|
|
32
|
+
occurredAt,
|
|
33
|
+
passId,
|
|
34
|
+
createdAt,
|
|
35
|
+
};
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -1,12 +1,13 @@
|
|
|
1
|
-
#
|
|
1
|
+
# EventsPasschangesApi
|
|
2
2
|
|
|
3
3
|
All URIs are relative to *https://admin-api.connected.dev*
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**addEventPassChangeWebhook**](#addeventpasschangewebhook) | **POST** /events/{eventId}/
|
|
8
|
-
|[**getEventPassChangeWebhooks**](#geteventpasschangewebhooks) | **GET** /events/{eventId}/
|
|
9
|
-
|[**
|
|
7
|
+
|[**addEventPassChangeWebhook**](#addeventpasschangewebhook) | **POST** /events/{eventId}/passChanges/webhooks/{webhookId} | Connect a webhook to an event\'s pass change log|
|
|
8
|
+
|[**getEventPassChangeWebhooks**](#geteventpasschangewebhooks) | **GET** /events/{eventId}/passChanges/webhooks | List an event\'s pass change log webhooks|
|
|
9
|
+
|[**getEventPassChanges**](#geteventpasschanges) | **GET** /events/{eventId}/passChanges | Poll an event\'s pass changes|
|
|
10
|
+
|[**removeEventPassChangeWebhook**](#removeeventpasschangewebhook) | **DELETE** /events/{eventId}/passChanges/webhooks/{webhookId} | Disconnect a webhook from an event\'s pass change log|
|
|
10
11
|
|
|
11
12
|
# **addEventPassChangeWebhook**
|
|
12
13
|
> AddEventPassChangeWebhook200Response addEventPassChangeWebhook()
|
|
@@ -17,12 +18,12 @@ Connects the specified webhook so it receives the event\'s pass change log rows,
|
|
|
17
18
|
|
|
18
19
|
```typescript
|
|
19
20
|
import {
|
|
20
|
-
|
|
21
|
+
EventsPasschangesApi,
|
|
21
22
|
Configuration
|
|
22
23
|
} from '@connectedxm/admin-sdk';
|
|
23
24
|
|
|
24
25
|
const configuration = new Configuration();
|
|
25
|
-
const apiInstance = new
|
|
26
|
+
const apiInstance = new EventsPasschangesApi(configuration);
|
|
26
27
|
|
|
27
28
|
let eventId: string; //The event identifier (default to undefined)
|
|
28
29
|
let webhookId: string; //The webhook identifier (default to undefined)
|
|
@@ -71,12 +72,12 @@ Returns a paginated list of the webhooks connected to the given event\'s pass ch
|
|
|
71
72
|
|
|
72
73
|
```typescript
|
|
73
74
|
import {
|
|
74
|
-
|
|
75
|
+
EventsPasschangesApi,
|
|
75
76
|
Configuration
|
|
76
77
|
} from '@connectedxm/admin-sdk';
|
|
77
78
|
|
|
78
79
|
const configuration = new Configuration();
|
|
79
|
-
const apiInstance = new
|
|
80
|
+
const apiInstance = new EventsPasschangesApi(configuration);
|
|
80
81
|
|
|
81
82
|
let eventId: string; //The event identifier (default to undefined)
|
|
82
83
|
let page: number; //Page number (optional) (default to 1)
|
|
@@ -118,6 +119,66 @@ const { status, data } = await apiInstance.getEventPassChangeWebhooks(
|
|
|
118
119
|
- **Accept**: application/json
|
|
119
120
|
|
|
120
121
|
|
|
122
|
+
### HTTP response details
|
|
123
|
+
| Status code | Description | Response headers |
|
|
124
|
+
|-------------|-------------|------------------|
|
|
125
|
+
|**200** | Successful response | - |
|
|
126
|
+
|
|
127
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
128
|
+
|
|
129
|
+
# **getEventPassChanges**
|
|
130
|
+
> GetEventPassChanges200Response getEventPassChanges()
|
|
131
|
+
|
|
132
|
+
Returns a cursor-paginated feed of the event\'s pass change log rows in ascending order; pass the last returned cursor on the next call to tail new changes. Optionally filter by subjectId or change type. Requires read permission on events.
|
|
133
|
+
|
|
134
|
+
### Example
|
|
135
|
+
|
|
136
|
+
```typescript
|
|
137
|
+
import {
|
|
138
|
+
EventsPasschangesApi,
|
|
139
|
+
Configuration
|
|
140
|
+
} from '@connectedxm/admin-sdk';
|
|
141
|
+
|
|
142
|
+
const configuration = new Configuration();
|
|
143
|
+
const apiInstance = new EventsPasschangesApi(configuration);
|
|
144
|
+
|
|
145
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
146
|
+
let subjectId: string; //Filter by subjectId (optional) (default to undefined)
|
|
147
|
+
let type: PassChangeLogType; //Filter by type (optional) (default to undefined)
|
|
148
|
+
let passId: string; //Filter by passId (optional) (default to undefined)
|
|
149
|
+
|
|
150
|
+
const { status, data } = await apiInstance.getEventPassChanges(
|
|
151
|
+
eventId,
|
|
152
|
+
subjectId,
|
|
153
|
+
type,
|
|
154
|
+
passId
|
|
155
|
+
);
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
### Parameters
|
|
159
|
+
|
|
160
|
+
|Name | Type | Description | Notes|
|
|
161
|
+
|------------- | ------------- | ------------- | -------------|
|
|
162
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
163
|
+
| **subjectId** | [**string**] | Filter by subjectId | (optional) defaults to undefined|
|
|
164
|
+
| **type** | **PassChangeLogType** | Filter by type | (optional) defaults to undefined|
|
|
165
|
+
| **passId** | [**string**] | Filter by passId | (optional) defaults to undefined|
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
### Return type
|
|
169
|
+
|
|
170
|
+
**GetEventPassChanges200Response**
|
|
171
|
+
|
|
172
|
+
### Authorization
|
|
173
|
+
|
|
174
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
175
|
+
|
|
176
|
+
### HTTP request headers
|
|
177
|
+
|
|
178
|
+
- **Content-Type**: Not defined
|
|
179
|
+
- **Accept**: application/json
|
|
180
|
+
|
|
181
|
+
|
|
121
182
|
### HTTP response details
|
|
122
183
|
| Status code | Description | Response headers |
|
|
123
184
|
|-------------|-------------|------------------|
|
|
@@ -134,12 +195,12 @@ Disconnects the specified webhook from the given event\'s pass change log and re
|
|
|
134
195
|
|
|
135
196
|
```typescript
|
|
136
197
|
import {
|
|
137
|
-
|
|
198
|
+
EventsPasschangesApi,
|
|
138
199
|
Configuration
|
|
139
200
|
} from '@connectedxm/admin-sdk';
|
|
140
201
|
|
|
141
202
|
const configuration = new Configuration();
|
|
142
|
-
const apiInstance = new
|
|
203
|
+
const apiInstance = new EventsPasschangesApi(configuration);
|
|
143
204
|
|
|
144
205
|
let eventId: string; //The event identifier (default to undefined)
|
|
145
206
|
let webhookId: string; //The webhook identifier (default to undefined)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# GetEventPassChanges200Response
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**status** | **string** | | [default to undefined]
|
|
9
|
+
**message** | **string** | | [default to undefined]
|
|
10
|
+
**data** | [**Array<EventPassChange>**](EventPassChange.md) | | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { GetEventPassChanges200Response } from '@connectedxm/admin-sdk';
|
|
16
|
+
|
|
17
|
+
const instance: GetEventPassChanges200Response = {
|
|
18
|
+
status,
|
|
19
|
+
message,
|
|
20
|
+
data,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# PassChangeLogType
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Enum
|
|
5
|
+
|
|
6
|
+
* `Status` (value: `'status'`)
|
|
7
|
+
|
|
8
|
+
* `PassType` (value: `'passType'`)
|
|
9
|
+
|
|
10
|
+
* `Response` (value: `'response'`)
|
|
11
|
+
|
|
12
|
+
* `AddOn` (value: `'addOn'`)
|
|
13
|
+
|
|
14
|
+
* `Session` (value: `'session'`)
|
|
15
|
+
|
|
16
|
+
* `Registration` (value: `'registration'`)
|
|
17
|
+
|
|
18
|
+
* `Email` (value: `'email'`)
|
|
19
|
+
|
|
20
|
+
* `InternalRefId` (value: `'internalRefId'`)
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|