@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/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.7.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.7.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.7.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.7.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1931,6 +1931,79 @@ export interface BasePaymentIntegration {
|
|
|
1931
1931
|
'type': PaymentIntegrationType;
|
|
1932
1932
|
'name': string;
|
|
1933
1933
|
}
|
|
1934
|
+
export interface BasePaymentIntent {
|
|
1935
|
+
'id': string;
|
|
1936
|
+
'source': PaymentIntentSource;
|
|
1937
|
+
'integrationId': number;
|
|
1938
|
+
'accountId': string;
|
|
1939
|
+
'description': string;
|
|
1940
|
+
'referenceId': string;
|
|
1941
|
+
'currency': string;
|
|
1942
|
+
'metadata': object;
|
|
1943
|
+
'eventId': string | null;
|
|
1944
|
+
'registrationId': string | null;
|
|
1945
|
+
'sessionId': string | null;
|
|
1946
|
+
'passId': string | null;
|
|
1947
|
+
'passTypeId': string | null;
|
|
1948
|
+
'placeId': string | null;
|
|
1949
|
+
'spaceId': string | null;
|
|
1950
|
+
'couponId': string | null;
|
|
1951
|
+
'invoiceId': string | null;
|
|
1952
|
+
'seriesId': string | null;
|
|
1953
|
+
'address1': string | null;
|
|
1954
|
+
'address2': string | null;
|
|
1955
|
+
'city': string | null;
|
|
1956
|
+
'state': string | null;
|
|
1957
|
+
'country': string | null;
|
|
1958
|
+
'zip': string | null;
|
|
1959
|
+
'locationAddress1': string | null;
|
|
1960
|
+
'locationAddress2': string | null;
|
|
1961
|
+
'locationCity': string | null;
|
|
1962
|
+
'locationState': string | null;
|
|
1963
|
+
'locationCountry': string | null;
|
|
1964
|
+
'locationZip': string | null;
|
|
1965
|
+
'salesTax': number;
|
|
1966
|
+
'salesTaxRate': string | null;
|
|
1967
|
+
'deferredAmount': number | null;
|
|
1968
|
+
'deferredDueDate': string | null;
|
|
1969
|
+
'createdAt': string;
|
|
1970
|
+
'lineItems': Array<BasePaymentIntentLineItem>;
|
|
1971
|
+
'coupon': BaseCoupon | null;
|
|
1972
|
+
'integration': BasePaymentIntentIntegration | null;
|
|
1973
|
+
'taxIntegration': BasePaymentIntentTaxIntegration | null;
|
|
1974
|
+
}
|
|
1975
|
+
export interface BasePaymentIntentIntegration {
|
|
1976
|
+
'type': PaymentIntegrationType;
|
|
1977
|
+
'connectionId': string | null;
|
|
1978
|
+
}
|
|
1979
|
+
export interface BasePaymentIntentLineItem {
|
|
1980
|
+
'id': string;
|
|
1981
|
+
'type': PaymentLineItemType;
|
|
1982
|
+
'parent': string | null;
|
|
1983
|
+
'name': string;
|
|
1984
|
+
'quantity': number;
|
|
1985
|
+
'amount': number;
|
|
1986
|
+
'discount': number;
|
|
1987
|
+
'deferred': number;
|
|
1988
|
+
'salesTax': number;
|
|
1989
|
+
'taxCode': string | null;
|
|
1990
|
+
'taxIncluded': boolean;
|
|
1991
|
+
'taxLocation': TaxLocationType;
|
|
1992
|
+
'passId': string | null;
|
|
1993
|
+
'packageId': string | null;
|
|
1994
|
+
'passAddOnId': string | null;
|
|
1995
|
+
'reservationId': string | null;
|
|
1996
|
+
'accessId': string | null;
|
|
1997
|
+
'invoiceId': string | null;
|
|
1998
|
+
'bookingId': string | null;
|
|
1999
|
+
'couponId': string | null;
|
|
2000
|
+
'seriesRegistrationId': string | null;
|
|
2001
|
+
'createdAt': string;
|
|
2002
|
+
}
|
|
2003
|
+
export interface BasePaymentIntentTaxIntegration {
|
|
2004
|
+
'type': string;
|
|
2005
|
+
'connectionId': string | null;
|
|
2006
|
+
}
|
|
1934
2007
|
export interface BasePaymentLineItem {
|
|
1935
2008
|
'id': string;
|
|
1936
2009
|
'type': PaymentLineItemType;
|
|
@@ -6391,6 +6464,15 @@ export interface GetAccountNotificationPreferences200Response {
|
|
|
6391
6464
|
export declare enum GetAccountNotificationPreferences200ResponseStatusEnum {
|
|
6392
6465
|
Ok = "ok"
|
|
6393
6466
|
}
|
|
6467
|
+
export interface GetAccountPaymentIntents200Response {
|
|
6468
|
+
'status': GetAccountPaymentIntents200ResponseStatusEnum;
|
|
6469
|
+
'message': string;
|
|
6470
|
+
'data': Array<PaymentIntent>;
|
|
6471
|
+
'count'?: number;
|
|
6472
|
+
}
|
|
6473
|
+
export declare enum GetAccountPaymentIntents200ResponseStatusEnum {
|
|
6474
|
+
Ok = "ok"
|
|
6475
|
+
}
|
|
6394
6476
|
export interface GetAccountPayments200Response {
|
|
6395
6477
|
'status': GetAccountPayments200ResponseStatusEnum;
|
|
6396
6478
|
'message': string;
|
|
@@ -8440,6 +8522,14 @@ export interface GetPayment200Response {
|
|
|
8440
8522
|
export declare enum GetPayment200ResponseStatusEnum {
|
|
8441
8523
|
Ok = "ok"
|
|
8442
8524
|
}
|
|
8525
|
+
export interface GetPaymentIntent200Response {
|
|
8526
|
+
'status': GetPaymentIntent200ResponseStatusEnum;
|
|
8527
|
+
'message': string;
|
|
8528
|
+
'data': PaymentIntent;
|
|
8529
|
+
}
|
|
8530
|
+
export declare enum GetPaymentIntent200ResponseStatusEnum {
|
|
8531
|
+
Ok = "ok"
|
|
8532
|
+
}
|
|
8443
8533
|
export interface GetPaymentTaxMetadata200Response {
|
|
8444
8534
|
'status': GetPaymentTaxMetadata200ResponseStatusEnum;
|
|
8445
8535
|
'message': string;
|
|
@@ -10656,6 +10746,67 @@ export declare enum PaymentIntegrationType {
|
|
|
10656
10746
|
Authorizenet = "authorizenet",
|
|
10657
10747
|
Manual = "manual"
|
|
10658
10748
|
}
|
|
10749
|
+
export interface PaymentIntent {
|
|
10750
|
+
'id': string;
|
|
10751
|
+
'source': PaymentIntentSource;
|
|
10752
|
+
'integrationId': number;
|
|
10753
|
+
'accountId': string;
|
|
10754
|
+
'description': string;
|
|
10755
|
+
'referenceId': string;
|
|
10756
|
+
'currency': string;
|
|
10757
|
+
'metadata': object;
|
|
10758
|
+
'eventId': string | null;
|
|
10759
|
+
'registrationId': string | null;
|
|
10760
|
+
'sessionId': string | null;
|
|
10761
|
+
'passId': string | null;
|
|
10762
|
+
'passTypeId': string | null;
|
|
10763
|
+
'placeId': string | null;
|
|
10764
|
+
'spaceId': string | null;
|
|
10765
|
+
'couponId': string | null;
|
|
10766
|
+
'invoiceId': string | null;
|
|
10767
|
+
'seriesId': string | null;
|
|
10768
|
+
'address1': string | null;
|
|
10769
|
+
'address2': string | null;
|
|
10770
|
+
'city': string | null;
|
|
10771
|
+
'state': string | null;
|
|
10772
|
+
'country': string | null;
|
|
10773
|
+
'zip': string | null;
|
|
10774
|
+
'locationAddress1': string | null;
|
|
10775
|
+
'locationAddress2': string | null;
|
|
10776
|
+
'locationCity': string | null;
|
|
10777
|
+
'locationState': string | null;
|
|
10778
|
+
'locationCountry': string | null;
|
|
10779
|
+
'locationZip': string | null;
|
|
10780
|
+
'salesTax': number;
|
|
10781
|
+
'salesTaxRate': string | null;
|
|
10782
|
+
'deferredAmount': number | null;
|
|
10783
|
+
'deferredDueDate': string | null;
|
|
10784
|
+
'createdAt': string;
|
|
10785
|
+
'lineItems': Array<BasePaymentIntentLineItem>;
|
|
10786
|
+
'coupon': BaseCoupon | null;
|
|
10787
|
+
'integration': BasePaymentIntentIntegration | null;
|
|
10788
|
+
'taxIntegration': BasePaymentIntentTaxIntegration | null;
|
|
10789
|
+
'account': BaseAccount | null;
|
|
10790
|
+
'event': BaseEvent | null;
|
|
10791
|
+
'session': BaseEventSession | null;
|
|
10792
|
+
'registration': BaseEventRegistration | null;
|
|
10793
|
+
'pass': BaseEventPass | null;
|
|
10794
|
+
'passType': BaseEventPassType | null;
|
|
10795
|
+
'place': BaseBookingPlace | null;
|
|
10796
|
+
'space': BaseBookingSpace | null;
|
|
10797
|
+
'invoice': BaseInvoice | null;
|
|
10798
|
+
'series': BaseSeries | null;
|
|
10799
|
+
}
|
|
10800
|
+
export declare enum PaymentIntentSource {
|
|
10801
|
+
Registration = "registration",
|
|
10802
|
+
Invoice = "invoice",
|
|
10803
|
+
Pass = "pass",
|
|
10804
|
+
Coupon = "coupon",
|
|
10805
|
+
Session = "session",
|
|
10806
|
+
Booking = "booking",
|
|
10807
|
+
Series = "series",
|
|
10808
|
+
Exchange = "exchange"
|
|
10809
|
+
}
|
|
10659
10810
|
export interface PaymentLineItem {
|
|
10660
10811
|
'id': string;
|
|
10661
10812
|
'type': PaymentLineItemType;
|
|
@@ -13184,6 +13335,18 @@ export declare const AccountsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
13184
13335
|
* @throws {RequiredError}
|
|
13185
13336
|
*/
|
|
13186
13337
|
getAccountNotificationPreferences: (accountId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
13338
|
+
/**
|
|
13339
|
+
* Returns a paginated list of unpaid checkout payment intents for the given account; requires the `read accounts` and `read payments` permissions.
|
|
13340
|
+
* @summary List an account\'s payment intents
|
|
13341
|
+
* @param {string} accountId The account identifier
|
|
13342
|
+
* @param {number} [page] Page number
|
|
13343
|
+
* @param {number} [pageSize] Number of items per page
|
|
13344
|
+
* @param {string} [orderBy] Field to order by
|
|
13345
|
+
* @param {string} [search] Search query
|
|
13346
|
+
* @param {*} [options] Override http request option.
|
|
13347
|
+
* @throws {RequiredError}
|
|
13348
|
+
*/
|
|
13349
|
+
getAccountPaymentIntents: (accountId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
13187
13350
|
/**
|
|
13188
13351
|
* 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.
|
|
13189
13352
|
* @summary List an account\'s payments
|
|
@@ -13397,6 +13560,18 @@ export declare const AccountsApiFp: (configuration?: Configuration) => {
|
|
|
13397
13560
|
* @throws {RequiredError}
|
|
13398
13561
|
*/
|
|
13399
13562
|
getAccountNotificationPreferences(accountId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountNotificationPreferences200Response>>;
|
|
13563
|
+
/**
|
|
13564
|
+
* Returns a paginated list of unpaid checkout payment intents for the given account; requires the `read accounts` and `read payments` permissions.
|
|
13565
|
+
* @summary List an account\'s payment intents
|
|
13566
|
+
* @param {string} accountId The account identifier
|
|
13567
|
+
* @param {number} [page] Page number
|
|
13568
|
+
* @param {number} [pageSize] Number of items per page
|
|
13569
|
+
* @param {string} [orderBy] Field to order by
|
|
13570
|
+
* @param {string} [search] Search query
|
|
13571
|
+
* @param {*} [options] Override http request option.
|
|
13572
|
+
* @throws {RequiredError}
|
|
13573
|
+
*/
|
|
13574
|
+
getAccountPaymentIntents(accountId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountPaymentIntents200Response>>;
|
|
13400
13575
|
/**
|
|
13401
13576
|
* 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.
|
|
13402
13577
|
* @summary List an account\'s payments
|
|
@@ -13583,6 +13758,14 @@ export declare const AccountsApiFactory: (configuration?: Configuration, basePat
|
|
|
13583
13758
|
* @throws {RequiredError}
|
|
13584
13759
|
*/
|
|
13585
13760
|
getAccountNotificationPreferences(requestParameters: AccountsApiGetAccountNotificationPreferencesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAccountNotificationPreferences200Response>;
|
|
13761
|
+
/**
|
|
13762
|
+
* Returns a paginated list of unpaid checkout payment intents for the given account; requires the `read accounts` and `read payments` permissions.
|
|
13763
|
+
* @summary List an account\'s payment intents
|
|
13764
|
+
* @param {AccountsApiGetAccountPaymentIntentsRequest} requestParameters Request parameters.
|
|
13765
|
+
* @param {*} [options] Override http request option.
|
|
13766
|
+
* @throws {RequiredError}
|
|
13767
|
+
*/
|
|
13768
|
+
getAccountPaymentIntents(requestParameters: AccountsApiGetAccountPaymentIntentsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAccountPaymentIntents200Response>;
|
|
13586
13769
|
/**
|
|
13587
13770
|
* 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.
|
|
13588
13771
|
* @summary List an account\'s payments
|
|
@@ -13859,6 +14042,31 @@ export interface AccountsApiGetAccountNotificationPreferencesRequest {
|
|
|
13859
14042
|
*/
|
|
13860
14043
|
readonly accountId: string;
|
|
13861
14044
|
}
|
|
14045
|
+
/**
|
|
14046
|
+
* Request parameters for getAccountPaymentIntents operation in AccountsApi.
|
|
14047
|
+
*/
|
|
14048
|
+
export interface AccountsApiGetAccountPaymentIntentsRequest {
|
|
14049
|
+
/**
|
|
14050
|
+
* The account identifier
|
|
14051
|
+
*/
|
|
14052
|
+
readonly accountId: string;
|
|
14053
|
+
/**
|
|
14054
|
+
* Page number
|
|
14055
|
+
*/
|
|
14056
|
+
readonly page?: number;
|
|
14057
|
+
/**
|
|
14058
|
+
* Number of items per page
|
|
14059
|
+
*/
|
|
14060
|
+
readonly pageSize?: number;
|
|
14061
|
+
/**
|
|
14062
|
+
* Field to order by
|
|
14063
|
+
*/
|
|
14064
|
+
readonly orderBy?: string;
|
|
14065
|
+
/**
|
|
14066
|
+
* Search query
|
|
14067
|
+
*/
|
|
14068
|
+
readonly search?: string;
|
|
14069
|
+
}
|
|
13862
14070
|
/**
|
|
13863
14071
|
* Request parameters for getAccountPayments operation in AccountsApi.
|
|
13864
14072
|
*/
|
|
@@ -14108,6 +14316,14 @@ export declare class AccountsApi extends BaseAPI {
|
|
|
14108
14316
|
* @throws {RequiredError}
|
|
14109
14317
|
*/
|
|
14110
14318
|
getAccountNotificationPreferences(requestParameters: AccountsApiGetAccountNotificationPreferencesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAccountNotificationPreferences200Response, any, {}>>;
|
|
14319
|
+
/**
|
|
14320
|
+
* Returns a paginated list of unpaid checkout payment intents for the given account; requires the `read accounts` and `read payments` permissions.
|
|
14321
|
+
* @summary List an account\'s payment intents
|
|
14322
|
+
* @param {AccountsApiGetAccountPaymentIntentsRequest} requestParameters Request parameters.
|
|
14323
|
+
* @param {*} [options] Override http request option.
|
|
14324
|
+
* @throws {RequiredError}
|
|
14325
|
+
*/
|
|
14326
|
+
getAccountPaymentIntents(requestParameters: AccountsApiGetAccountPaymentIntentsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAccountPaymentIntents200Response, any, {}>>;
|
|
14111
14327
|
/**
|
|
14112
14328
|
* 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.
|
|
14113
14329
|
* @summary List an account\'s payments
|
|
@@ -67676,6 +67892,14 @@ export declare const OrganizationPaymentsApiAxiosParamCreator: (configuration?:
|
|
|
67676
67892
|
* @throws {RequiredError}
|
|
67677
67893
|
*/
|
|
67678
67894
|
deleteOrganizationPaymentIntegration: (integrationId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
67895
|
+
/**
|
|
67896
|
+
* 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.
|
|
67897
|
+
* @summary Delete a payment intent
|
|
67898
|
+
* @param {string} intentId The intent identifier
|
|
67899
|
+
* @param {*} [options] Override http request option.
|
|
67900
|
+
* @throws {RequiredError}
|
|
67901
|
+
*/
|
|
67902
|
+
deletePaymentIntent: (intentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
67679
67903
|
/**
|
|
67680
67904
|
* 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\".
|
|
67681
67905
|
* @summary Get an organization payment integration
|
|
@@ -67703,6 +67927,25 @@ export declare const OrganizationPaymentsApiAxiosParamCreator: (configuration?:
|
|
|
67703
67927
|
* @throws {RequiredError}
|
|
67704
67928
|
*/
|
|
67705
67929
|
getPayment: (paymentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
67930
|
+
/**
|
|
67931
|
+
* Returns a single unpaid checkout payment intent identified by intent ID; requires \"read\" permission on \"payments\".
|
|
67932
|
+
* @summary Get a payment intent
|
|
67933
|
+
* @param {string} intentId The intent identifier
|
|
67934
|
+
* @param {*} [options] Override http request option.
|
|
67935
|
+
* @throws {RequiredError}
|
|
67936
|
+
*/
|
|
67937
|
+
getPaymentIntent: (intentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
67938
|
+
/**
|
|
67939
|
+
* Returns a paginated list of unpaid checkout payment intents for the organization, searchable by id, source, description, or account; requires \"read\" permission on \"payments\".
|
|
67940
|
+
* @summary List an organization\'s payment intents
|
|
67941
|
+
* @param {number} [page] Page number
|
|
67942
|
+
* @param {number} [pageSize] Number of items per page
|
|
67943
|
+
* @param {string} [orderBy] Field to order by
|
|
67944
|
+
* @param {string} [search] Search query
|
|
67945
|
+
* @param {*} [options] Override http request option.
|
|
67946
|
+
* @throws {RequiredError}
|
|
67947
|
+
*/
|
|
67948
|
+
getPaymentIntents: (page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
67706
67949
|
/**
|
|
67707
67950
|
* 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\".
|
|
67708
67951
|
* @summary Get a payment\'s tax metadata
|
|
@@ -67778,6 +68021,14 @@ export declare const OrganizationPaymentsApiFp: (configuration?: Configuration)
|
|
|
67778
68021
|
* @throws {RequiredError}
|
|
67779
68022
|
*/
|
|
67780
68023
|
deleteOrganizationPaymentIntegration(integrationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SyncAccounts200Response>>;
|
|
68024
|
+
/**
|
|
68025
|
+
* 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.
|
|
68026
|
+
* @summary Delete a payment intent
|
|
68027
|
+
* @param {string} intentId The intent identifier
|
|
68028
|
+
* @param {*} [options] Override http request option.
|
|
68029
|
+
* @throws {RequiredError}
|
|
68030
|
+
*/
|
|
68031
|
+
deletePaymentIntent(intentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>>;
|
|
67781
68032
|
/**
|
|
67782
68033
|
* 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\".
|
|
67783
68034
|
* @summary Get an organization payment integration
|
|
@@ -67805,6 +68056,25 @@ export declare const OrganizationPaymentsApiFp: (configuration?: Configuration)
|
|
|
67805
68056
|
* @throws {RequiredError}
|
|
67806
68057
|
*/
|
|
67807
68058
|
getPayment(paymentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPayment200Response>>;
|
|
68059
|
+
/**
|
|
68060
|
+
* Returns a single unpaid checkout payment intent identified by intent ID; requires \"read\" permission on \"payments\".
|
|
68061
|
+
* @summary Get a payment intent
|
|
68062
|
+
* @param {string} intentId The intent identifier
|
|
68063
|
+
* @param {*} [options] Override http request option.
|
|
68064
|
+
* @throws {RequiredError}
|
|
68065
|
+
*/
|
|
68066
|
+
getPaymentIntent(intentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPaymentIntent200Response>>;
|
|
68067
|
+
/**
|
|
68068
|
+
* Returns a paginated list of unpaid checkout payment intents for the organization, searchable by id, source, description, or account; requires \"read\" permission on \"payments\".
|
|
68069
|
+
* @summary List an organization\'s payment intents
|
|
68070
|
+
* @param {number} [page] Page number
|
|
68071
|
+
* @param {number} [pageSize] Number of items per page
|
|
68072
|
+
* @param {string} [orderBy] Field to order by
|
|
68073
|
+
* @param {string} [search] Search query
|
|
68074
|
+
* @param {*} [options] Override http request option.
|
|
68075
|
+
* @throws {RequiredError}
|
|
68076
|
+
*/
|
|
68077
|
+
getPaymentIntents(page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountPaymentIntents200Response>>;
|
|
67808
68078
|
/**
|
|
67809
68079
|
* 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\".
|
|
67810
68080
|
* @summary Get a payment\'s tax metadata
|
|
@@ -67880,6 +68150,14 @@ export declare const OrganizationPaymentsApiFactory: (configuration?: Configurat
|
|
|
67880
68150
|
* @throws {RequiredError}
|
|
67881
68151
|
*/
|
|
67882
68152
|
deleteOrganizationPaymentIntegration(requestParameters: OrganizationPaymentsApiDeleteOrganizationPaymentIntegrationRequest, options?: RawAxiosRequestConfig): AxiosPromise<SyncAccounts200Response>;
|
|
68153
|
+
/**
|
|
68154
|
+
* 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.
|
|
68155
|
+
* @summary Delete a payment intent
|
|
68156
|
+
* @param {OrganizationPaymentsApiDeletePaymentIntentRequest} requestParameters Request parameters.
|
|
68157
|
+
* @param {*} [options] Override http request option.
|
|
68158
|
+
* @throws {RequiredError}
|
|
68159
|
+
*/
|
|
68160
|
+
deletePaymentIntent(requestParameters: OrganizationPaymentsApiDeletePaymentIntentRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response>;
|
|
67883
68161
|
/**
|
|
67884
68162
|
* 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\".
|
|
67885
68163
|
* @summary Get an organization payment integration
|
|
@@ -67904,6 +68182,22 @@ export declare const OrganizationPaymentsApiFactory: (configuration?: Configurat
|
|
|
67904
68182
|
* @throws {RequiredError}
|
|
67905
68183
|
*/
|
|
67906
68184
|
getPayment(requestParameters: OrganizationPaymentsApiGetPaymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPayment200Response>;
|
|
68185
|
+
/**
|
|
68186
|
+
* Returns a single unpaid checkout payment intent identified by intent ID; requires \"read\" permission on \"payments\".
|
|
68187
|
+
* @summary Get a payment intent
|
|
68188
|
+
* @param {OrganizationPaymentsApiGetPaymentIntentRequest} requestParameters Request parameters.
|
|
68189
|
+
* @param {*} [options] Override http request option.
|
|
68190
|
+
* @throws {RequiredError}
|
|
68191
|
+
*/
|
|
68192
|
+
getPaymentIntent(requestParameters: OrganizationPaymentsApiGetPaymentIntentRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPaymentIntent200Response>;
|
|
68193
|
+
/**
|
|
68194
|
+
* Returns a paginated list of unpaid checkout payment intents for the organization, searchable by id, source, description, or account; requires \"read\" permission on \"payments\".
|
|
68195
|
+
* @summary List an organization\'s payment intents
|
|
68196
|
+
* @param {OrganizationPaymentsApiGetPaymentIntentsRequest} requestParameters Request parameters.
|
|
68197
|
+
* @param {*} [options] Override http request option.
|
|
68198
|
+
* @throws {RequiredError}
|
|
68199
|
+
*/
|
|
68200
|
+
getPaymentIntents(requestParameters?: OrganizationPaymentsApiGetPaymentIntentsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAccountPaymentIntents200Response>;
|
|
67907
68201
|
/**
|
|
67908
68202
|
* 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\".
|
|
67909
68203
|
* @summary Get a payment\'s tax metadata
|
|
@@ -67968,6 +68262,15 @@ export interface OrganizationPaymentsApiDeleteOrganizationPaymentIntegrationRequ
|
|
|
67968
68262
|
*/
|
|
67969
68263
|
readonly integrationId: string;
|
|
67970
68264
|
}
|
|
68265
|
+
/**
|
|
68266
|
+
* Request parameters for deletePaymentIntent operation in OrganizationPaymentsApi.
|
|
68267
|
+
*/
|
|
68268
|
+
export interface OrganizationPaymentsApiDeletePaymentIntentRequest {
|
|
68269
|
+
/**
|
|
68270
|
+
* The intent identifier
|
|
68271
|
+
*/
|
|
68272
|
+
readonly intentId: string;
|
|
68273
|
+
}
|
|
67971
68274
|
/**
|
|
67972
68275
|
* Request parameters for getOrganizationPaymentIntegration operation in OrganizationPaymentsApi.
|
|
67973
68276
|
*/
|
|
@@ -68007,6 +68310,36 @@ export interface OrganizationPaymentsApiGetPaymentRequest {
|
|
|
68007
68310
|
*/
|
|
68008
68311
|
readonly paymentId: string;
|
|
68009
68312
|
}
|
|
68313
|
+
/**
|
|
68314
|
+
* Request parameters for getPaymentIntent operation in OrganizationPaymentsApi.
|
|
68315
|
+
*/
|
|
68316
|
+
export interface OrganizationPaymentsApiGetPaymentIntentRequest {
|
|
68317
|
+
/**
|
|
68318
|
+
* The intent identifier
|
|
68319
|
+
*/
|
|
68320
|
+
readonly intentId: string;
|
|
68321
|
+
}
|
|
68322
|
+
/**
|
|
68323
|
+
* Request parameters for getPaymentIntents operation in OrganizationPaymentsApi.
|
|
68324
|
+
*/
|
|
68325
|
+
export interface OrganizationPaymentsApiGetPaymentIntentsRequest {
|
|
68326
|
+
/**
|
|
68327
|
+
* Page number
|
|
68328
|
+
*/
|
|
68329
|
+
readonly page?: number;
|
|
68330
|
+
/**
|
|
68331
|
+
* Number of items per page
|
|
68332
|
+
*/
|
|
68333
|
+
readonly pageSize?: number;
|
|
68334
|
+
/**
|
|
68335
|
+
* Field to order by
|
|
68336
|
+
*/
|
|
68337
|
+
readonly orderBy?: string;
|
|
68338
|
+
/**
|
|
68339
|
+
* Search query
|
|
68340
|
+
*/
|
|
68341
|
+
readonly search?: string;
|
|
68342
|
+
}
|
|
68010
68343
|
/**
|
|
68011
68344
|
* Request parameters for getPaymentTaxMetadata operation in OrganizationPaymentsApi.
|
|
68012
68345
|
*/
|
|
@@ -68099,6 +68432,14 @@ export declare class OrganizationPaymentsApi extends BaseAPI {
|
|
|
68099
68432
|
* @throws {RequiredError}
|
|
68100
68433
|
*/
|
|
68101
68434
|
deleteOrganizationPaymentIntegration(requestParameters: OrganizationPaymentsApiDeleteOrganizationPaymentIntegrationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SyncAccounts200Response, any, {}>>;
|
|
68435
|
+
/**
|
|
68436
|
+
* 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.
|
|
68437
|
+
* @summary Delete a payment intent
|
|
68438
|
+
* @param {OrganizationPaymentsApiDeletePaymentIntentRequest} requestParameters Request parameters.
|
|
68439
|
+
* @param {*} [options] Override http request option.
|
|
68440
|
+
* @throws {RequiredError}
|
|
68441
|
+
*/
|
|
68442
|
+
deletePaymentIntent(requestParameters: OrganizationPaymentsApiDeletePaymentIntentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAccountInvitations200Response, any, {}>>;
|
|
68102
68443
|
/**
|
|
68103
68444
|
* 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\".
|
|
68104
68445
|
* @summary Get an organization payment integration
|
|
@@ -68123,6 +68464,22 @@ export declare class OrganizationPaymentsApi extends BaseAPI {
|
|
|
68123
68464
|
* @throws {RequiredError}
|
|
68124
68465
|
*/
|
|
68125
68466
|
getPayment(requestParameters: OrganizationPaymentsApiGetPaymentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPayment200Response, any, {}>>;
|
|
68467
|
+
/**
|
|
68468
|
+
* Returns a single unpaid checkout payment intent identified by intent ID; requires \"read\" permission on \"payments\".
|
|
68469
|
+
* @summary Get a payment intent
|
|
68470
|
+
* @param {OrganizationPaymentsApiGetPaymentIntentRequest} requestParameters Request parameters.
|
|
68471
|
+
* @param {*} [options] Override http request option.
|
|
68472
|
+
* @throws {RequiredError}
|
|
68473
|
+
*/
|
|
68474
|
+
getPaymentIntent(requestParameters: OrganizationPaymentsApiGetPaymentIntentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPaymentIntent200Response, any, {}>>;
|
|
68475
|
+
/**
|
|
68476
|
+
* Returns a paginated list of unpaid checkout payment intents for the organization, searchable by id, source, description, or account; requires \"read\" permission on \"payments\".
|
|
68477
|
+
* @summary List an organization\'s payment intents
|
|
68478
|
+
* @param {OrganizationPaymentsApiGetPaymentIntentsRequest} requestParameters Request parameters.
|
|
68479
|
+
* @param {*} [options] Override http request option.
|
|
68480
|
+
* @throws {RequiredError}
|
|
68481
|
+
*/
|
|
68482
|
+
getPaymentIntents(requestParameters?: OrganizationPaymentsApiGetPaymentIntentsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAccountPaymentIntents200Response, any, {}>>;
|
|
68126
68483
|
/**
|
|
68127
68484
|
* 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\".
|
|
68128
68485
|
* @summary Get a payment\'s tax metadata
|