@connectedxm/admin-sdk 10.6.0 → 10.7.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 +8 -0
- package/README.md +2 -2
- package/api.ts +581 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +358 -1
- package/dist/api.js +360 -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/api.d.ts +358 -1
- package/dist/esm/api.js +335 -1
- 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/AccountsApi.md +64 -0
- package/docs/BasePaymentIntent.md +96 -0
- package/docs/BasePaymentIntentIntegration.md +22 -0
- package/docs/BasePaymentIntentLineItem.md +62 -0
- package/docs/BasePaymentIntentTaxIntegration.md +22 -0
- package/docs/GetAccountPaymentIntents200Response.md +26 -0
- package/docs/GetPaymentIntent200Response.md +24 -0
- package/docs/OrganizationPaymentsApi.md +165 -0
- package/docs/PaymentIntent.md +116 -0
- package/docs/PaymentIntentSource.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: 10.
|
|
7
|
+
* The version of the OpenAPI document: 10.7.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -735,6 +735,10 @@ export var GetAccountNotificationPreferences200ResponseStatusEnum;
|
|
|
735
735
|
(function (GetAccountNotificationPreferences200ResponseStatusEnum) {
|
|
736
736
|
GetAccountNotificationPreferences200ResponseStatusEnum["Ok"] = "ok";
|
|
737
737
|
})(GetAccountNotificationPreferences200ResponseStatusEnum || (GetAccountNotificationPreferences200ResponseStatusEnum = {}));
|
|
738
|
+
export var GetAccountPaymentIntents200ResponseStatusEnum;
|
|
739
|
+
(function (GetAccountPaymentIntents200ResponseStatusEnum) {
|
|
740
|
+
GetAccountPaymentIntents200ResponseStatusEnum["Ok"] = "ok";
|
|
741
|
+
})(GetAccountPaymentIntents200ResponseStatusEnum || (GetAccountPaymentIntents200ResponseStatusEnum = {}));
|
|
738
742
|
export var GetAccountPayments200ResponseStatusEnum;
|
|
739
743
|
(function (GetAccountPayments200ResponseStatusEnum) {
|
|
740
744
|
GetAccountPayments200ResponseStatusEnum["Ok"] = "ok";
|
|
@@ -1683,6 +1687,10 @@ export var GetPayment200ResponseStatusEnum;
|
|
|
1683
1687
|
(function (GetPayment200ResponseStatusEnum) {
|
|
1684
1688
|
GetPayment200ResponseStatusEnum["Ok"] = "ok";
|
|
1685
1689
|
})(GetPayment200ResponseStatusEnum || (GetPayment200ResponseStatusEnum = {}));
|
|
1690
|
+
export var GetPaymentIntent200ResponseStatusEnum;
|
|
1691
|
+
(function (GetPaymentIntent200ResponseStatusEnum) {
|
|
1692
|
+
GetPaymentIntent200ResponseStatusEnum["Ok"] = "ok";
|
|
1693
|
+
})(GetPaymentIntent200ResponseStatusEnum || (GetPaymentIntent200ResponseStatusEnum = {}));
|
|
1686
1694
|
export var GetPaymentTaxMetadata200ResponseStatusEnum;
|
|
1687
1695
|
(function (GetPaymentTaxMetadata200ResponseStatusEnum) {
|
|
1688
1696
|
GetPaymentTaxMetadata200ResponseStatusEnum["Ok"] = "ok";
|
|
@@ -2224,6 +2232,17 @@ export var PaymentIntegrationType;
|
|
|
2224
2232
|
PaymentIntegrationType["Authorizenet"] = "authorizenet";
|
|
2225
2233
|
PaymentIntegrationType["Manual"] = "manual";
|
|
2226
2234
|
})(PaymentIntegrationType || (PaymentIntegrationType = {}));
|
|
2235
|
+
export var PaymentIntentSource;
|
|
2236
|
+
(function (PaymentIntentSource) {
|
|
2237
|
+
PaymentIntentSource["Registration"] = "registration";
|
|
2238
|
+
PaymentIntentSource["Invoice"] = "invoice";
|
|
2239
|
+
PaymentIntentSource["Pass"] = "pass";
|
|
2240
|
+
PaymentIntentSource["Coupon"] = "coupon";
|
|
2241
|
+
PaymentIntentSource["Session"] = "session";
|
|
2242
|
+
PaymentIntentSource["Booking"] = "booking";
|
|
2243
|
+
PaymentIntentSource["Series"] = "series";
|
|
2244
|
+
PaymentIntentSource["Exchange"] = "exchange";
|
|
2245
|
+
})(PaymentIntentSource || (PaymentIntentSource = {}));
|
|
2227
2246
|
export var PaymentLineItemType;
|
|
2228
2247
|
(function (PaymentLineItemType) {
|
|
2229
2248
|
PaymentLineItemType["General"] = "general";
|
|
@@ -3247,6 +3266,56 @@ export const AccountsApiAxiosParamCreator = function (configuration) {
|
|
|
3247
3266
|
options: localVarRequestOptions,
|
|
3248
3267
|
};
|
|
3249
3268
|
}),
|
|
3269
|
+
/**
|
|
3270
|
+
* Returns a paginated list of unpaid checkout payment intents for the given account; requires the `read accounts` and `read payments` permissions.
|
|
3271
|
+
* @summary List an account\'s payment intents
|
|
3272
|
+
* @param {string} accountId The account identifier
|
|
3273
|
+
* @param {number} [page] Page number
|
|
3274
|
+
* @param {number} [pageSize] Number of items per page
|
|
3275
|
+
* @param {string} [orderBy] Field to order by
|
|
3276
|
+
* @param {string} [search] Search query
|
|
3277
|
+
* @param {*} [options] Override http request option.
|
|
3278
|
+
* @throws {RequiredError}
|
|
3279
|
+
*/
|
|
3280
|
+
getAccountPaymentIntents: (accountId_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1) => __awaiter(this, [accountId_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1], void 0, function* (accountId, page, pageSize, orderBy, search, options = {}) {
|
|
3281
|
+
// verify required parameter 'accountId' is not null or undefined
|
|
3282
|
+
assertParamExists('getAccountPaymentIntents', 'accountId', accountId);
|
|
3283
|
+
const localVarPath = `/accounts/{accountId}/payment-intents`
|
|
3284
|
+
.replace(`{${"accountId"}}`, encodeURIComponent(String(accountId)));
|
|
3285
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3286
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3287
|
+
let baseOptions;
|
|
3288
|
+
if (configuration) {
|
|
3289
|
+
baseOptions = configuration.baseOptions;
|
|
3290
|
+
}
|
|
3291
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
3292
|
+
const localVarHeaderParameter = {};
|
|
3293
|
+
const localVarQueryParameter = {};
|
|
3294
|
+
// authentication ApiKeyAuth required
|
|
3295
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
3296
|
+
// authentication OrganizationId required
|
|
3297
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
3298
|
+
if (page !== undefined) {
|
|
3299
|
+
localVarQueryParameter['page'] = page;
|
|
3300
|
+
}
|
|
3301
|
+
if (pageSize !== undefined) {
|
|
3302
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
3303
|
+
}
|
|
3304
|
+
if (orderBy !== undefined) {
|
|
3305
|
+
localVarQueryParameter['orderBy'] = orderBy;
|
|
3306
|
+
}
|
|
3307
|
+
if (search !== undefined) {
|
|
3308
|
+
localVarQueryParameter['search'] = search;
|
|
3309
|
+
}
|
|
3310
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
3311
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3312
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3313
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
3314
|
+
return {
|
|
3315
|
+
url: toPathString(localVarUrlObj),
|
|
3316
|
+
options: localVarRequestOptions,
|
|
3317
|
+
};
|
|
3318
|
+
}),
|
|
3250
3319
|
/**
|
|
3251
3320
|
* Returns a paginated list of payments made by the given account, searchable by payment ID, account email, or account name; requires the `read accounts` and `read payments` permissions.
|
|
3252
3321
|
* @summary List an account\'s payments
|
|
@@ -3849,6 +3918,26 @@ export const AccountsApiFp = function (configuration) {
|
|
|
3849
3918
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3850
3919
|
});
|
|
3851
3920
|
},
|
|
3921
|
+
/**
|
|
3922
|
+
* Returns a paginated list of unpaid checkout payment intents for the given account; requires the `read accounts` and `read payments` permissions.
|
|
3923
|
+
* @summary List an account\'s payment intents
|
|
3924
|
+
* @param {string} accountId The account identifier
|
|
3925
|
+
* @param {number} [page] Page number
|
|
3926
|
+
* @param {number} [pageSize] Number of items per page
|
|
3927
|
+
* @param {string} [orderBy] Field to order by
|
|
3928
|
+
* @param {string} [search] Search query
|
|
3929
|
+
* @param {*} [options] Override http request option.
|
|
3930
|
+
* @throws {RequiredError}
|
|
3931
|
+
*/
|
|
3932
|
+
getAccountPaymentIntents(accountId, page, pageSize, orderBy, search, options) {
|
|
3933
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
3934
|
+
var _a, _b, _c;
|
|
3935
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getAccountPaymentIntents(accountId, page, pageSize, orderBy, search, options);
|
|
3936
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
3937
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AccountsApi.getAccountPaymentIntents']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
3938
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3939
|
+
});
|
|
3940
|
+
},
|
|
3852
3941
|
/**
|
|
3853
3942
|
* Returns a paginated list of payments made by the given account, searchable by payment ID, account email, or account name; requires the `read accounts` and `read payments` permissions.
|
|
3854
3943
|
* @summary List an account\'s payments
|
|
@@ -4132,6 +4221,16 @@ export const AccountsApiFactory = function (configuration, basePath, axios) {
|
|
|
4132
4221
|
getAccountNotificationPreferences(requestParameters, options) {
|
|
4133
4222
|
return localVarFp.getAccountNotificationPreferences(requestParameters.accountId, options).then((request) => request(axios, basePath));
|
|
4134
4223
|
},
|
|
4224
|
+
/**
|
|
4225
|
+
* Returns a paginated list of unpaid checkout payment intents for the given account; requires the `read accounts` and `read payments` permissions.
|
|
4226
|
+
* @summary List an account\'s payment intents
|
|
4227
|
+
* @param {AccountsApiGetAccountPaymentIntentsRequest} requestParameters Request parameters.
|
|
4228
|
+
* @param {*} [options] Override http request option.
|
|
4229
|
+
* @throws {RequiredError}
|
|
4230
|
+
*/
|
|
4231
|
+
getAccountPaymentIntents(requestParameters, options) {
|
|
4232
|
+
return localVarFp.getAccountPaymentIntents(requestParameters.accountId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
4233
|
+
},
|
|
4135
4234
|
/**
|
|
4136
4235
|
* Returns a paginated list of payments made by the given account, searchable by payment ID, account email, or account name; requires the `read accounts` and `read payments` permissions.
|
|
4137
4236
|
* @summary List an account\'s payments
|
|
@@ -4337,6 +4436,16 @@ export class AccountsApi extends BaseAPI {
|
|
|
4337
4436
|
getAccountNotificationPreferences(requestParameters, options) {
|
|
4338
4437
|
return AccountsApiFp(this.configuration).getAccountNotificationPreferences(requestParameters.accountId, options).then((request) => request(this.axios, this.basePath));
|
|
4339
4438
|
}
|
|
4439
|
+
/**
|
|
4440
|
+
* Returns a paginated list of unpaid checkout payment intents for the given account; requires the `read accounts` and `read payments` permissions.
|
|
4441
|
+
* @summary List an account\'s payment intents
|
|
4442
|
+
* @param {AccountsApiGetAccountPaymentIntentsRequest} requestParameters Request parameters.
|
|
4443
|
+
* @param {*} [options] Override http request option.
|
|
4444
|
+
* @throws {RequiredError}
|
|
4445
|
+
*/
|
|
4446
|
+
getAccountPaymentIntents(requestParameters, options) {
|
|
4447
|
+
return AccountsApiFp(this.configuration).getAccountPaymentIntents(requestParameters.accountId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
4448
|
+
}
|
|
4340
4449
|
/**
|
|
4341
4450
|
* Returns a paginated list of payments made by the given account, searchable by payment ID, account email, or account name; requires the `read accounts` and `read payments` permissions.
|
|
4342
4451
|
* @summary List an account\'s payments
|
|
@@ -84834,6 +84943,40 @@ export const OrganizationPaymentsApiAxiosParamCreator = function (configuration)
|
|
|
84834
84943
|
options: localVarRequestOptions,
|
|
84835
84944
|
};
|
|
84836
84945
|
}),
|
|
84946
|
+
/**
|
|
84947
|
+
* Permanently removes an unpaid checkout payment intent identified by intentId. For Stripe, cancels an uncaptured PaymentIntent first and refuses if funds were already captured; requires update permission on the payments resource.
|
|
84948
|
+
* @summary Delete a payment intent
|
|
84949
|
+
* @param {string} intentId The intent identifier
|
|
84950
|
+
* @param {*} [options] Override http request option.
|
|
84951
|
+
* @throws {RequiredError}
|
|
84952
|
+
*/
|
|
84953
|
+
deletePaymentIntent: (intentId_1, ...args_1) => __awaiter(this, [intentId_1, ...args_1], void 0, function* (intentId, options = {}) {
|
|
84954
|
+
// verify required parameter 'intentId' is not null or undefined
|
|
84955
|
+
assertParamExists('deletePaymentIntent', 'intentId', intentId);
|
|
84956
|
+
const localVarPath = `/payment-intents/{intentId}`
|
|
84957
|
+
.replace(`{${"intentId"}}`, encodeURIComponent(String(intentId)));
|
|
84958
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
84959
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
84960
|
+
let baseOptions;
|
|
84961
|
+
if (configuration) {
|
|
84962
|
+
baseOptions = configuration.baseOptions;
|
|
84963
|
+
}
|
|
84964
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
|
|
84965
|
+
const localVarHeaderParameter = {};
|
|
84966
|
+
const localVarQueryParameter = {};
|
|
84967
|
+
// authentication ApiKeyAuth required
|
|
84968
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
84969
|
+
// authentication OrganizationId required
|
|
84970
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
84971
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
84972
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
84973
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
84974
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
84975
|
+
return {
|
|
84976
|
+
url: toPathString(localVarUrlObj),
|
|
84977
|
+
options: localVarRequestOptions,
|
|
84978
|
+
};
|
|
84979
|
+
}),
|
|
84837
84980
|
/**
|
|
84838
84981
|
* Returns the details of a single payment integration (e.g. Stripe, Braintree, Authorize.Net, or manual) configured for the organization, identified by integration ID; requires \"read\" permission on \"org\".
|
|
84839
84982
|
* @summary Get an organization payment integration
|
|
@@ -84948,6 +85091,86 @@ export const OrganizationPaymentsApiAxiosParamCreator = function (configuration)
|
|
|
84948
85091
|
options: localVarRequestOptions,
|
|
84949
85092
|
};
|
|
84950
85093
|
}),
|
|
85094
|
+
/**
|
|
85095
|
+
* Returns a single unpaid checkout payment intent identified by intent ID; requires \"read\" permission on \"payments\".
|
|
85096
|
+
* @summary Get a payment intent
|
|
85097
|
+
* @param {string} intentId The intent identifier
|
|
85098
|
+
* @param {*} [options] Override http request option.
|
|
85099
|
+
* @throws {RequiredError}
|
|
85100
|
+
*/
|
|
85101
|
+
getPaymentIntent: (intentId_1, ...args_1) => __awaiter(this, [intentId_1, ...args_1], void 0, function* (intentId, options = {}) {
|
|
85102
|
+
// verify required parameter 'intentId' is not null or undefined
|
|
85103
|
+
assertParamExists('getPaymentIntent', 'intentId', intentId);
|
|
85104
|
+
const localVarPath = `/payment-intents/{intentId}`
|
|
85105
|
+
.replace(`{${"intentId"}}`, encodeURIComponent(String(intentId)));
|
|
85106
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
85107
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
85108
|
+
let baseOptions;
|
|
85109
|
+
if (configuration) {
|
|
85110
|
+
baseOptions = configuration.baseOptions;
|
|
85111
|
+
}
|
|
85112
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
85113
|
+
const localVarHeaderParameter = {};
|
|
85114
|
+
const localVarQueryParameter = {};
|
|
85115
|
+
// authentication ApiKeyAuth required
|
|
85116
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
85117
|
+
// authentication OrganizationId required
|
|
85118
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
85119
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
85120
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
85121
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
85122
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
85123
|
+
return {
|
|
85124
|
+
url: toPathString(localVarUrlObj),
|
|
85125
|
+
options: localVarRequestOptions,
|
|
85126
|
+
};
|
|
85127
|
+
}),
|
|
85128
|
+
/**
|
|
85129
|
+
* Returns a paginated list of unpaid checkout payment intents for the organization, searchable by id, source, description, or account; requires \"read\" permission on \"payments\".
|
|
85130
|
+
* @summary List an organization\'s payment intents
|
|
85131
|
+
* @param {number} [page] Page number
|
|
85132
|
+
* @param {number} [pageSize] Number of items per page
|
|
85133
|
+
* @param {string} [orderBy] Field to order by
|
|
85134
|
+
* @param {string} [search] Search query
|
|
85135
|
+
* @param {*} [options] Override http request option.
|
|
85136
|
+
* @throws {RequiredError}
|
|
85137
|
+
*/
|
|
85138
|
+
getPaymentIntents: (page_1, pageSize_1, orderBy_1, search_1, ...args_1) => __awaiter(this, [page_1, pageSize_1, orderBy_1, search_1, ...args_1], void 0, function* (page, pageSize, orderBy, search, options = {}) {
|
|
85139
|
+
const localVarPath = `/payment-intents`;
|
|
85140
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
85141
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
85142
|
+
let baseOptions;
|
|
85143
|
+
if (configuration) {
|
|
85144
|
+
baseOptions = configuration.baseOptions;
|
|
85145
|
+
}
|
|
85146
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
85147
|
+
const localVarHeaderParameter = {};
|
|
85148
|
+
const localVarQueryParameter = {};
|
|
85149
|
+
// authentication ApiKeyAuth required
|
|
85150
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
85151
|
+
// authentication OrganizationId required
|
|
85152
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
85153
|
+
if (page !== undefined) {
|
|
85154
|
+
localVarQueryParameter['page'] = page;
|
|
85155
|
+
}
|
|
85156
|
+
if (pageSize !== undefined) {
|
|
85157
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
85158
|
+
}
|
|
85159
|
+
if (orderBy !== undefined) {
|
|
85160
|
+
localVarQueryParameter['orderBy'] = orderBy;
|
|
85161
|
+
}
|
|
85162
|
+
if (search !== undefined) {
|
|
85163
|
+
localVarQueryParameter['search'] = search;
|
|
85164
|
+
}
|
|
85165
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
85166
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
85167
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
85168
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
85169
|
+
return {
|
|
85170
|
+
url: toPathString(localVarUrlObj),
|
|
85171
|
+
options: localVarRequestOptions,
|
|
85172
|
+
};
|
|
85173
|
+
}),
|
|
84951
85174
|
/**
|
|
84952
85175
|
* Returns tax metadata recorded for a specific payment by fetching it from the tax integration (e.g. Taxjar, Avalara) linked to that payment, or a message if the payment has no associated tax integration; requires \"read\" permission on \"payments\".
|
|
84953
85176
|
* @summary Get a payment\'s tax metadata
|
|
@@ -85218,6 +85441,22 @@ export const OrganizationPaymentsApiFp = function (configuration) {
|
|
|
85218
85441
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
85219
85442
|
});
|
|
85220
85443
|
},
|
|
85444
|
+
/**
|
|
85445
|
+
* Permanently removes an unpaid checkout payment intent identified by intentId. For Stripe, cancels an uncaptured PaymentIntent first and refuses if funds were already captured; requires update permission on the payments resource.
|
|
85446
|
+
* @summary Delete a payment intent
|
|
85447
|
+
* @param {string} intentId The intent identifier
|
|
85448
|
+
* @param {*} [options] Override http request option.
|
|
85449
|
+
* @throws {RequiredError}
|
|
85450
|
+
*/
|
|
85451
|
+
deletePaymentIntent(intentId, options) {
|
|
85452
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
85453
|
+
var _a, _b, _c;
|
|
85454
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.deletePaymentIntent(intentId, options);
|
|
85455
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
85456
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['OrganizationPaymentsApi.deletePaymentIntent']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
85457
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
85458
|
+
});
|
|
85459
|
+
},
|
|
85221
85460
|
/**
|
|
85222
85461
|
* Returns the details of a single payment integration (e.g. Stripe, Braintree, Authorize.Net, or manual) configured for the organization, identified by integration ID; requires \"read\" permission on \"org\".
|
|
85223
85462
|
* @summary Get an organization payment integration
|
|
@@ -85269,6 +85508,41 @@ export const OrganizationPaymentsApiFp = function (configuration) {
|
|
|
85269
85508
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
85270
85509
|
});
|
|
85271
85510
|
},
|
|
85511
|
+
/**
|
|
85512
|
+
* Returns a single unpaid checkout payment intent identified by intent ID; requires \"read\" permission on \"payments\".
|
|
85513
|
+
* @summary Get a payment intent
|
|
85514
|
+
* @param {string} intentId The intent identifier
|
|
85515
|
+
* @param {*} [options] Override http request option.
|
|
85516
|
+
* @throws {RequiredError}
|
|
85517
|
+
*/
|
|
85518
|
+
getPaymentIntent(intentId, options) {
|
|
85519
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
85520
|
+
var _a, _b, _c;
|
|
85521
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getPaymentIntent(intentId, options);
|
|
85522
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
85523
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['OrganizationPaymentsApi.getPaymentIntent']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
85524
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
85525
|
+
});
|
|
85526
|
+
},
|
|
85527
|
+
/**
|
|
85528
|
+
* Returns a paginated list of unpaid checkout payment intents for the organization, searchable by id, source, description, or account; requires \"read\" permission on \"payments\".
|
|
85529
|
+
* @summary List an organization\'s payment intents
|
|
85530
|
+
* @param {number} [page] Page number
|
|
85531
|
+
* @param {number} [pageSize] Number of items per page
|
|
85532
|
+
* @param {string} [orderBy] Field to order by
|
|
85533
|
+
* @param {string} [search] Search query
|
|
85534
|
+
* @param {*} [options] Override http request option.
|
|
85535
|
+
* @throws {RequiredError}
|
|
85536
|
+
*/
|
|
85537
|
+
getPaymentIntents(page, pageSize, orderBy, search, options) {
|
|
85538
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
85539
|
+
var _a, _b, _c;
|
|
85540
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getPaymentIntents(page, pageSize, orderBy, search, options);
|
|
85541
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
85542
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['OrganizationPaymentsApi.getPaymentIntents']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
85543
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
85544
|
+
});
|
|
85545
|
+
},
|
|
85272
85546
|
/**
|
|
85273
85547
|
* Returns tax metadata recorded for a specific payment by fetching it from the tax integration (e.g. Taxjar, Avalara) linked to that payment, or a message if the payment has no associated tax integration; requires \"read\" permission on \"payments\".
|
|
85274
85548
|
* @summary Get a payment\'s tax metadata
|
|
@@ -85399,6 +85673,16 @@ export const OrganizationPaymentsApiFactory = function (configuration, basePath,
|
|
|
85399
85673
|
deleteOrganizationPaymentIntegration(requestParameters, options) {
|
|
85400
85674
|
return localVarFp.deleteOrganizationPaymentIntegration(requestParameters.integrationId, options).then((request) => request(axios, basePath));
|
|
85401
85675
|
},
|
|
85676
|
+
/**
|
|
85677
|
+
* Permanently removes an unpaid checkout payment intent identified by intentId. For Stripe, cancels an uncaptured PaymentIntent first and refuses if funds were already captured; requires update permission on the payments resource.
|
|
85678
|
+
* @summary Delete a payment intent
|
|
85679
|
+
* @param {OrganizationPaymentsApiDeletePaymentIntentRequest} requestParameters Request parameters.
|
|
85680
|
+
* @param {*} [options] Override http request option.
|
|
85681
|
+
* @throws {RequiredError}
|
|
85682
|
+
*/
|
|
85683
|
+
deletePaymentIntent(requestParameters, options) {
|
|
85684
|
+
return localVarFp.deletePaymentIntent(requestParameters.intentId, options).then((request) => request(axios, basePath));
|
|
85685
|
+
},
|
|
85402
85686
|
/**
|
|
85403
85687
|
* Returns the details of a single payment integration (e.g. Stripe, Braintree, Authorize.Net, or manual) configured for the organization, identified by integration ID; requires \"read\" permission on \"org\".
|
|
85404
85688
|
* @summary Get an organization payment integration
|
|
@@ -85429,6 +85713,26 @@ export const OrganizationPaymentsApiFactory = function (configuration, basePath,
|
|
|
85429
85713
|
getPayment(requestParameters, options) {
|
|
85430
85714
|
return localVarFp.getPayment(requestParameters.paymentId, options).then((request) => request(axios, basePath));
|
|
85431
85715
|
},
|
|
85716
|
+
/**
|
|
85717
|
+
* Returns a single unpaid checkout payment intent identified by intent ID; requires \"read\" permission on \"payments\".
|
|
85718
|
+
* @summary Get a payment intent
|
|
85719
|
+
* @param {OrganizationPaymentsApiGetPaymentIntentRequest} requestParameters Request parameters.
|
|
85720
|
+
* @param {*} [options] Override http request option.
|
|
85721
|
+
* @throws {RequiredError}
|
|
85722
|
+
*/
|
|
85723
|
+
getPaymentIntent(requestParameters, options) {
|
|
85724
|
+
return localVarFp.getPaymentIntent(requestParameters.intentId, options).then((request) => request(axios, basePath));
|
|
85725
|
+
},
|
|
85726
|
+
/**
|
|
85727
|
+
* Returns a paginated list of unpaid checkout payment intents for the organization, searchable by id, source, description, or account; requires \"read\" permission on \"payments\".
|
|
85728
|
+
* @summary List an organization\'s payment intents
|
|
85729
|
+
* @param {OrganizationPaymentsApiGetPaymentIntentsRequest} requestParameters Request parameters.
|
|
85730
|
+
* @param {*} [options] Override http request option.
|
|
85731
|
+
* @throws {RequiredError}
|
|
85732
|
+
*/
|
|
85733
|
+
getPaymentIntents(requestParameters = {}, options) {
|
|
85734
|
+
return localVarFp.getPaymentIntents(requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
85735
|
+
},
|
|
85432
85736
|
/**
|
|
85433
85737
|
* Returns tax metadata recorded for a specific payment by fetching it from the tax integration (e.g. Taxjar, Avalara) linked to that payment, or a message if the payment has no associated tax integration; requires \"read\" permission on \"payments\".
|
|
85434
85738
|
* @summary Get a payment\'s tax metadata
|
|
@@ -85515,6 +85819,16 @@ export class OrganizationPaymentsApi extends BaseAPI {
|
|
|
85515
85819
|
deleteOrganizationPaymentIntegration(requestParameters, options) {
|
|
85516
85820
|
return OrganizationPaymentsApiFp(this.configuration).deleteOrganizationPaymentIntegration(requestParameters.integrationId, options).then((request) => request(this.axios, this.basePath));
|
|
85517
85821
|
}
|
|
85822
|
+
/**
|
|
85823
|
+
* Permanently removes an unpaid checkout payment intent identified by intentId. For Stripe, cancels an uncaptured PaymentIntent first and refuses if funds were already captured; requires update permission on the payments resource.
|
|
85824
|
+
* @summary Delete a payment intent
|
|
85825
|
+
* @param {OrganizationPaymentsApiDeletePaymentIntentRequest} requestParameters Request parameters.
|
|
85826
|
+
* @param {*} [options] Override http request option.
|
|
85827
|
+
* @throws {RequiredError}
|
|
85828
|
+
*/
|
|
85829
|
+
deletePaymentIntent(requestParameters, options) {
|
|
85830
|
+
return OrganizationPaymentsApiFp(this.configuration).deletePaymentIntent(requestParameters.intentId, options).then((request) => request(this.axios, this.basePath));
|
|
85831
|
+
}
|
|
85518
85832
|
/**
|
|
85519
85833
|
* Returns the details of a single payment integration (e.g. Stripe, Braintree, Authorize.Net, or manual) configured for the organization, identified by integration ID; requires \"read\" permission on \"org\".
|
|
85520
85834
|
* @summary Get an organization payment integration
|
|
@@ -85545,6 +85859,26 @@ export class OrganizationPaymentsApi extends BaseAPI {
|
|
|
85545
85859
|
getPayment(requestParameters, options) {
|
|
85546
85860
|
return OrganizationPaymentsApiFp(this.configuration).getPayment(requestParameters.paymentId, options).then((request) => request(this.axios, this.basePath));
|
|
85547
85861
|
}
|
|
85862
|
+
/**
|
|
85863
|
+
* Returns a single unpaid checkout payment intent identified by intent ID; requires \"read\" permission on \"payments\".
|
|
85864
|
+
* @summary Get a payment intent
|
|
85865
|
+
* @param {OrganizationPaymentsApiGetPaymentIntentRequest} requestParameters Request parameters.
|
|
85866
|
+
* @param {*} [options] Override http request option.
|
|
85867
|
+
* @throws {RequiredError}
|
|
85868
|
+
*/
|
|
85869
|
+
getPaymentIntent(requestParameters, options) {
|
|
85870
|
+
return OrganizationPaymentsApiFp(this.configuration).getPaymentIntent(requestParameters.intentId, options).then((request) => request(this.axios, this.basePath));
|
|
85871
|
+
}
|
|
85872
|
+
/**
|
|
85873
|
+
* Returns a paginated list of unpaid checkout payment intents for the organization, searchable by id, source, description, or account; requires \"read\" permission on \"payments\".
|
|
85874
|
+
* @summary List an organization\'s payment intents
|
|
85875
|
+
* @param {OrganizationPaymentsApiGetPaymentIntentsRequest} requestParameters Request parameters.
|
|
85876
|
+
* @param {*} [options] Override http request option.
|
|
85877
|
+
* @throws {RequiredError}
|
|
85878
|
+
*/
|
|
85879
|
+
getPaymentIntents(requestParameters = {}, options) {
|
|
85880
|
+
return OrganizationPaymentsApiFp(this.configuration).getPaymentIntents(requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
85881
|
+
}
|
|
85548
85882
|
/**
|
|
85549
85883
|
* Returns tax metadata recorded for a specific payment by fetching it from the tax integration (e.g. Taxjar, Avalara) linked to that payment, or a message if the payment has no associated tax integration; requires \"read\" permission on \"payments\".
|
|
85550
85884
|
* @summary Get a payment\'s tax metadata
|
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: 10.
|
|
5
|
+
* The version of the OpenAPI document: 10.7.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: 10.
|
|
7
|
+
* The version of the OpenAPI document: 10.7.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: 10.
|
|
5
|
+
* The version of the OpenAPI document: 10.7.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: 10.
|
|
7
|
+
* The version of the OpenAPI document: 10.7.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: 10.
|
|
5
|
+
* The version of the OpenAPI document: 10.7.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: 10.
|
|
6
|
+
* The version of the OpenAPI document: 10.7.0
|
|
7
7
|
*
|
|
8
8
|
*
|
|
9
9
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/docs/AccountsApi.md
CHANGED
|
@@ -15,6 +15,7 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
15
15
|
|[**getAccountEvents**](#getaccountevents) | **GET** /accounts/{accountId}/events | List an account\'s events|
|
|
16
16
|
|[**getAccountLikes**](#getaccountlikes) | **GET** /accounts/{accountId}/likes | List an account\'s likes|
|
|
17
17
|
|[**getAccountNotificationPreferences**](#getaccountnotificationpreferences) | **GET** /accounts/{accountId}/notification-preferences | Get an account\'s notification preferences|
|
|
18
|
+
|[**getAccountPaymentIntents**](#getaccountpaymentintents) | **GET** /accounts/{accountId}/payment-intents | List an account\'s payment intents|
|
|
18
19
|
|[**getAccountPayments**](#getaccountpayments) | **GET** /accounts/{accountId}/payments | List an account\'s payments|
|
|
19
20
|
|[**getAccountRegistrations**](#getaccountregistrations) | **GET** /accounts/{accountId}/registrations | List an account\'s event registrations|
|
|
20
21
|
|[**getAccountSupportTickets**](#getaccountsupporttickets) | **GET** /accounts/{accountId}/supportTickets | List an account\'s support tickets|
|
|
@@ -661,6 +662,69 @@ const { status, data } = await apiInstance.getAccountNotificationPreferences(
|
|
|
661
662
|
- **Accept**: application/json
|
|
662
663
|
|
|
663
664
|
|
|
665
|
+
### HTTP response details
|
|
666
|
+
| Status code | Description | Response headers |
|
|
667
|
+
|-------------|-------------|------------------|
|
|
668
|
+
|**200** | Successful response | - |
|
|
669
|
+
|
|
670
|
+
[[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)
|
|
671
|
+
|
|
672
|
+
# **getAccountPaymentIntents**
|
|
673
|
+
> GetAccountPaymentIntents200Response getAccountPaymentIntents()
|
|
674
|
+
|
|
675
|
+
Returns a paginated list of unpaid checkout payment intents for the given account; requires the `read accounts` and `read payments` permissions.
|
|
676
|
+
|
|
677
|
+
### Example
|
|
678
|
+
|
|
679
|
+
```typescript
|
|
680
|
+
import {
|
|
681
|
+
AccountsApi,
|
|
682
|
+
Configuration
|
|
683
|
+
} from '@connectedxm/admin-sdk';
|
|
684
|
+
|
|
685
|
+
const configuration = new Configuration();
|
|
686
|
+
const apiInstance = new AccountsApi(configuration);
|
|
687
|
+
|
|
688
|
+
let accountId: string; //The account identifier (default to undefined)
|
|
689
|
+
let page: number; //Page number (optional) (default to 1)
|
|
690
|
+
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
691
|
+
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
692
|
+
let search: string; //Search query (optional) (default to undefined)
|
|
693
|
+
|
|
694
|
+
const { status, data } = await apiInstance.getAccountPaymentIntents(
|
|
695
|
+
accountId,
|
|
696
|
+
page,
|
|
697
|
+
pageSize,
|
|
698
|
+
orderBy,
|
|
699
|
+
search
|
|
700
|
+
);
|
|
701
|
+
```
|
|
702
|
+
|
|
703
|
+
### Parameters
|
|
704
|
+
|
|
705
|
+
|Name | Type | Description | Notes|
|
|
706
|
+
|------------- | ------------- | ------------- | -------------|
|
|
707
|
+
| **accountId** | [**string**] | The account identifier | defaults to undefined|
|
|
708
|
+
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
709
|
+
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
710
|
+
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
711
|
+
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
712
|
+
|
|
713
|
+
|
|
714
|
+
### Return type
|
|
715
|
+
|
|
716
|
+
**GetAccountPaymentIntents200Response**
|
|
717
|
+
|
|
718
|
+
### Authorization
|
|
719
|
+
|
|
720
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
721
|
+
|
|
722
|
+
### HTTP request headers
|
|
723
|
+
|
|
724
|
+
- **Content-Type**: Not defined
|
|
725
|
+
- **Accept**: application/json
|
|
726
|
+
|
|
727
|
+
|
|
664
728
|
### HTTP response details
|
|
665
729
|
| Status code | Description | Response headers |
|
|
666
730
|
|-------------|-------------|------------------|
|