@connectedxm/admin-sdk 10.2.1 → 10.3.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/README.md +2 -2
- package/api.ts +99 -15
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +50 -9
- package/dist/api.js +83 -13
- 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 +50 -9
- package/dist/esm/api.js +83 -13
- 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/OrganizationPaymentsApi.md +56 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @connectedxm/admin-sdk@10.
|
|
1
|
+
## @connectedxm/admin-sdk@10.3.0
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @connectedxm/admin-sdk@10.
|
|
39
|
+
npm install @connectedxm/admin-sdk@10.3.0 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
package/api.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Connected Admin API
|
|
5
5
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 10.
|
|
7
|
+
* The version of the OpenAPI document: 10.3.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -122700,11 +122700,11 @@ export const OrganizationPaymentsApiAxiosParamCreator = function (configuration?
|
|
|
122700
122700
|
* @param {*} [options] Override http request option.
|
|
122701
122701
|
* @throws {RequiredError}
|
|
122702
122702
|
*/
|
|
122703
|
-
|
|
122703
|
+
refundPayment: async (paymentId: string, refundLineItem: Array<RefundLineItem>, eventId?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
122704
122704
|
// verify required parameter 'paymentId' is not null or undefined
|
|
122705
|
-
assertParamExists('
|
|
122705
|
+
assertParamExists('refundPayment', 'paymentId', paymentId)
|
|
122706
122706
|
// verify required parameter 'refundLineItem' is not null or undefined
|
|
122707
|
-
assertParamExists('
|
|
122707
|
+
assertParamExists('refundPayment', 'refundLineItem', refundLineItem)
|
|
122708
122708
|
const localVarPath = `/payments/{paymentId}/refund`
|
|
122709
122709
|
.replace(`{${"paymentId"}}`, encodeURIComponent(String(paymentId)));
|
|
122710
122710
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -122741,6 +122741,46 @@ export const OrganizationPaymentsApiAxiosParamCreator = function (configuration?
|
|
|
122741
122741
|
options: localVarRequestOptions,
|
|
122742
122742
|
};
|
|
122743
122743
|
},
|
|
122744
|
+
/**
|
|
122745
|
+
* Queues a receipt email to the account on the payment, itemized with every line item and net of any refunds, for an attendee who needs one for tax or reimbursement purposes; only captured charges are eligible, and requires read and update permissions on payments.
|
|
122746
|
+
* @summary Email a receipt for a payment
|
|
122747
|
+
* @param {string} paymentId The payment identifier
|
|
122748
|
+
* @param {*} [options] Override http request option.
|
|
122749
|
+
* @throws {RequiredError}
|
|
122750
|
+
*/
|
|
122751
|
+
sendPaymentReceipt: async (paymentId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
122752
|
+
// verify required parameter 'paymentId' is not null or undefined
|
|
122753
|
+
assertParamExists('sendPaymentReceipt', 'paymentId', paymentId)
|
|
122754
|
+
const localVarPath = `/payments/{paymentId}/receipt`
|
|
122755
|
+
.replace(`{${"paymentId"}}`, encodeURIComponent(String(paymentId)));
|
|
122756
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
122757
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
122758
|
+
let baseOptions;
|
|
122759
|
+
if (configuration) {
|
|
122760
|
+
baseOptions = configuration.baseOptions;
|
|
122761
|
+
}
|
|
122762
|
+
|
|
122763
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
122764
|
+
const localVarHeaderParameter = {} as any;
|
|
122765
|
+
const localVarQueryParameter = {} as any;
|
|
122766
|
+
|
|
122767
|
+
// authentication ApiKeyAuth required
|
|
122768
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
122769
|
+
|
|
122770
|
+
// authentication OrganizationId required
|
|
122771
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
122772
|
+
|
|
122773
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
122774
|
+
|
|
122775
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
122776
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
122777
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
122778
|
+
|
|
122779
|
+
return {
|
|
122780
|
+
url: toPathString(localVarUrlObj),
|
|
122781
|
+
options: localVarRequestOptions,
|
|
122782
|
+
};
|
|
122783
|
+
},
|
|
122744
122784
|
/**
|
|
122745
122785
|
* Toggles the specified payment integration, identified by integrationId, to be the organization\'s default payment integration, requiring update permission on the org resource.
|
|
122746
122786
|
* @summary Set an organization payment integration as default
|
|
@@ -122941,10 +122981,23 @@ export const OrganizationPaymentsApiFp = function(configuration?: Configuration)
|
|
|
122941
122981
|
* @param {*} [options] Override http request option.
|
|
122942
122982
|
* @throws {RequiredError}
|
|
122943
122983
|
*/
|
|
122944
|
-
async
|
|
122945
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
122984
|
+
async refundPayment(paymentId: string, refundLineItem: Array<RefundLineItem>, eventId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPayment200Response>> {
|
|
122985
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.refundPayment(paymentId, refundLineItem, eventId, options);
|
|
122986
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
122987
|
+
const localVarOperationServerBasePath = operationServerMap['OrganizationPaymentsApi.refundPayment']?.[localVarOperationServerIndex]?.url;
|
|
122988
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
122989
|
+
},
|
|
122990
|
+
/**
|
|
122991
|
+
* Queues a receipt email to the account on the payment, itemized with every line item and net of any refunds, for an attendee who needs one for tax or reimbursement purposes; only captured charges are eligible, and requires read and update permissions on payments.
|
|
122992
|
+
* @summary Email a receipt for a payment
|
|
122993
|
+
* @param {string} paymentId The payment identifier
|
|
122994
|
+
* @param {*} [options] Override http request option.
|
|
122995
|
+
* @throws {RequiredError}
|
|
122996
|
+
*/
|
|
122997
|
+
async sendPaymentReceipt(paymentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>> {
|
|
122998
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.sendPaymentReceipt(paymentId, options);
|
|
122946
122999
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
122947
|
-
const localVarOperationServerBasePath = operationServerMap['OrganizationPaymentsApi.
|
|
123000
|
+
const localVarOperationServerBasePath = operationServerMap['OrganizationPaymentsApi.sendPaymentReceipt']?.[localVarOperationServerIndex]?.url;
|
|
122948
123001
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
122949
123002
|
},
|
|
122950
123003
|
/**
|
|
@@ -123056,12 +123109,22 @@ export const OrganizationPaymentsApiFactory = function (configuration?: Configur
|
|
|
123056
123109
|
/**
|
|
123057
123110
|
* Issues a refund for one or more line items on the specified payment, identified by paymentId, requiring update permission on the payments resource; at least one line item with a positive amount must be provided.
|
|
123058
123111
|
* @summary Refund line items on a payment
|
|
123059
|
-
* @param {
|
|
123112
|
+
* @param {OrganizationPaymentsApiRefundPaymentRequest} requestParameters Request parameters.
|
|
123060
123113
|
* @param {*} [options] Override http request option.
|
|
123061
123114
|
* @throws {RequiredError}
|
|
123062
123115
|
*/
|
|
123063
|
-
|
|
123064
|
-
return localVarFp.
|
|
123116
|
+
refundPayment(requestParameters: OrganizationPaymentsApiRefundPaymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPayment200Response> {
|
|
123117
|
+
return localVarFp.refundPayment(requestParameters.paymentId, requestParameters.refundLineItem, requestParameters.eventId, options).then((request) => request(axios, basePath));
|
|
123118
|
+
},
|
|
123119
|
+
/**
|
|
123120
|
+
* Queues a receipt email to the account on the payment, itemized with every line item and net of any refunds, for an attendee who needs one for tax or reimbursement purposes; only captured charges are eligible, and requires read and update permissions on payments.
|
|
123121
|
+
* @summary Email a receipt for a payment
|
|
123122
|
+
* @param {OrganizationPaymentsApiSendPaymentReceiptRequest} requestParameters Request parameters.
|
|
123123
|
+
* @param {*} [options] Override http request option.
|
|
123124
|
+
* @throws {RequiredError}
|
|
123125
|
+
*/
|
|
123126
|
+
sendPaymentReceipt(requestParameters: OrganizationPaymentsApiSendPaymentReceiptRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response> {
|
|
123127
|
+
return localVarFp.sendPaymentReceipt(requestParameters.paymentId, options).then((request) => request(axios, basePath));
|
|
123065
123128
|
},
|
|
123066
123129
|
/**
|
|
123067
123130
|
* Toggles the specified payment integration, identified by integrationId, to be the organization\'s default payment integration, requiring update permission on the org resource.
|
|
@@ -123184,9 +123247,9 @@ export interface OrganizationPaymentsApiGetPaymentsRequest {
|
|
|
123184
123247
|
}
|
|
123185
123248
|
|
|
123186
123249
|
/**
|
|
123187
|
-
* Request parameters for
|
|
123250
|
+
* Request parameters for refundPayment operation in OrganizationPaymentsApi.
|
|
123188
123251
|
*/
|
|
123189
|
-
export interface
|
|
123252
|
+
export interface OrganizationPaymentsApiRefundPaymentRequest {
|
|
123190
123253
|
/**
|
|
123191
123254
|
* The payment identifier
|
|
123192
123255
|
*/
|
|
@@ -123200,6 +123263,16 @@ export interface OrganizationPaymentsApiRefundOrganizationPaymentRequest {
|
|
|
123200
123263
|
readonly eventId?: string
|
|
123201
123264
|
}
|
|
123202
123265
|
|
|
123266
|
+
/**
|
|
123267
|
+
* Request parameters for sendPaymentReceipt operation in OrganizationPaymentsApi.
|
|
123268
|
+
*/
|
|
123269
|
+
export interface OrganizationPaymentsApiSendPaymentReceiptRequest {
|
|
123270
|
+
/**
|
|
123271
|
+
* The payment identifier
|
|
123272
|
+
*/
|
|
123273
|
+
readonly paymentId: string
|
|
123274
|
+
}
|
|
123275
|
+
|
|
123203
123276
|
/**
|
|
123204
123277
|
* Request parameters for toggleOrganizationPaymentIntegration operation in OrganizationPaymentsApi.
|
|
123205
123278
|
*/
|
|
@@ -123306,12 +123379,23 @@ export class OrganizationPaymentsApi extends BaseAPI {
|
|
|
123306
123379
|
/**
|
|
123307
123380
|
* Issues a refund for one or more line items on the specified payment, identified by paymentId, requiring update permission on the payments resource; at least one line item with a positive amount must be provided.
|
|
123308
123381
|
* @summary Refund line items on a payment
|
|
123309
|
-
* @param {
|
|
123382
|
+
* @param {OrganizationPaymentsApiRefundPaymentRequest} requestParameters Request parameters.
|
|
123383
|
+
* @param {*} [options] Override http request option.
|
|
123384
|
+
* @throws {RequiredError}
|
|
123385
|
+
*/
|
|
123386
|
+
public refundPayment(requestParameters: OrganizationPaymentsApiRefundPaymentRequest, options?: RawAxiosRequestConfig) {
|
|
123387
|
+
return OrganizationPaymentsApiFp(this.configuration).refundPayment(requestParameters.paymentId, requestParameters.refundLineItem, requestParameters.eventId, options).then((request) => request(this.axios, this.basePath));
|
|
123388
|
+
}
|
|
123389
|
+
|
|
123390
|
+
/**
|
|
123391
|
+
* Queues a receipt email to the account on the payment, itemized with every line item and net of any refunds, for an attendee who needs one for tax or reimbursement purposes; only captured charges are eligible, and requires read and update permissions on payments.
|
|
123392
|
+
* @summary Email a receipt for a payment
|
|
123393
|
+
* @param {OrganizationPaymentsApiSendPaymentReceiptRequest} requestParameters Request parameters.
|
|
123310
123394
|
* @param {*} [options] Override http request option.
|
|
123311
123395
|
* @throws {RequiredError}
|
|
123312
123396
|
*/
|
|
123313
|
-
public
|
|
123314
|
-
return OrganizationPaymentsApiFp(this.configuration).
|
|
123397
|
+
public sendPaymentReceipt(requestParameters: OrganizationPaymentsApiSendPaymentReceiptRequest, options?: RawAxiosRequestConfig) {
|
|
123398
|
+
return OrganizationPaymentsApiFp(this.configuration).sendPaymentReceipt(requestParameters.paymentId, options).then((request) => request(this.axios, this.basePath));
|
|
123315
123399
|
}
|
|
123316
123400
|
|
|
123317
123401
|
/**
|
package/base.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Connected Admin API
|
|
5
5
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 10.
|
|
7
|
+
* The version of the OpenAPI document: 10.3.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/common.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Connected Admin API
|
|
5
5
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 10.
|
|
7
|
+
* The version of the OpenAPI document: 10.3.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/configuration.ts
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
* Connected Admin API
|
|
4
4
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
5
5
|
*
|
|
6
|
-
* The version of the OpenAPI document: 10.
|
|
6
|
+
* The version of the OpenAPI document: 10.3.0
|
|
7
7
|
*
|
|
8
8
|
*
|
|
9
9
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Connected Admin API
|
|
3
3
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 10.
|
|
5
|
+
* The version of the OpenAPI document: 10.3.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -67717,7 +67717,15 @@ export declare const OrganizationPaymentsApiAxiosParamCreator: (configuration?:
|
|
|
67717
67717
|
* @param {*} [options] Override http request option.
|
|
67718
67718
|
* @throws {RequiredError}
|
|
67719
67719
|
*/
|
|
67720
|
-
|
|
67720
|
+
refundPayment: (paymentId: string, refundLineItem: Array<RefundLineItem>, eventId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
67721
|
+
/**
|
|
67722
|
+
* Queues a receipt email to the account on the payment, itemized with every line item and net of any refunds, for an attendee who needs one for tax or reimbursement purposes; only captured charges are eligible, and requires read and update permissions on payments.
|
|
67723
|
+
* @summary Email a receipt for a payment
|
|
67724
|
+
* @param {string} paymentId The payment identifier
|
|
67725
|
+
* @param {*} [options] Override http request option.
|
|
67726
|
+
* @throws {RequiredError}
|
|
67727
|
+
*/
|
|
67728
|
+
sendPaymentReceipt: (paymentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
67721
67729
|
/**
|
|
67722
67730
|
* Toggles the specified payment integration, identified by integrationId, to be the organization\'s default payment integration, requiring update permission on the org resource.
|
|
67723
67731
|
* @summary Set an organization payment integration as default
|
|
@@ -67811,7 +67819,15 @@ export declare const OrganizationPaymentsApiFp: (configuration?: Configuration)
|
|
|
67811
67819
|
* @param {*} [options] Override http request option.
|
|
67812
67820
|
* @throws {RequiredError}
|
|
67813
67821
|
*/
|
|
67814
|
-
|
|
67822
|
+
refundPayment(paymentId: string, refundLineItem: Array<RefundLineItem>, eventId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPayment200Response>>;
|
|
67823
|
+
/**
|
|
67824
|
+
* Queues a receipt email to the account on the payment, itemized with every line item and net of any refunds, for an attendee who needs one for tax or reimbursement purposes; only captured charges are eligible, and requires read and update permissions on payments.
|
|
67825
|
+
* @summary Email a receipt for a payment
|
|
67826
|
+
* @param {string} paymentId The payment identifier
|
|
67827
|
+
* @param {*} [options] Override http request option.
|
|
67828
|
+
* @throws {RequiredError}
|
|
67829
|
+
*/
|
|
67830
|
+
sendPaymentReceipt(paymentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>>;
|
|
67815
67831
|
/**
|
|
67816
67832
|
* Toggles the specified payment integration, identified by integrationId, to be the organization\'s default payment integration, requiring update permission on the org resource.
|
|
67817
67833
|
* @summary Set an organization payment integration as default
|
|
@@ -67893,11 +67909,19 @@ export declare const OrganizationPaymentsApiFactory: (configuration?: Configurat
|
|
|
67893
67909
|
/**
|
|
67894
67910
|
* Issues a refund for one or more line items on the specified payment, identified by paymentId, requiring update permission on the payments resource; at least one line item with a positive amount must be provided.
|
|
67895
67911
|
* @summary Refund line items on a payment
|
|
67896
|
-
* @param {
|
|
67912
|
+
* @param {OrganizationPaymentsApiRefundPaymentRequest} requestParameters Request parameters.
|
|
67897
67913
|
* @param {*} [options] Override http request option.
|
|
67898
67914
|
* @throws {RequiredError}
|
|
67899
67915
|
*/
|
|
67900
|
-
|
|
67916
|
+
refundPayment(requestParameters: OrganizationPaymentsApiRefundPaymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPayment200Response>;
|
|
67917
|
+
/**
|
|
67918
|
+
* Queues a receipt email to the account on the payment, itemized with every line item and net of any refunds, for an attendee who needs one for tax or reimbursement purposes; only captured charges are eligible, and requires read and update permissions on payments.
|
|
67919
|
+
* @summary Email a receipt for a payment
|
|
67920
|
+
* @param {OrganizationPaymentsApiSendPaymentReceiptRequest} requestParameters Request parameters.
|
|
67921
|
+
* @param {*} [options] Override http request option.
|
|
67922
|
+
* @throws {RequiredError}
|
|
67923
|
+
*/
|
|
67924
|
+
sendPaymentReceipt(requestParameters: OrganizationPaymentsApiSendPaymentReceiptRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response>;
|
|
67901
67925
|
/**
|
|
67902
67926
|
* Toggles the specified payment integration, identified by integrationId, to be the organization\'s default payment integration, requiring update permission on the org resource.
|
|
67903
67927
|
* @summary Set an organization payment integration as default
|
|
@@ -68000,9 +68024,9 @@ export interface OrganizationPaymentsApiGetPaymentsRequest {
|
|
|
68000
68024
|
readonly search?: string;
|
|
68001
68025
|
}
|
|
68002
68026
|
/**
|
|
68003
|
-
* Request parameters for
|
|
68027
|
+
* Request parameters for refundPayment operation in OrganizationPaymentsApi.
|
|
68004
68028
|
*/
|
|
68005
|
-
export interface
|
|
68029
|
+
export interface OrganizationPaymentsApiRefundPaymentRequest {
|
|
68006
68030
|
/**
|
|
68007
68031
|
* The payment identifier
|
|
68008
68032
|
*/
|
|
@@ -68013,6 +68037,15 @@ export interface OrganizationPaymentsApiRefundOrganizationPaymentRequest {
|
|
|
68013
68037
|
*/
|
|
68014
68038
|
readonly eventId?: string;
|
|
68015
68039
|
}
|
|
68040
|
+
/**
|
|
68041
|
+
* Request parameters for sendPaymentReceipt operation in OrganizationPaymentsApi.
|
|
68042
|
+
*/
|
|
68043
|
+
export interface OrganizationPaymentsApiSendPaymentReceiptRequest {
|
|
68044
|
+
/**
|
|
68045
|
+
* The payment identifier
|
|
68046
|
+
*/
|
|
68047
|
+
readonly paymentId: string;
|
|
68048
|
+
}
|
|
68016
68049
|
/**
|
|
68017
68050
|
* Request parameters for toggleOrganizationPaymentIntegration operation in OrganizationPaymentsApi.
|
|
68018
68051
|
*/
|
|
@@ -68095,11 +68128,19 @@ export declare class OrganizationPaymentsApi extends BaseAPI {
|
|
|
68095
68128
|
/**
|
|
68096
68129
|
* Issues a refund for one or more line items on the specified payment, identified by paymentId, requiring update permission on the payments resource; at least one line item with a positive amount must be provided.
|
|
68097
68130
|
* @summary Refund line items on a payment
|
|
68098
|
-
* @param {
|
|
68131
|
+
* @param {OrganizationPaymentsApiRefundPaymentRequest} requestParameters Request parameters.
|
|
68132
|
+
* @param {*} [options] Override http request option.
|
|
68133
|
+
* @throws {RequiredError}
|
|
68134
|
+
*/
|
|
68135
|
+
refundPayment(requestParameters: OrganizationPaymentsApiRefundPaymentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPayment200Response, any, {}>>;
|
|
68136
|
+
/**
|
|
68137
|
+
* Queues a receipt email to the account on the payment, itemized with every line item and net of any refunds, for an attendee who needs one for tax or reimbursement purposes; only captured charges are eligible, and requires read and update permissions on payments.
|
|
68138
|
+
* @summary Email a receipt for a payment
|
|
68139
|
+
* @param {OrganizationPaymentsApiSendPaymentReceiptRequest} requestParameters Request parameters.
|
|
68099
68140
|
* @param {*} [options] Override http request option.
|
|
68100
68141
|
* @throws {RequiredError}
|
|
68101
68142
|
*/
|
|
68102
|
-
|
|
68143
|
+
sendPaymentReceipt(requestParameters: OrganizationPaymentsApiSendPaymentReceiptRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAccountInvitations200Response, any, {}>>;
|
|
68103
68144
|
/**
|
|
68104
68145
|
* Toggles the specified payment integration, identified by integrationId, to be the organization\'s default payment integration, requiring update permission on the org resource.
|
|
68105
68146
|
* @summary Set an organization payment integration as default
|
package/dist/api.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Connected Admin API
|
|
6
6
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 10.
|
|
8
|
+
* The version of the OpenAPI document: 10.3.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -85642,11 +85642,11 @@ const OrganizationPaymentsApiAxiosParamCreator = function (configuration) {
|
|
|
85642
85642
|
* @param {*} [options] Override http request option.
|
|
85643
85643
|
* @throws {RequiredError}
|
|
85644
85644
|
*/
|
|
85645
|
-
|
|
85645
|
+
refundPayment: (paymentId_1, refundLineItem_1, eventId_1, ...args_1) => __awaiter(this, [paymentId_1, refundLineItem_1, eventId_1, ...args_1], void 0, function* (paymentId, refundLineItem, eventId, options = {}) {
|
|
85646
85646
|
// verify required parameter 'paymentId' is not null or undefined
|
|
85647
|
-
(0, common_1.assertParamExists)('
|
|
85647
|
+
(0, common_1.assertParamExists)('refundPayment', 'paymentId', paymentId);
|
|
85648
85648
|
// verify required parameter 'refundLineItem' is not null or undefined
|
|
85649
|
-
(0, common_1.assertParamExists)('
|
|
85649
|
+
(0, common_1.assertParamExists)('refundPayment', 'refundLineItem', refundLineItem);
|
|
85650
85650
|
const localVarPath = `/payments/{paymentId}/refund`
|
|
85651
85651
|
.replace(`{${"paymentId"}}`, encodeURIComponent(String(paymentId)));
|
|
85652
85652
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -85676,6 +85676,40 @@ const OrganizationPaymentsApiAxiosParamCreator = function (configuration) {
|
|
|
85676
85676
|
options: localVarRequestOptions,
|
|
85677
85677
|
};
|
|
85678
85678
|
}),
|
|
85679
|
+
/**
|
|
85680
|
+
* Queues a receipt email to the account on the payment, itemized with every line item and net of any refunds, for an attendee who needs one for tax or reimbursement purposes; only captured charges are eligible, and requires read and update permissions on payments.
|
|
85681
|
+
* @summary Email a receipt for a payment
|
|
85682
|
+
* @param {string} paymentId The payment identifier
|
|
85683
|
+
* @param {*} [options] Override http request option.
|
|
85684
|
+
* @throws {RequiredError}
|
|
85685
|
+
*/
|
|
85686
|
+
sendPaymentReceipt: (paymentId_1, ...args_1) => __awaiter(this, [paymentId_1, ...args_1], void 0, function* (paymentId, options = {}) {
|
|
85687
|
+
// verify required parameter 'paymentId' is not null or undefined
|
|
85688
|
+
(0, common_1.assertParamExists)('sendPaymentReceipt', 'paymentId', paymentId);
|
|
85689
|
+
const localVarPath = `/payments/{paymentId}/receipt`
|
|
85690
|
+
.replace(`{${"paymentId"}}`, encodeURIComponent(String(paymentId)));
|
|
85691
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
85692
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
85693
|
+
let baseOptions;
|
|
85694
|
+
if (configuration) {
|
|
85695
|
+
baseOptions = configuration.baseOptions;
|
|
85696
|
+
}
|
|
85697
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
85698
|
+
const localVarHeaderParameter = {};
|
|
85699
|
+
const localVarQueryParameter = {};
|
|
85700
|
+
// authentication ApiKeyAuth required
|
|
85701
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "api-key", configuration);
|
|
85702
|
+
// authentication OrganizationId required
|
|
85703
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "organization", configuration);
|
|
85704
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
85705
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
85706
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
85707
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
85708
|
+
return {
|
|
85709
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
85710
|
+
options: localVarRequestOptions,
|
|
85711
|
+
};
|
|
85712
|
+
}),
|
|
85679
85713
|
/**
|
|
85680
85714
|
* Toggles the specified payment integration, identified by integrationId, to be the organization\'s default payment integration, requiring update permission on the org resource.
|
|
85681
85715
|
* @summary Set an organization payment integration as default
|
|
@@ -85885,12 +85919,28 @@ const OrganizationPaymentsApiFp = function (configuration) {
|
|
|
85885
85919
|
* @param {*} [options] Override http request option.
|
|
85886
85920
|
* @throws {RequiredError}
|
|
85887
85921
|
*/
|
|
85888
|
-
|
|
85922
|
+
refundPayment(paymentId, refundLineItem, eventId, options) {
|
|
85889
85923
|
return __awaiter(this, void 0, void 0, function* () {
|
|
85890
85924
|
var _a, _b, _c;
|
|
85891
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.
|
|
85925
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.refundPayment(paymentId, refundLineItem, eventId, options);
|
|
85892
85926
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
85893
|
-
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['OrganizationPaymentsApi.
|
|
85927
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['OrganizationPaymentsApi.refundPayment']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
85928
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
85929
|
+
});
|
|
85930
|
+
},
|
|
85931
|
+
/**
|
|
85932
|
+
* Queues a receipt email to the account on the payment, itemized with every line item and net of any refunds, for an attendee who needs one for tax or reimbursement purposes; only captured charges are eligible, and requires read and update permissions on payments.
|
|
85933
|
+
* @summary Email a receipt for a payment
|
|
85934
|
+
* @param {string} paymentId The payment identifier
|
|
85935
|
+
* @param {*} [options] Override http request option.
|
|
85936
|
+
* @throws {RequiredError}
|
|
85937
|
+
*/
|
|
85938
|
+
sendPaymentReceipt(paymentId, options) {
|
|
85939
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
85940
|
+
var _a, _b, _c;
|
|
85941
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.sendPaymentReceipt(paymentId, options);
|
|
85942
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
85943
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['OrganizationPaymentsApi.sendPaymentReceipt']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
85894
85944
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
85895
85945
|
});
|
|
85896
85946
|
},
|
|
@@ -86009,12 +86059,22 @@ const OrganizationPaymentsApiFactory = function (configuration, basePath, axios)
|
|
|
86009
86059
|
/**
|
|
86010
86060
|
* Issues a refund for one or more line items on the specified payment, identified by paymentId, requiring update permission on the payments resource; at least one line item with a positive amount must be provided.
|
|
86011
86061
|
* @summary Refund line items on a payment
|
|
86012
|
-
* @param {
|
|
86062
|
+
* @param {OrganizationPaymentsApiRefundPaymentRequest} requestParameters Request parameters.
|
|
86063
|
+
* @param {*} [options] Override http request option.
|
|
86064
|
+
* @throws {RequiredError}
|
|
86065
|
+
*/
|
|
86066
|
+
refundPayment(requestParameters, options) {
|
|
86067
|
+
return localVarFp.refundPayment(requestParameters.paymentId, requestParameters.refundLineItem, requestParameters.eventId, options).then((request) => request(axios, basePath));
|
|
86068
|
+
},
|
|
86069
|
+
/**
|
|
86070
|
+
* Queues a receipt email to the account on the payment, itemized with every line item and net of any refunds, for an attendee who needs one for tax or reimbursement purposes; only captured charges are eligible, and requires read and update permissions on payments.
|
|
86071
|
+
* @summary Email a receipt for a payment
|
|
86072
|
+
* @param {OrganizationPaymentsApiSendPaymentReceiptRequest} requestParameters Request parameters.
|
|
86013
86073
|
* @param {*} [options] Override http request option.
|
|
86014
86074
|
* @throws {RequiredError}
|
|
86015
86075
|
*/
|
|
86016
|
-
|
|
86017
|
-
return localVarFp.
|
|
86076
|
+
sendPaymentReceipt(requestParameters, options) {
|
|
86077
|
+
return localVarFp.sendPaymentReceipt(requestParameters.paymentId, options).then((request) => request(axios, basePath));
|
|
86018
86078
|
},
|
|
86019
86079
|
/**
|
|
86020
86080
|
* Toggles the specified payment integration, identified by integrationId, to be the organization\'s default payment integration, requiring update permission on the org resource.
|
|
@@ -86116,12 +86176,22 @@ class OrganizationPaymentsApi extends base_1.BaseAPI {
|
|
|
86116
86176
|
/**
|
|
86117
86177
|
* Issues a refund for one or more line items on the specified payment, identified by paymentId, requiring update permission on the payments resource; at least one line item with a positive amount must be provided.
|
|
86118
86178
|
* @summary Refund line items on a payment
|
|
86119
|
-
* @param {
|
|
86179
|
+
* @param {OrganizationPaymentsApiRefundPaymentRequest} requestParameters Request parameters.
|
|
86180
|
+
* @param {*} [options] Override http request option.
|
|
86181
|
+
* @throws {RequiredError}
|
|
86182
|
+
*/
|
|
86183
|
+
refundPayment(requestParameters, options) {
|
|
86184
|
+
return (0, exports.OrganizationPaymentsApiFp)(this.configuration).refundPayment(requestParameters.paymentId, requestParameters.refundLineItem, requestParameters.eventId, options).then((request) => request(this.axios, this.basePath));
|
|
86185
|
+
}
|
|
86186
|
+
/**
|
|
86187
|
+
* Queues a receipt email to the account on the payment, itemized with every line item and net of any refunds, for an attendee who needs one for tax or reimbursement purposes; only captured charges are eligible, and requires read and update permissions on payments.
|
|
86188
|
+
* @summary Email a receipt for a payment
|
|
86189
|
+
* @param {OrganizationPaymentsApiSendPaymentReceiptRequest} requestParameters Request parameters.
|
|
86120
86190
|
* @param {*} [options] Override http request option.
|
|
86121
86191
|
* @throws {RequiredError}
|
|
86122
86192
|
*/
|
|
86123
|
-
|
|
86124
|
-
return (0, exports.OrganizationPaymentsApiFp)(this.configuration).
|
|
86193
|
+
sendPaymentReceipt(requestParameters, options) {
|
|
86194
|
+
return (0, exports.OrganizationPaymentsApiFp)(this.configuration).sendPaymentReceipt(requestParameters.paymentId, options).then((request) => request(this.axios, this.basePath));
|
|
86125
86195
|
}
|
|
86126
86196
|
/**
|
|
86127
86197
|
* Toggles the specified payment integration, identified by integrationId, to be the organization\'s default payment integration, requiring update permission on the org resource.
|
package/dist/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.3.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/base.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Connected Admin API
|
|
6
6
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 10.
|
|
8
|
+
* The version of the OpenAPI document: 10.3.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/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.3.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/common.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Connected Admin API
|
|
6
6
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 10.
|
|
8
|
+
* The version of the OpenAPI document: 10.3.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/configuration.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.3.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/configuration.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.3.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Connected Admin API
|
|
3
3
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 10.
|
|
5
|
+
* The version of the OpenAPI document: 10.3.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -67717,7 +67717,15 @@ export declare const OrganizationPaymentsApiAxiosParamCreator: (configuration?:
|
|
|
67717
67717
|
* @param {*} [options] Override http request option.
|
|
67718
67718
|
* @throws {RequiredError}
|
|
67719
67719
|
*/
|
|
67720
|
-
|
|
67720
|
+
refundPayment: (paymentId: string, refundLineItem: Array<RefundLineItem>, eventId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
67721
|
+
/**
|
|
67722
|
+
* Queues a receipt email to the account on the payment, itemized with every line item and net of any refunds, for an attendee who needs one for tax or reimbursement purposes; only captured charges are eligible, and requires read and update permissions on payments.
|
|
67723
|
+
* @summary Email a receipt for a payment
|
|
67724
|
+
* @param {string} paymentId The payment identifier
|
|
67725
|
+
* @param {*} [options] Override http request option.
|
|
67726
|
+
* @throws {RequiredError}
|
|
67727
|
+
*/
|
|
67728
|
+
sendPaymentReceipt: (paymentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
67721
67729
|
/**
|
|
67722
67730
|
* Toggles the specified payment integration, identified by integrationId, to be the organization\'s default payment integration, requiring update permission on the org resource.
|
|
67723
67731
|
* @summary Set an organization payment integration as default
|
|
@@ -67811,7 +67819,15 @@ export declare const OrganizationPaymentsApiFp: (configuration?: Configuration)
|
|
|
67811
67819
|
* @param {*} [options] Override http request option.
|
|
67812
67820
|
* @throws {RequiredError}
|
|
67813
67821
|
*/
|
|
67814
|
-
|
|
67822
|
+
refundPayment(paymentId: string, refundLineItem: Array<RefundLineItem>, eventId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPayment200Response>>;
|
|
67823
|
+
/**
|
|
67824
|
+
* Queues a receipt email to the account on the payment, itemized with every line item and net of any refunds, for an attendee who needs one for tax or reimbursement purposes; only captured charges are eligible, and requires read and update permissions on payments.
|
|
67825
|
+
* @summary Email a receipt for a payment
|
|
67826
|
+
* @param {string} paymentId The payment identifier
|
|
67827
|
+
* @param {*} [options] Override http request option.
|
|
67828
|
+
* @throws {RequiredError}
|
|
67829
|
+
*/
|
|
67830
|
+
sendPaymentReceipt(paymentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>>;
|
|
67815
67831
|
/**
|
|
67816
67832
|
* Toggles the specified payment integration, identified by integrationId, to be the organization\'s default payment integration, requiring update permission on the org resource.
|
|
67817
67833
|
* @summary Set an organization payment integration as default
|
|
@@ -67893,11 +67909,19 @@ export declare const OrganizationPaymentsApiFactory: (configuration?: Configurat
|
|
|
67893
67909
|
/**
|
|
67894
67910
|
* Issues a refund for one or more line items on the specified payment, identified by paymentId, requiring update permission on the payments resource; at least one line item with a positive amount must be provided.
|
|
67895
67911
|
* @summary Refund line items on a payment
|
|
67896
|
-
* @param {
|
|
67912
|
+
* @param {OrganizationPaymentsApiRefundPaymentRequest} requestParameters Request parameters.
|
|
67897
67913
|
* @param {*} [options] Override http request option.
|
|
67898
67914
|
* @throws {RequiredError}
|
|
67899
67915
|
*/
|
|
67900
|
-
|
|
67916
|
+
refundPayment(requestParameters: OrganizationPaymentsApiRefundPaymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPayment200Response>;
|
|
67917
|
+
/**
|
|
67918
|
+
* Queues a receipt email to the account on the payment, itemized with every line item and net of any refunds, for an attendee who needs one for tax or reimbursement purposes; only captured charges are eligible, and requires read and update permissions on payments.
|
|
67919
|
+
* @summary Email a receipt for a payment
|
|
67920
|
+
* @param {OrganizationPaymentsApiSendPaymentReceiptRequest} requestParameters Request parameters.
|
|
67921
|
+
* @param {*} [options] Override http request option.
|
|
67922
|
+
* @throws {RequiredError}
|
|
67923
|
+
*/
|
|
67924
|
+
sendPaymentReceipt(requestParameters: OrganizationPaymentsApiSendPaymentReceiptRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response>;
|
|
67901
67925
|
/**
|
|
67902
67926
|
* Toggles the specified payment integration, identified by integrationId, to be the organization\'s default payment integration, requiring update permission on the org resource.
|
|
67903
67927
|
* @summary Set an organization payment integration as default
|
|
@@ -68000,9 +68024,9 @@ export interface OrganizationPaymentsApiGetPaymentsRequest {
|
|
|
68000
68024
|
readonly search?: string;
|
|
68001
68025
|
}
|
|
68002
68026
|
/**
|
|
68003
|
-
* Request parameters for
|
|
68027
|
+
* Request parameters for refundPayment operation in OrganizationPaymentsApi.
|
|
68004
68028
|
*/
|
|
68005
|
-
export interface
|
|
68029
|
+
export interface OrganizationPaymentsApiRefundPaymentRequest {
|
|
68006
68030
|
/**
|
|
68007
68031
|
* The payment identifier
|
|
68008
68032
|
*/
|
|
@@ -68013,6 +68037,15 @@ export interface OrganizationPaymentsApiRefundOrganizationPaymentRequest {
|
|
|
68013
68037
|
*/
|
|
68014
68038
|
readonly eventId?: string;
|
|
68015
68039
|
}
|
|
68040
|
+
/**
|
|
68041
|
+
* Request parameters for sendPaymentReceipt operation in OrganizationPaymentsApi.
|
|
68042
|
+
*/
|
|
68043
|
+
export interface OrganizationPaymentsApiSendPaymentReceiptRequest {
|
|
68044
|
+
/**
|
|
68045
|
+
* The payment identifier
|
|
68046
|
+
*/
|
|
68047
|
+
readonly paymentId: string;
|
|
68048
|
+
}
|
|
68016
68049
|
/**
|
|
68017
68050
|
* Request parameters for toggleOrganizationPaymentIntegration operation in OrganizationPaymentsApi.
|
|
68018
68051
|
*/
|
|
@@ -68095,11 +68128,19 @@ export declare class OrganizationPaymentsApi extends BaseAPI {
|
|
|
68095
68128
|
/**
|
|
68096
68129
|
* Issues a refund for one or more line items on the specified payment, identified by paymentId, requiring update permission on the payments resource; at least one line item with a positive amount must be provided.
|
|
68097
68130
|
* @summary Refund line items on a payment
|
|
68098
|
-
* @param {
|
|
68131
|
+
* @param {OrganizationPaymentsApiRefundPaymentRequest} requestParameters Request parameters.
|
|
68132
|
+
* @param {*} [options] Override http request option.
|
|
68133
|
+
* @throws {RequiredError}
|
|
68134
|
+
*/
|
|
68135
|
+
refundPayment(requestParameters: OrganizationPaymentsApiRefundPaymentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPayment200Response, any, {}>>;
|
|
68136
|
+
/**
|
|
68137
|
+
* Queues a receipt email to the account on the payment, itemized with every line item and net of any refunds, for an attendee who needs one for tax or reimbursement purposes; only captured charges are eligible, and requires read and update permissions on payments.
|
|
68138
|
+
* @summary Email a receipt for a payment
|
|
68139
|
+
* @param {OrganizationPaymentsApiSendPaymentReceiptRequest} requestParameters Request parameters.
|
|
68099
68140
|
* @param {*} [options] Override http request option.
|
|
68100
68141
|
* @throws {RequiredError}
|
|
68101
68142
|
*/
|
|
68102
|
-
|
|
68143
|
+
sendPaymentReceipt(requestParameters: OrganizationPaymentsApiSendPaymentReceiptRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAccountInvitations200Response, any, {}>>;
|
|
68103
68144
|
/**
|
|
68104
68145
|
* Toggles the specified payment integration, identified by integrationId, to be the organization\'s default payment integration, requiring update permission on the org resource.
|
|
68105
68146
|
* @summary Set an organization payment integration as default
|
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.3.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -85032,11 +85032,11 @@ export const OrganizationPaymentsApiAxiosParamCreator = function (configuration)
|
|
|
85032
85032
|
* @param {*} [options] Override http request option.
|
|
85033
85033
|
* @throws {RequiredError}
|
|
85034
85034
|
*/
|
|
85035
|
-
|
|
85035
|
+
refundPayment: (paymentId_1, refundLineItem_1, eventId_1, ...args_1) => __awaiter(this, [paymentId_1, refundLineItem_1, eventId_1, ...args_1], void 0, function* (paymentId, refundLineItem, eventId, options = {}) {
|
|
85036
85036
|
// verify required parameter 'paymentId' is not null or undefined
|
|
85037
|
-
assertParamExists('
|
|
85037
|
+
assertParamExists('refundPayment', 'paymentId', paymentId);
|
|
85038
85038
|
// verify required parameter 'refundLineItem' is not null or undefined
|
|
85039
|
-
assertParamExists('
|
|
85039
|
+
assertParamExists('refundPayment', 'refundLineItem', refundLineItem);
|
|
85040
85040
|
const localVarPath = `/payments/{paymentId}/refund`
|
|
85041
85041
|
.replace(`{${"paymentId"}}`, encodeURIComponent(String(paymentId)));
|
|
85042
85042
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -85066,6 +85066,40 @@ export const OrganizationPaymentsApiAxiosParamCreator = function (configuration)
|
|
|
85066
85066
|
options: localVarRequestOptions,
|
|
85067
85067
|
};
|
|
85068
85068
|
}),
|
|
85069
|
+
/**
|
|
85070
|
+
* Queues a receipt email to the account on the payment, itemized with every line item and net of any refunds, for an attendee who needs one for tax or reimbursement purposes; only captured charges are eligible, and requires read and update permissions on payments.
|
|
85071
|
+
* @summary Email a receipt for a payment
|
|
85072
|
+
* @param {string} paymentId The payment identifier
|
|
85073
|
+
* @param {*} [options] Override http request option.
|
|
85074
|
+
* @throws {RequiredError}
|
|
85075
|
+
*/
|
|
85076
|
+
sendPaymentReceipt: (paymentId_1, ...args_1) => __awaiter(this, [paymentId_1, ...args_1], void 0, function* (paymentId, options = {}) {
|
|
85077
|
+
// verify required parameter 'paymentId' is not null or undefined
|
|
85078
|
+
assertParamExists('sendPaymentReceipt', 'paymentId', paymentId);
|
|
85079
|
+
const localVarPath = `/payments/{paymentId}/receipt`
|
|
85080
|
+
.replace(`{${"paymentId"}}`, encodeURIComponent(String(paymentId)));
|
|
85081
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
85082
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
85083
|
+
let baseOptions;
|
|
85084
|
+
if (configuration) {
|
|
85085
|
+
baseOptions = configuration.baseOptions;
|
|
85086
|
+
}
|
|
85087
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
85088
|
+
const localVarHeaderParameter = {};
|
|
85089
|
+
const localVarQueryParameter = {};
|
|
85090
|
+
// authentication ApiKeyAuth required
|
|
85091
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
85092
|
+
// authentication OrganizationId required
|
|
85093
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
85094
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
85095
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
85096
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
85097
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
85098
|
+
return {
|
|
85099
|
+
url: toPathString(localVarUrlObj),
|
|
85100
|
+
options: localVarRequestOptions,
|
|
85101
|
+
};
|
|
85102
|
+
}),
|
|
85069
85103
|
/**
|
|
85070
85104
|
* Toggles the specified payment integration, identified by integrationId, to be the organization\'s default payment integration, requiring update permission on the org resource.
|
|
85071
85105
|
* @summary Set an organization payment integration as default
|
|
@@ -85274,12 +85308,28 @@ export const OrganizationPaymentsApiFp = function (configuration) {
|
|
|
85274
85308
|
* @param {*} [options] Override http request option.
|
|
85275
85309
|
* @throws {RequiredError}
|
|
85276
85310
|
*/
|
|
85277
|
-
|
|
85311
|
+
refundPayment(paymentId, refundLineItem, eventId, options) {
|
|
85278
85312
|
return __awaiter(this, void 0, void 0, function* () {
|
|
85279
85313
|
var _a, _b, _c;
|
|
85280
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.
|
|
85314
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.refundPayment(paymentId, refundLineItem, eventId, options);
|
|
85281
85315
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
85282
|
-
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['OrganizationPaymentsApi.
|
|
85316
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['OrganizationPaymentsApi.refundPayment']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
85317
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
85318
|
+
});
|
|
85319
|
+
},
|
|
85320
|
+
/**
|
|
85321
|
+
* Queues a receipt email to the account on the payment, itemized with every line item and net of any refunds, for an attendee who needs one for tax or reimbursement purposes; only captured charges are eligible, and requires read and update permissions on payments.
|
|
85322
|
+
* @summary Email a receipt for a payment
|
|
85323
|
+
* @param {string} paymentId The payment identifier
|
|
85324
|
+
* @param {*} [options] Override http request option.
|
|
85325
|
+
* @throws {RequiredError}
|
|
85326
|
+
*/
|
|
85327
|
+
sendPaymentReceipt(paymentId, options) {
|
|
85328
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
85329
|
+
var _a, _b, _c;
|
|
85330
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.sendPaymentReceipt(paymentId, options);
|
|
85331
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
85332
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['OrganizationPaymentsApi.sendPaymentReceipt']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
85283
85333
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
85284
85334
|
});
|
|
85285
85335
|
},
|
|
@@ -85397,12 +85447,22 @@ export const OrganizationPaymentsApiFactory = function (configuration, basePath,
|
|
|
85397
85447
|
/**
|
|
85398
85448
|
* Issues a refund for one or more line items on the specified payment, identified by paymentId, requiring update permission on the payments resource; at least one line item with a positive amount must be provided.
|
|
85399
85449
|
* @summary Refund line items on a payment
|
|
85400
|
-
* @param {
|
|
85450
|
+
* @param {OrganizationPaymentsApiRefundPaymentRequest} requestParameters Request parameters.
|
|
85451
|
+
* @param {*} [options] Override http request option.
|
|
85452
|
+
* @throws {RequiredError}
|
|
85453
|
+
*/
|
|
85454
|
+
refundPayment(requestParameters, options) {
|
|
85455
|
+
return localVarFp.refundPayment(requestParameters.paymentId, requestParameters.refundLineItem, requestParameters.eventId, options).then((request) => request(axios, basePath));
|
|
85456
|
+
},
|
|
85457
|
+
/**
|
|
85458
|
+
* Queues a receipt email to the account on the payment, itemized with every line item and net of any refunds, for an attendee who needs one for tax or reimbursement purposes; only captured charges are eligible, and requires read and update permissions on payments.
|
|
85459
|
+
* @summary Email a receipt for a payment
|
|
85460
|
+
* @param {OrganizationPaymentsApiSendPaymentReceiptRequest} requestParameters Request parameters.
|
|
85401
85461
|
* @param {*} [options] Override http request option.
|
|
85402
85462
|
* @throws {RequiredError}
|
|
85403
85463
|
*/
|
|
85404
|
-
|
|
85405
|
-
return localVarFp.
|
|
85464
|
+
sendPaymentReceipt(requestParameters, options) {
|
|
85465
|
+
return localVarFp.sendPaymentReceipt(requestParameters.paymentId, options).then((request) => request(axios, basePath));
|
|
85406
85466
|
},
|
|
85407
85467
|
/**
|
|
85408
85468
|
* Toggles the specified payment integration, identified by integrationId, to be the organization\'s default payment integration, requiring update permission on the org resource.
|
|
@@ -85503,12 +85563,22 @@ export class OrganizationPaymentsApi extends BaseAPI {
|
|
|
85503
85563
|
/**
|
|
85504
85564
|
* Issues a refund for one or more line items on the specified payment, identified by paymentId, requiring update permission on the payments resource; at least one line item with a positive amount must be provided.
|
|
85505
85565
|
* @summary Refund line items on a payment
|
|
85506
|
-
* @param {
|
|
85566
|
+
* @param {OrganizationPaymentsApiRefundPaymentRequest} requestParameters Request parameters.
|
|
85567
|
+
* @param {*} [options] Override http request option.
|
|
85568
|
+
* @throws {RequiredError}
|
|
85569
|
+
*/
|
|
85570
|
+
refundPayment(requestParameters, options) {
|
|
85571
|
+
return OrganizationPaymentsApiFp(this.configuration).refundPayment(requestParameters.paymentId, requestParameters.refundLineItem, requestParameters.eventId, options).then((request) => request(this.axios, this.basePath));
|
|
85572
|
+
}
|
|
85573
|
+
/**
|
|
85574
|
+
* Queues a receipt email to the account on the payment, itemized with every line item and net of any refunds, for an attendee who needs one for tax or reimbursement purposes; only captured charges are eligible, and requires read and update permissions on payments.
|
|
85575
|
+
* @summary Email a receipt for a payment
|
|
85576
|
+
* @param {OrganizationPaymentsApiSendPaymentReceiptRequest} requestParameters Request parameters.
|
|
85507
85577
|
* @param {*} [options] Override http request option.
|
|
85508
85578
|
* @throws {RequiredError}
|
|
85509
85579
|
*/
|
|
85510
|
-
|
|
85511
|
-
return OrganizationPaymentsApiFp(this.configuration).
|
|
85580
|
+
sendPaymentReceipt(requestParameters, options) {
|
|
85581
|
+
return OrganizationPaymentsApiFp(this.configuration).sendPaymentReceipt(requestParameters.paymentId, options).then((request) => request(this.axios, this.basePath));
|
|
85512
85582
|
}
|
|
85513
85583
|
/**
|
|
85514
85584
|
* Toggles the specified payment integration, identified by integrationId, to be the organization\'s default payment integration, requiring update permission on the org resource.
|
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.3.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.3.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.3.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.3.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.3.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.3.0
|
|
7
7
|
*
|
|
8
8
|
*
|
|
9
9
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -11,7 +11,8 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
11
11
|
|[**getPayment**](#getpayment) | **GET** /payments/{paymentId} | Get a payment|
|
|
12
12
|
|[**getPaymentTaxMetadata**](#getpaymenttaxmetadata) | **GET** /payments/{paymentId}/tax-metadata | Get a payment\'s tax metadata|
|
|
13
13
|
|[**getPayments**](#getpayments) | **GET** /payments | List an organization\'s payments|
|
|
14
|
-
|[**
|
|
14
|
+
|[**refundPayment**](#refundpayment) | **POST** /payments/{paymentId}/refund | Refund line items on a payment|
|
|
15
|
+
|[**sendPaymentReceipt**](#sendpaymentreceipt) | **POST** /payments/{paymentId}/receipt | Email a receipt for a payment|
|
|
15
16
|
|[**toggleOrganizationPaymentIntegration**](#toggleorganizationpaymentintegration) | **PUT** /organization/payment/{integrationId}/toggle | Set an organization payment integration as default|
|
|
16
17
|
|[**updateOrganizationPaymentIntegration**](#updateorganizationpaymentintegration) | **PUT** /organization/payment/{integrationId} | Update an organization payment integration|
|
|
17
18
|
|
|
@@ -391,8 +392,8 @@ const { status, data } = await apiInstance.getPayments(
|
|
|
391
392
|
|
|
392
393
|
[[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)
|
|
393
394
|
|
|
394
|
-
# **
|
|
395
|
-
> GetPayment200Response
|
|
395
|
+
# **refundPayment**
|
|
396
|
+
> GetPayment200Response refundPayment(refundLineItem)
|
|
396
397
|
|
|
397
398
|
Issues a refund for one or more line items on the specified payment, identified by paymentId, requiring update permission on the payments resource; at least one line item with a positive amount must be provided.
|
|
398
399
|
|
|
@@ -411,7 +412,7 @@ let paymentId: string; //The payment identifier (default to undefined)
|
|
|
411
412
|
let refundLineItem: Array<RefundLineItem>; //
|
|
412
413
|
let eventId: string; //Filter by eventId (optional) (default to undefined)
|
|
413
414
|
|
|
414
|
-
const { status, data } = await apiInstance.
|
|
415
|
+
const { status, data } = await apiInstance.refundPayment(
|
|
415
416
|
paymentId,
|
|
416
417
|
refundLineItem,
|
|
417
418
|
eventId
|
|
@@ -441,6 +442,57 @@ const { status, data } = await apiInstance.refundOrganizationPayment(
|
|
|
441
442
|
- **Accept**: application/json
|
|
442
443
|
|
|
443
444
|
|
|
445
|
+
### HTTP response details
|
|
446
|
+
| Status code | Description | Response headers |
|
|
447
|
+
|-------------|-------------|------------------|
|
|
448
|
+
|**200** | Successful response | - |
|
|
449
|
+
|
|
450
|
+
[[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)
|
|
451
|
+
|
|
452
|
+
# **sendPaymentReceipt**
|
|
453
|
+
> CreateAccountInvitations200Response sendPaymentReceipt()
|
|
454
|
+
|
|
455
|
+
Queues a receipt email to the account on the payment, itemized with every line item and net of any refunds, for an attendee who needs one for tax or reimbursement purposes; only captured charges are eligible, and requires read and update permissions on payments.
|
|
456
|
+
|
|
457
|
+
### Example
|
|
458
|
+
|
|
459
|
+
```typescript
|
|
460
|
+
import {
|
|
461
|
+
OrganizationPaymentsApi,
|
|
462
|
+
Configuration
|
|
463
|
+
} from '@connectedxm/admin-sdk';
|
|
464
|
+
|
|
465
|
+
const configuration = new Configuration();
|
|
466
|
+
const apiInstance = new OrganizationPaymentsApi(configuration);
|
|
467
|
+
|
|
468
|
+
let paymentId: string; //The payment identifier (default to undefined)
|
|
469
|
+
|
|
470
|
+
const { status, data } = await apiInstance.sendPaymentReceipt(
|
|
471
|
+
paymentId
|
|
472
|
+
);
|
|
473
|
+
```
|
|
474
|
+
|
|
475
|
+
### Parameters
|
|
476
|
+
|
|
477
|
+
|Name | Type | Description | Notes|
|
|
478
|
+
|------------- | ------------- | ------------- | -------------|
|
|
479
|
+
| **paymentId** | [**string**] | The payment identifier | defaults to undefined|
|
|
480
|
+
|
|
481
|
+
|
|
482
|
+
### Return type
|
|
483
|
+
|
|
484
|
+
**CreateAccountInvitations200Response**
|
|
485
|
+
|
|
486
|
+
### Authorization
|
|
487
|
+
|
|
488
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
489
|
+
|
|
490
|
+
### HTTP request headers
|
|
491
|
+
|
|
492
|
+
- **Content-Type**: Not defined
|
|
493
|
+
- **Accept**: application/json
|
|
494
|
+
|
|
495
|
+
|
|
444
496
|
### HTTP response details
|
|
445
497
|
| Status code | Description | Response headers |
|
|
446
498
|
|-------------|-------------|------------------|
|