@connectedxm/admin-sdk 11.0.2 → 11.1.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 +3 -2
- package/AdminApi.ts +3 -0
- package/README.md +2 -2
- package/api.ts +381 -32
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/AdminApi.d.ts +2 -1
- package/dist/AdminApi.js +1 -0
- package/dist/api.d.ts +212 -33
- package/dist/api.js +298 -26
- 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 -1
- package/dist/esm/AdminApi.js +2 -1
- package/dist/esm/api.d.ts +212 -33
- package/dist/esm/api.js +277 -9
- 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/{CreateOrganizationWebhook200Response.md → AddEventPassChangeWebhook200Response.md} +3 -3
- package/docs/EventsPasschangewebhooksApi.md +181 -0
- package/docs/{GetOrganizationWebhooks200Response.md → GetEventPassChangeWebhooks200Response.md} +3 -3
- package/docs/OrganizationWebhooksApi.md +10 -10
- 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.0
|
|
7
|
+
* The version of the OpenAPI document: 11.1.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -85,6 +85,10 @@ export var AddEventOnSiteLabelPassType200ResponseStatusEnum;
|
|
|
85
85
|
(function (AddEventOnSiteLabelPassType200ResponseStatusEnum) {
|
|
86
86
|
AddEventOnSiteLabelPassType200ResponseStatusEnum["Ok"] = "ok";
|
|
87
87
|
})(AddEventOnSiteLabelPassType200ResponseStatusEnum || (AddEventOnSiteLabelPassType200ResponseStatusEnum = {}));
|
|
88
|
+
export var AddEventPassChangeWebhook200ResponseStatusEnum;
|
|
89
|
+
(function (AddEventPassChangeWebhook200ResponseStatusEnum) {
|
|
90
|
+
AddEventPassChangeWebhook200ResponseStatusEnum["Ok"] = "ok";
|
|
91
|
+
})(AddEventPassChangeWebhook200ResponseStatusEnum || (AddEventPassChangeWebhook200ResponseStatusEnum = {}));
|
|
88
92
|
export var AddEventPassTypeExchangeTarget200ResponseStatusEnum;
|
|
89
93
|
(function (AddEventPassTypeExchangeTarget200ResponseStatusEnum) {
|
|
90
94
|
AddEventPassTypeExchangeTarget200ResponseStatusEnum["Ok"] = "ok";
|
|
@@ -474,10 +478,6 @@ export var CreateOrganizationTeamMember200ResponseStatusEnum;
|
|
|
474
478
|
(function (CreateOrganizationTeamMember200ResponseStatusEnum) {
|
|
475
479
|
CreateOrganizationTeamMember200ResponseStatusEnum["Ok"] = "ok";
|
|
476
480
|
})(CreateOrganizationTeamMember200ResponseStatusEnum || (CreateOrganizationTeamMember200ResponseStatusEnum = {}));
|
|
477
|
-
export var CreateOrganizationWebhook200ResponseStatusEnum;
|
|
478
|
-
(function (CreateOrganizationWebhook200ResponseStatusEnum) {
|
|
479
|
-
CreateOrganizationWebhook200ResponseStatusEnum["Ok"] = "ok";
|
|
480
|
-
})(CreateOrganizationWebhook200ResponseStatusEnum || (CreateOrganizationWebhook200ResponseStatusEnum = {}));
|
|
481
481
|
export var CreatePreset200ResponseStatusEnum;
|
|
482
482
|
(function (CreatePreset200ResponseStatusEnum) {
|
|
483
483
|
CreatePreset200ResponseStatusEnum["Ok"] = "ok";
|
|
@@ -1182,6 +1182,10 @@ export var GetEventPassAttributes200ResponseStatusEnum;
|
|
|
1182
1182
|
(function (GetEventPassAttributes200ResponseStatusEnum) {
|
|
1183
1183
|
GetEventPassAttributes200ResponseStatusEnum["Ok"] = "ok";
|
|
1184
1184
|
})(GetEventPassAttributes200ResponseStatusEnum || (GetEventPassAttributes200ResponseStatusEnum = {}));
|
|
1185
|
+
export var GetEventPassChangeWebhooks200ResponseStatusEnum;
|
|
1186
|
+
(function (GetEventPassChangeWebhooks200ResponseStatusEnum) {
|
|
1187
|
+
GetEventPassChangeWebhooks200ResponseStatusEnum["Ok"] = "ok";
|
|
1188
|
+
})(GetEventPassChangeWebhooks200ResponseStatusEnum || (GetEventPassChangeWebhooks200ResponseStatusEnum = {}));
|
|
1185
1189
|
export var GetEventPassMatches200ResponseStatusEnum;
|
|
1186
1190
|
(function (GetEventPassMatches200ResponseStatusEnum) {
|
|
1187
1191
|
GetEventPassMatches200ResponseStatusEnum["Ok"] = "ok";
|
|
@@ -1714,10 +1718,6 @@ export var GetOrganizationUsers200ResponseStatusEnum;
|
|
|
1714
1718
|
(function (GetOrganizationUsers200ResponseStatusEnum) {
|
|
1715
1719
|
GetOrganizationUsers200ResponseStatusEnum["Ok"] = "ok";
|
|
1716
1720
|
})(GetOrganizationUsers200ResponseStatusEnum || (GetOrganizationUsers200ResponseStatusEnum = {}));
|
|
1717
|
-
export var GetOrganizationWebhooks200ResponseStatusEnum;
|
|
1718
|
-
(function (GetOrganizationWebhooks200ResponseStatusEnum) {
|
|
1719
|
-
GetOrganizationWebhooks200ResponseStatusEnum["Ok"] = "ok";
|
|
1720
|
-
})(GetOrganizationWebhooks200ResponseStatusEnum || (GetOrganizationWebhooks200ResponseStatusEnum = {}));
|
|
1721
1721
|
export var GetPayment200ResponseStatusEnum;
|
|
1722
1722
|
(function (GetPayment200ResponseStatusEnum) {
|
|
1723
1723
|
GetPayment200ResponseStatusEnum["Ok"] = "ok";
|
|
@@ -39509,6 +39509,274 @@ export class EventsPagesTranslationsApi extends BaseAPI {
|
|
|
39509
39509
|
return EventsPagesTranslationsApiFp(this.configuration).updateEventPageTranslation(requestParameters.eventId, requestParameters.pageId, requestParameters.locale, requestParameters.eventPageTranslationUpdateInputs, options).then((request) => request(this.axios, this.basePath));
|
|
39510
39510
|
}
|
|
39511
39511
|
}
|
|
39512
|
+
/**
|
|
39513
|
+
* EventsPasschangewebhooksApi - axios parameter creator
|
|
39514
|
+
*/
|
|
39515
|
+
export const EventsPasschangewebhooksApiAxiosParamCreator = function (configuration) {
|
|
39516
|
+
return {
|
|
39517
|
+
/**
|
|
39518
|
+
* 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.
|
|
39519
|
+
* @summary Connect a webhook to an event\'s pass change log
|
|
39520
|
+
* @param {string} eventId The event identifier
|
|
39521
|
+
* @param {string} webhookId The webhook identifier
|
|
39522
|
+
* @param {*} [options] Override http request option.
|
|
39523
|
+
* @throws {RequiredError}
|
|
39524
|
+
*/
|
|
39525
|
+
addEventPassChangeWebhook: (eventId_1, webhookId_1, ...args_1) => __awaiter(this, [eventId_1, webhookId_1, ...args_1], void 0, function* (eventId, webhookId, options = {}) {
|
|
39526
|
+
// verify required parameter 'eventId' is not null or undefined
|
|
39527
|
+
assertParamExists('addEventPassChangeWebhook', 'eventId', eventId);
|
|
39528
|
+
// verify required parameter 'webhookId' is not null or undefined
|
|
39529
|
+
assertParamExists('addEventPassChangeWebhook', 'webhookId', webhookId);
|
|
39530
|
+
const localVarPath = `/events/{eventId}/passChangeWebhooks/{webhookId}`
|
|
39531
|
+
.replace(`{${"eventId"}}`, encodeURIComponent(String(eventId)))
|
|
39532
|
+
.replace(`{${"webhookId"}}`, encodeURIComponent(String(webhookId)));
|
|
39533
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
39534
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
39535
|
+
let baseOptions;
|
|
39536
|
+
if (configuration) {
|
|
39537
|
+
baseOptions = configuration.baseOptions;
|
|
39538
|
+
}
|
|
39539
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
39540
|
+
const localVarHeaderParameter = {};
|
|
39541
|
+
const localVarQueryParameter = {};
|
|
39542
|
+
// authentication ApiKeyAuth required
|
|
39543
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
39544
|
+
// authentication OrganizationId required
|
|
39545
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
39546
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
39547
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
39548
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
39549
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
39550
|
+
return {
|
|
39551
|
+
url: toPathString(localVarUrlObj),
|
|
39552
|
+
options: localVarRequestOptions,
|
|
39553
|
+
};
|
|
39554
|
+
}),
|
|
39555
|
+
/**
|
|
39556
|
+
* Returns a paginated list of the webhooks connected to the given event\'s pass change log; requires \"read\" permission on events.
|
|
39557
|
+
* @summary List an event\'s pass change log webhooks
|
|
39558
|
+
* @param {string} eventId The event identifier
|
|
39559
|
+
* @param {number} [page] Page number
|
|
39560
|
+
* @param {number} [pageSize] Number of items per page
|
|
39561
|
+
* @param {string} [orderBy] Field to order by
|
|
39562
|
+
* @param {string} [search] Search query
|
|
39563
|
+
* @param {*} [options] Override http request option.
|
|
39564
|
+
* @throws {RequiredError}
|
|
39565
|
+
*/
|
|
39566
|
+
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 = {}) {
|
|
39567
|
+
// verify required parameter 'eventId' is not null or undefined
|
|
39568
|
+
assertParamExists('getEventPassChangeWebhooks', 'eventId', eventId);
|
|
39569
|
+
const localVarPath = `/events/{eventId}/passChangeWebhooks`
|
|
39570
|
+
.replace(`{${"eventId"}}`, encodeURIComponent(String(eventId)));
|
|
39571
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
39572
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
39573
|
+
let baseOptions;
|
|
39574
|
+
if (configuration) {
|
|
39575
|
+
baseOptions = configuration.baseOptions;
|
|
39576
|
+
}
|
|
39577
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
39578
|
+
const localVarHeaderParameter = {};
|
|
39579
|
+
const localVarQueryParameter = {};
|
|
39580
|
+
// authentication ApiKeyAuth required
|
|
39581
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
39582
|
+
// authentication OrganizationId required
|
|
39583
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
39584
|
+
if (page !== undefined) {
|
|
39585
|
+
localVarQueryParameter['page'] = page;
|
|
39586
|
+
}
|
|
39587
|
+
if (pageSize !== undefined) {
|
|
39588
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
39589
|
+
}
|
|
39590
|
+
if (orderBy !== undefined) {
|
|
39591
|
+
localVarQueryParameter['orderBy'] = orderBy;
|
|
39592
|
+
}
|
|
39593
|
+
if (search !== undefined) {
|
|
39594
|
+
localVarQueryParameter['search'] = search;
|
|
39595
|
+
}
|
|
39596
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
39597
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
39598
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
39599
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
39600
|
+
return {
|
|
39601
|
+
url: toPathString(localVarUrlObj),
|
|
39602
|
+
options: localVarRequestOptions,
|
|
39603
|
+
};
|
|
39604
|
+
}),
|
|
39605
|
+
/**
|
|
39606
|
+
* Disconnects the specified webhook from the given event\'s pass change log and requires update permission on events.
|
|
39607
|
+
* @summary Disconnect a webhook from an event\'s pass change log
|
|
39608
|
+
* @param {string} eventId The event identifier
|
|
39609
|
+
* @param {string} webhookId The webhook identifier
|
|
39610
|
+
* @param {*} [options] Override http request option.
|
|
39611
|
+
* @throws {RequiredError}
|
|
39612
|
+
*/
|
|
39613
|
+
removeEventPassChangeWebhook: (eventId_1, webhookId_1, ...args_1) => __awaiter(this, [eventId_1, webhookId_1, ...args_1], void 0, function* (eventId, webhookId, options = {}) {
|
|
39614
|
+
// verify required parameter 'eventId' is not null or undefined
|
|
39615
|
+
assertParamExists('removeEventPassChangeWebhook', 'eventId', eventId);
|
|
39616
|
+
// verify required parameter 'webhookId' is not null or undefined
|
|
39617
|
+
assertParamExists('removeEventPassChangeWebhook', 'webhookId', webhookId);
|
|
39618
|
+
const localVarPath = `/events/{eventId}/passChangeWebhooks/{webhookId}`
|
|
39619
|
+
.replace(`{${"eventId"}}`, encodeURIComponent(String(eventId)))
|
|
39620
|
+
.replace(`{${"webhookId"}}`, encodeURIComponent(String(webhookId)));
|
|
39621
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
39622
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
39623
|
+
let baseOptions;
|
|
39624
|
+
if (configuration) {
|
|
39625
|
+
baseOptions = configuration.baseOptions;
|
|
39626
|
+
}
|
|
39627
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
|
|
39628
|
+
const localVarHeaderParameter = {};
|
|
39629
|
+
const localVarQueryParameter = {};
|
|
39630
|
+
// authentication ApiKeyAuth required
|
|
39631
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
39632
|
+
// authentication OrganizationId required
|
|
39633
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
39634
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
39635
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
39636
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
39637
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
39638
|
+
return {
|
|
39639
|
+
url: toPathString(localVarUrlObj),
|
|
39640
|
+
options: localVarRequestOptions,
|
|
39641
|
+
};
|
|
39642
|
+
}),
|
|
39643
|
+
};
|
|
39644
|
+
};
|
|
39645
|
+
/**
|
|
39646
|
+
* EventsPasschangewebhooksApi - functional programming interface
|
|
39647
|
+
*/
|
|
39648
|
+
export const EventsPasschangewebhooksApiFp = function (configuration) {
|
|
39649
|
+
const localVarAxiosParamCreator = EventsPasschangewebhooksApiAxiosParamCreator(configuration);
|
|
39650
|
+
return {
|
|
39651
|
+
/**
|
|
39652
|
+
* 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.
|
|
39653
|
+
* @summary Connect a webhook to an event\'s pass change log
|
|
39654
|
+
* @param {string} eventId The event identifier
|
|
39655
|
+
* @param {string} webhookId The webhook identifier
|
|
39656
|
+
* @param {*} [options] Override http request option.
|
|
39657
|
+
* @throws {RequiredError}
|
|
39658
|
+
*/
|
|
39659
|
+
addEventPassChangeWebhook(eventId, webhookId, options) {
|
|
39660
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
39661
|
+
var _a, _b, _c;
|
|
39662
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.addEventPassChangeWebhook(eventId, webhookId, options);
|
|
39663
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
39664
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['EventsPasschangewebhooksApi.addEventPassChangeWebhook']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
39665
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
39666
|
+
});
|
|
39667
|
+
},
|
|
39668
|
+
/**
|
|
39669
|
+
* Returns a paginated list of the webhooks connected to the given event\'s pass change log; requires \"read\" permission on events.
|
|
39670
|
+
* @summary List an event\'s pass change log webhooks
|
|
39671
|
+
* @param {string} eventId The event identifier
|
|
39672
|
+
* @param {number} [page] Page number
|
|
39673
|
+
* @param {number} [pageSize] Number of items per page
|
|
39674
|
+
* @param {string} [orderBy] Field to order by
|
|
39675
|
+
* @param {string} [search] Search query
|
|
39676
|
+
* @param {*} [options] Override http request option.
|
|
39677
|
+
* @throws {RequiredError}
|
|
39678
|
+
*/
|
|
39679
|
+
getEventPassChangeWebhooks(eventId, page, pageSize, orderBy, search, options) {
|
|
39680
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
39681
|
+
var _a, _b, _c;
|
|
39682
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getEventPassChangeWebhooks(eventId, page, pageSize, orderBy, search, options);
|
|
39683
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
39684
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['EventsPasschangewebhooksApi.getEventPassChangeWebhooks']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
39685
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
39686
|
+
});
|
|
39687
|
+
},
|
|
39688
|
+
/**
|
|
39689
|
+
* Disconnects the specified webhook from the given event\'s pass change log and requires update permission on events.
|
|
39690
|
+
* @summary Disconnect a webhook from an event\'s pass change log
|
|
39691
|
+
* @param {string} eventId The event identifier
|
|
39692
|
+
* @param {string} webhookId The webhook identifier
|
|
39693
|
+
* @param {*} [options] Override http request option.
|
|
39694
|
+
* @throws {RequiredError}
|
|
39695
|
+
*/
|
|
39696
|
+
removeEventPassChangeWebhook(eventId, webhookId, options) {
|
|
39697
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
39698
|
+
var _a, _b, _c;
|
|
39699
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.removeEventPassChangeWebhook(eventId, webhookId, options);
|
|
39700
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
39701
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['EventsPasschangewebhooksApi.removeEventPassChangeWebhook']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
39702
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
39703
|
+
});
|
|
39704
|
+
},
|
|
39705
|
+
};
|
|
39706
|
+
};
|
|
39707
|
+
/**
|
|
39708
|
+
* EventsPasschangewebhooksApi - factory interface
|
|
39709
|
+
*/
|
|
39710
|
+
export const EventsPasschangewebhooksApiFactory = function (configuration, basePath, axios) {
|
|
39711
|
+
const localVarFp = EventsPasschangewebhooksApiFp(configuration);
|
|
39712
|
+
return {
|
|
39713
|
+
/**
|
|
39714
|
+
* 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.
|
|
39715
|
+
* @summary Connect a webhook to an event\'s pass change log
|
|
39716
|
+
* @param {EventsPasschangewebhooksApiAddEventPassChangeWebhookRequest} requestParameters Request parameters.
|
|
39717
|
+
* @param {*} [options] Override http request option.
|
|
39718
|
+
* @throws {RequiredError}
|
|
39719
|
+
*/
|
|
39720
|
+
addEventPassChangeWebhook(requestParameters, options) {
|
|
39721
|
+
return localVarFp.addEventPassChangeWebhook(requestParameters.eventId, requestParameters.webhookId, options).then((request) => request(axios, basePath));
|
|
39722
|
+
},
|
|
39723
|
+
/**
|
|
39724
|
+
* Returns a paginated list of the webhooks connected to the given event\'s pass change log; requires \"read\" permission on events.
|
|
39725
|
+
* @summary List an event\'s pass change log webhooks
|
|
39726
|
+
* @param {EventsPasschangewebhooksApiGetEventPassChangeWebhooksRequest} requestParameters Request parameters.
|
|
39727
|
+
* @param {*} [options] Override http request option.
|
|
39728
|
+
* @throws {RequiredError}
|
|
39729
|
+
*/
|
|
39730
|
+
getEventPassChangeWebhooks(requestParameters, options) {
|
|
39731
|
+
return localVarFp.getEventPassChangeWebhooks(requestParameters.eventId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
39732
|
+
},
|
|
39733
|
+
/**
|
|
39734
|
+
* Disconnects the specified webhook from the given event\'s pass change log and requires update permission on events.
|
|
39735
|
+
* @summary Disconnect a webhook from an event\'s pass change log
|
|
39736
|
+
* @param {EventsPasschangewebhooksApiRemoveEventPassChangeWebhookRequest} requestParameters Request parameters.
|
|
39737
|
+
* @param {*} [options] Override http request option.
|
|
39738
|
+
* @throws {RequiredError}
|
|
39739
|
+
*/
|
|
39740
|
+
removeEventPassChangeWebhook(requestParameters, options) {
|
|
39741
|
+
return localVarFp.removeEventPassChangeWebhook(requestParameters.eventId, requestParameters.webhookId, options).then((request) => request(axios, basePath));
|
|
39742
|
+
},
|
|
39743
|
+
};
|
|
39744
|
+
};
|
|
39745
|
+
/**
|
|
39746
|
+
* EventsPasschangewebhooksApi - object-oriented interface
|
|
39747
|
+
*/
|
|
39748
|
+
export class EventsPasschangewebhooksApi extends BaseAPI {
|
|
39749
|
+
/**
|
|
39750
|
+
* 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.
|
|
39751
|
+
* @summary Connect a webhook to an event\'s pass change log
|
|
39752
|
+
* @param {EventsPasschangewebhooksApiAddEventPassChangeWebhookRequest} requestParameters Request parameters.
|
|
39753
|
+
* @param {*} [options] Override http request option.
|
|
39754
|
+
* @throws {RequiredError}
|
|
39755
|
+
*/
|
|
39756
|
+
addEventPassChangeWebhook(requestParameters, options) {
|
|
39757
|
+
return EventsPasschangewebhooksApiFp(this.configuration).addEventPassChangeWebhook(requestParameters.eventId, requestParameters.webhookId, options).then((request) => request(this.axios, this.basePath));
|
|
39758
|
+
}
|
|
39759
|
+
/**
|
|
39760
|
+
* Returns a paginated list of the webhooks connected to the given event\'s pass change log; requires \"read\" permission on events.
|
|
39761
|
+
* @summary List an event\'s pass change log webhooks
|
|
39762
|
+
* @param {EventsPasschangewebhooksApiGetEventPassChangeWebhooksRequest} requestParameters Request parameters.
|
|
39763
|
+
* @param {*} [options] Override http request option.
|
|
39764
|
+
* @throws {RequiredError}
|
|
39765
|
+
*/
|
|
39766
|
+
getEventPassChangeWebhooks(requestParameters, options) {
|
|
39767
|
+
return EventsPasschangewebhooksApiFp(this.configuration).getEventPassChangeWebhooks(requestParameters.eventId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
39768
|
+
}
|
|
39769
|
+
/**
|
|
39770
|
+
* Disconnects the specified webhook from the given event\'s pass change log and requires update permission on events.
|
|
39771
|
+
* @summary Disconnect a webhook from an event\'s pass change log
|
|
39772
|
+
* @param {EventsPasschangewebhooksApiRemoveEventPassChangeWebhookRequest} requestParameters Request parameters.
|
|
39773
|
+
* @param {*} [options] Override http request option.
|
|
39774
|
+
* @throws {RequiredError}
|
|
39775
|
+
*/
|
|
39776
|
+
removeEventPassChangeWebhook(requestParameters, options) {
|
|
39777
|
+
return EventsPasschangewebhooksApiFp(this.configuration).removeEventPassChangeWebhook(requestParameters.eventId, requestParameters.webhookId, options).then((request) => request(this.axios, this.basePath));
|
|
39778
|
+
}
|
|
39779
|
+
}
|
|
39512
39780
|
/**
|
|
39513
39781
|
* EventsPassesApi - axios parameter creator
|
|
39514
39782
|
*/
|
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.0
|
|
5
|
+
* The version of the OpenAPI document: 11.1.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.0
|
|
7
|
+
* The version of the OpenAPI document: 11.1.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.0
|
|
5
|
+
* The version of the OpenAPI document: 11.1.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.0
|
|
7
|
+
* The version of the OpenAPI document: 11.1.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.0
|
|
5
|
+
* The version of the OpenAPI document: 11.1.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.0
|
|
6
|
+
* The version of the OpenAPI document: 11.1.0
|
|
7
7
|
*
|
|
8
8
|
*
|
|
9
9
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/docs/{CreateOrganizationWebhook200Response.md → AddEventPassChangeWebhook200Response.md}
RENAMED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# AddEventPassChangeWebhook200Response
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
@@ -12,9 +12,9 @@ Name | Type | Description | Notes
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
14
14
|
```typescript
|
|
15
|
-
import {
|
|
15
|
+
import { AddEventPassChangeWebhook200Response } from '@connectedxm/admin-sdk';
|
|
16
16
|
|
|
17
|
-
const instance:
|
|
17
|
+
const instance: AddEventPassChangeWebhook200Response = {
|
|
18
18
|
status,
|
|
19
19
|
message,
|
|
20
20
|
data,
|
|
@@ -0,0 +1,181 @@
|
|
|
1
|
+
# EventsPasschangewebhooksApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://admin-api.connected.dev*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**addEventPassChangeWebhook**](#addeventpasschangewebhook) | **POST** /events/{eventId}/passChangeWebhooks/{webhookId} | Connect a webhook to an event\'s pass change log|
|
|
8
|
+
|[**getEventPassChangeWebhooks**](#geteventpasschangewebhooks) | **GET** /events/{eventId}/passChangeWebhooks | List an event\'s pass change log webhooks|
|
|
9
|
+
|[**removeEventPassChangeWebhook**](#removeeventpasschangewebhook) | **DELETE** /events/{eventId}/passChangeWebhooks/{webhookId} | Disconnect a webhook from an event\'s pass change log|
|
|
10
|
+
|
|
11
|
+
# **addEventPassChangeWebhook**
|
|
12
|
+
> AddEventPassChangeWebhook200Response addEventPassChangeWebhook()
|
|
13
|
+
|
|
14
|
+
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.
|
|
15
|
+
|
|
16
|
+
### Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import {
|
|
20
|
+
EventsPasschangewebhooksApi,
|
|
21
|
+
Configuration
|
|
22
|
+
} from '@connectedxm/admin-sdk';
|
|
23
|
+
|
|
24
|
+
const configuration = new Configuration();
|
|
25
|
+
const apiInstance = new EventsPasschangewebhooksApi(configuration);
|
|
26
|
+
|
|
27
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
28
|
+
let webhookId: string; //The webhook identifier (default to undefined)
|
|
29
|
+
|
|
30
|
+
const { status, data } = await apiInstance.addEventPassChangeWebhook(
|
|
31
|
+
eventId,
|
|
32
|
+
webhookId
|
|
33
|
+
);
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
### Parameters
|
|
37
|
+
|
|
38
|
+
|Name | Type | Description | Notes|
|
|
39
|
+
|------------- | ------------- | ------------- | -------------|
|
|
40
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
41
|
+
| **webhookId** | [**string**] | The webhook identifier | defaults to undefined|
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
### Return type
|
|
45
|
+
|
|
46
|
+
**AddEventPassChangeWebhook200Response**
|
|
47
|
+
|
|
48
|
+
### Authorization
|
|
49
|
+
|
|
50
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
51
|
+
|
|
52
|
+
### HTTP request headers
|
|
53
|
+
|
|
54
|
+
- **Content-Type**: Not defined
|
|
55
|
+
- **Accept**: application/json
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
### HTTP response details
|
|
59
|
+
| Status code | Description | Response headers |
|
|
60
|
+
|-------------|-------------|------------------|
|
|
61
|
+
|**200** | Successful response | - |
|
|
62
|
+
|
|
63
|
+
[[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)
|
|
64
|
+
|
|
65
|
+
# **getEventPassChangeWebhooks**
|
|
66
|
+
> GetEventPassChangeWebhooks200Response getEventPassChangeWebhooks()
|
|
67
|
+
|
|
68
|
+
Returns a paginated list of the webhooks connected to the given event\'s pass change log; requires \"read\" permission on events.
|
|
69
|
+
|
|
70
|
+
### Example
|
|
71
|
+
|
|
72
|
+
```typescript
|
|
73
|
+
import {
|
|
74
|
+
EventsPasschangewebhooksApi,
|
|
75
|
+
Configuration
|
|
76
|
+
} from '@connectedxm/admin-sdk';
|
|
77
|
+
|
|
78
|
+
const configuration = new Configuration();
|
|
79
|
+
const apiInstance = new EventsPasschangewebhooksApi(configuration);
|
|
80
|
+
|
|
81
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
82
|
+
let page: number; //Page number (optional) (default to 1)
|
|
83
|
+
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
84
|
+
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
85
|
+
let search: string; //Search query (optional) (default to undefined)
|
|
86
|
+
|
|
87
|
+
const { status, data } = await apiInstance.getEventPassChangeWebhooks(
|
|
88
|
+
eventId,
|
|
89
|
+
page,
|
|
90
|
+
pageSize,
|
|
91
|
+
orderBy,
|
|
92
|
+
search
|
|
93
|
+
);
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
### Parameters
|
|
97
|
+
|
|
98
|
+
|Name | Type | Description | Notes|
|
|
99
|
+
|------------- | ------------- | ------------- | -------------|
|
|
100
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
101
|
+
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
102
|
+
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
103
|
+
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
104
|
+
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
### Return type
|
|
108
|
+
|
|
109
|
+
**GetEventPassChangeWebhooks200Response**
|
|
110
|
+
|
|
111
|
+
### Authorization
|
|
112
|
+
|
|
113
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
114
|
+
|
|
115
|
+
### HTTP request headers
|
|
116
|
+
|
|
117
|
+
- **Content-Type**: Not defined
|
|
118
|
+
- **Accept**: application/json
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
### HTTP response details
|
|
122
|
+
| Status code | Description | Response headers |
|
|
123
|
+
|-------------|-------------|------------------|
|
|
124
|
+
|**200** | Successful response | - |
|
|
125
|
+
|
|
126
|
+
[[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)
|
|
127
|
+
|
|
128
|
+
# **removeEventPassChangeWebhook**
|
|
129
|
+
> CreateAccountInvitations200Response removeEventPassChangeWebhook()
|
|
130
|
+
|
|
131
|
+
Disconnects the specified webhook from the given event\'s pass change log and requires update permission on events.
|
|
132
|
+
|
|
133
|
+
### Example
|
|
134
|
+
|
|
135
|
+
```typescript
|
|
136
|
+
import {
|
|
137
|
+
EventsPasschangewebhooksApi,
|
|
138
|
+
Configuration
|
|
139
|
+
} from '@connectedxm/admin-sdk';
|
|
140
|
+
|
|
141
|
+
const configuration = new Configuration();
|
|
142
|
+
const apiInstance = new EventsPasschangewebhooksApi(configuration);
|
|
143
|
+
|
|
144
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
145
|
+
let webhookId: string; //The webhook identifier (default to undefined)
|
|
146
|
+
|
|
147
|
+
const { status, data } = await apiInstance.removeEventPassChangeWebhook(
|
|
148
|
+
eventId,
|
|
149
|
+
webhookId
|
|
150
|
+
);
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
### Parameters
|
|
154
|
+
|
|
155
|
+
|Name | Type | Description | Notes|
|
|
156
|
+
|------------- | ------------- | ------------- | -------------|
|
|
157
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
158
|
+
| **webhookId** | [**string**] | The webhook identifier | defaults to undefined|
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
### Return type
|
|
162
|
+
|
|
163
|
+
**CreateAccountInvitations200Response**
|
|
164
|
+
|
|
165
|
+
### Authorization
|
|
166
|
+
|
|
167
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
168
|
+
|
|
169
|
+
### HTTP request headers
|
|
170
|
+
|
|
171
|
+
- **Content-Type**: Not defined
|
|
172
|
+
- **Accept**: application/json
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
### HTTP response details
|
|
176
|
+
| Status code | Description | Response headers |
|
|
177
|
+
|-------------|-------------|------------------|
|
|
178
|
+
|**200** | Successful response | - |
|
|
179
|
+
|
|
180
|
+
[[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)
|
|
181
|
+
|
package/docs/{GetOrganizationWebhooks200Response.md → GetEventPassChangeWebhooks200Response.md}
RENAMED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# GetEventPassChangeWebhooks200Response
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
@@ -13,9 +13,9 @@ Name | Type | Description | Notes
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
15
15
|
```typescript
|
|
16
|
-
import {
|
|
16
|
+
import { GetEventPassChangeWebhooks200Response } from '@connectedxm/admin-sdk';
|
|
17
17
|
|
|
18
|
-
const instance:
|
|
18
|
+
const instance: GetEventPassChangeWebhooks200Response = {
|
|
19
19
|
status,
|
|
20
20
|
message,
|
|
21
21
|
data,
|