@connectedxm/admin-sdk 6.30.1 → 6.32.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 +1 -0
- package/README.md +2 -0
- package/api.ts +112 -4
- package/dist/api.d.ts +69 -4
- package/dist/api.js +100 -25
- package/dist/esm/api.d.ts +69 -4
- package/dist/esm/api.js +79 -4
- package/docs/ActivationCompletion.md +4 -0
- package/docs/Activity.md +2 -0
- package/docs/ActivityCreateInputs.md +4 -0
- package/docs/ActivityUpdateInputs.md +2 -0
- package/docs/BaseActivationCompletion.md +4 -0
- package/docs/BaseActivity.md +2 -0
- package/docs/BaseEventActivation.md +2 -0
- package/docs/EventActivation.md +2 -0
- package/docs/EventActivationCreateInputs.md +2 -0
- package/docs/EventActivationUpdateInputs.md +2 -0
- package/docs/GetPaymentTaxMetadata200Response.md +24 -0
- package/docs/ImageType.md +7 -5
- package/docs/OrganizationPaymentsApi.md +52 -0
- package/package.json +1 -1
package/dist/esm/api.js
CHANGED
|
@@ -1642,6 +1642,10 @@ export var GetPayment200ResponseStatusEnum;
|
|
|
1642
1642
|
(function (GetPayment200ResponseStatusEnum) {
|
|
1643
1643
|
GetPayment200ResponseStatusEnum["Ok"] = "ok";
|
|
1644
1644
|
})(GetPayment200ResponseStatusEnum || (GetPayment200ResponseStatusEnum = {}));
|
|
1645
|
+
export var GetPaymentTaxMetadata200ResponseStatusEnum;
|
|
1646
|
+
(function (GetPaymentTaxMetadata200ResponseStatusEnum) {
|
|
1647
|
+
GetPaymentTaxMetadata200ResponseStatusEnum["Ok"] = "ok";
|
|
1648
|
+
})(GetPaymentTaxMetadata200ResponseStatusEnum || (GetPaymentTaxMetadata200ResponseStatusEnum = {}));
|
|
1645
1649
|
export var GetPreferences200ResponseStatusEnum;
|
|
1646
1650
|
(function (GetPreferences200ResponseStatusEnum) {
|
|
1647
1651
|
GetPreferences200ResponseStatusEnum["Ok"] = "ok";
|
|
@@ -1931,11 +1935,12 @@ export var ImageModerationLevel;
|
|
|
1931
1935
|
export var ImageType;
|
|
1932
1936
|
(function (ImageType) {
|
|
1933
1937
|
ImageType["Admin"] = "admin";
|
|
1934
|
-
ImageType["
|
|
1935
|
-
ImageType["
|
|
1936
|
-
ImageType["Banner"] = "banner";
|
|
1937
|
-
ImageType["Chat"] = "chat";
|
|
1938
|
+
ImageType["Account"] = "account";
|
|
1939
|
+
ImageType["Thread"] = "thread";
|
|
1938
1940
|
ImageType["Content"] = "content";
|
|
1941
|
+
ImageType["Activity"] = "activity";
|
|
1942
|
+
ImageType["Event"] = "event";
|
|
1943
|
+
ImageType["Activation"] = "activation";
|
|
1939
1944
|
})(ImageType || (ImageType = {}));
|
|
1940
1945
|
export var ImpersonateAccount200ResponseStatusEnum;
|
|
1941
1946
|
(function (ImpersonateAccount200ResponseStatusEnum) {
|
|
@@ -82661,6 +82666,40 @@ export const OrganizationPaymentsApiAxiosParamCreator = function (configuration)
|
|
|
82661
82666
|
options: localVarRequestOptions,
|
|
82662
82667
|
};
|
|
82663
82668
|
}),
|
|
82669
|
+
/**
|
|
82670
|
+
* Get Payment Tax Metadata endpoint
|
|
82671
|
+
* @summary Get Payment Tax Metadata
|
|
82672
|
+
* @param {string} paymentId The payment identifier
|
|
82673
|
+
* @param {*} [options] Override http request option.
|
|
82674
|
+
* @throws {RequiredError}
|
|
82675
|
+
*/
|
|
82676
|
+
getPaymentTaxMetadata: (paymentId_1, ...args_1) => __awaiter(this, [paymentId_1, ...args_1], void 0, function* (paymentId, options = {}) {
|
|
82677
|
+
// verify required parameter 'paymentId' is not null or undefined
|
|
82678
|
+
assertParamExists('getPaymentTaxMetadata', 'paymentId', paymentId);
|
|
82679
|
+
const localVarPath = `/payments/{paymentId}/tax-metadata`
|
|
82680
|
+
.replace(`{${"paymentId"}}`, encodeURIComponent(String(paymentId)));
|
|
82681
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
82682
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
82683
|
+
let baseOptions;
|
|
82684
|
+
if (configuration) {
|
|
82685
|
+
baseOptions = configuration.baseOptions;
|
|
82686
|
+
}
|
|
82687
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
82688
|
+
const localVarHeaderParameter = {};
|
|
82689
|
+
const localVarQueryParameter = {};
|
|
82690
|
+
// authentication ApiKeyAuth required
|
|
82691
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
82692
|
+
// authentication OrganizationId required
|
|
82693
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
82694
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
82695
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
82696
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
82697
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
82698
|
+
return {
|
|
82699
|
+
url: toPathString(localVarUrlObj),
|
|
82700
|
+
options: localVarRequestOptions,
|
|
82701
|
+
};
|
|
82702
|
+
}),
|
|
82664
82703
|
/**
|
|
82665
82704
|
* Get Payments endpoint
|
|
82666
82705
|
* @summary Get Payments
|
|
@@ -82914,6 +82953,22 @@ export const OrganizationPaymentsApiFp = function (configuration) {
|
|
|
82914
82953
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
82915
82954
|
});
|
|
82916
82955
|
},
|
|
82956
|
+
/**
|
|
82957
|
+
* Get Payment Tax Metadata endpoint
|
|
82958
|
+
* @summary Get Payment Tax Metadata
|
|
82959
|
+
* @param {string} paymentId The payment identifier
|
|
82960
|
+
* @param {*} [options] Override http request option.
|
|
82961
|
+
* @throws {RequiredError}
|
|
82962
|
+
*/
|
|
82963
|
+
getPaymentTaxMetadata(paymentId, options) {
|
|
82964
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
82965
|
+
var _a, _b, _c;
|
|
82966
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getPaymentTaxMetadata(paymentId, options);
|
|
82967
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
82968
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['OrganizationPaymentsApi.getPaymentTaxMetadata']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
82969
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
82970
|
+
});
|
|
82971
|
+
},
|
|
82917
82972
|
/**
|
|
82918
82973
|
* Get Payments endpoint
|
|
82919
82974
|
* @summary Get Payments
|
|
@@ -83042,6 +83097,16 @@ export const OrganizationPaymentsApiFactory = function (configuration, basePath,
|
|
|
83042
83097
|
getPayment(requestParameters, options) {
|
|
83043
83098
|
return localVarFp.getPayment(requestParameters.paymentId, options).then((request) => request(axios, basePath));
|
|
83044
83099
|
},
|
|
83100
|
+
/**
|
|
83101
|
+
* Get Payment Tax Metadata endpoint
|
|
83102
|
+
* @summary Get Payment Tax Metadata
|
|
83103
|
+
* @param {OrganizationPaymentsApiGetPaymentTaxMetadataRequest} requestParameters Request parameters.
|
|
83104
|
+
* @param {*} [options] Override http request option.
|
|
83105
|
+
* @throws {RequiredError}
|
|
83106
|
+
*/
|
|
83107
|
+
getPaymentTaxMetadata(requestParameters, options) {
|
|
83108
|
+
return localVarFp.getPaymentTaxMetadata(requestParameters.paymentId, options).then((request) => request(axios, basePath));
|
|
83109
|
+
},
|
|
83045
83110
|
/**
|
|
83046
83111
|
* Get Payments endpoint
|
|
83047
83112
|
* @summary Get Payments
|
|
@@ -83138,6 +83203,16 @@ export class OrganizationPaymentsApi extends BaseAPI {
|
|
|
83138
83203
|
getPayment(requestParameters, options) {
|
|
83139
83204
|
return OrganizationPaymentsApiFp(this.configuration).getPayment(requestParameters.paymentId, options).then((request) => request(this.axios, this.basePath));
|
|
83140
83205
|
}
|
|
83206
|
+
/**
|
|
83207
|
+
* Get Payment Tax Metadata endpoint
|
|
83208
|
+
* @summary Get Payment Tax Metadata
|
|
83209
|
+
* @param {OrganizationPaymentsApiGetPaymentTaxMetadataRequest} requestParameters Request parameters.
|
|
83210
|
+
* @param {*} [options] Override http request option.
|
|
83211
|
+
* @throws {RequiredError}
|
|
83212
|
+
*/
|
|
83213
|
+
getPaymentTaxMetadata(requestParameters, options) {
|
|
83214
|
+
return OrganizationPaymentsApiFp(this.configuration).getPaymentTaxMetadata(requestParameters.paymentId, options).then((request) => request(this.axios, this.basePath));
|
|
83215
|
+
}
|
|
83141
83216
|
/**
|
|
83142
83217
|
* Get Payments endpoint
|
|
83143
83218
|
* @summary Get Payments
|
|
@@ -11,6 +11,8 @@ Name | Type | Description | Notes
|
|
|
11
11
|
**eventActivation** | [**BaseEventActivation**](BaseEventActivation.md) | | [default to undefined]
|
|
12
12
|
**earnedPoints** | **number** | | [default to undefined]
|
|
13
13
|
**passId** | **string** | | [default to undefined]
|
|
14
|
+
**imageId** | **string** | | [default to undefined]
|
|
15
|
+
**image** | [**BaseImage**](BaseImage.md) | | [default to undefined]
|
|
14
16
|
**pass** | [**BaseEventPass**](BaseEventPass.md) | | [default to undefined]
|
|
15
17
|
**createdAt** | **string** | | [default to undefined]
|
|
16
18
|
**updatedAt** | **string** | | [default to undefined]
|
|
@@ -27,6 +29,8 @@ const instance: ActivationCompletion = {
|
|
|
27
29
|
eventActivation,
|
|
28
30
|
earnedPoints,
|
|
29
31
|
passId,
|
|
32
|
+
imageId,
|
|
33
|
+
image,
|
|
30
34
|
pass,
|
|
31
35
|
createdAt,
|
|
32
36
|
updatedAt,
|
package/docs/Activity.md
CHANGED
|
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**status** | [**ActivityStatus**](ActivityStatus.md) | | [default to undefined]
|
|
11
11
|
**featured** | **boolean** | | [default to undefined]
|
|
12
12
|
**pinned** | **boolean** | | [default to undefined]
|
|
13
|
+
**pinnedExplore** | **boolean** | | [default to undefined]
|
|
13
14
|
**giphyId** | **string** | | [default to undefined]
|
|
14
15
|
**imageId** | **string** | | [default to undefined]
|
|
15
16
|
**videoId** | **string** | | [default to undefined]
|
|
@@ -42,6 +43,7 @@ const instance: Activity = {
|
|
|
42
43
|
status,
|
|
43
44
|
featured,
|
|
44
45
|
pinned,
|
|
46
|
+
pinnedExplore,
|
|
45
47
|
giphyId,
|
|
46
48
|
imageId,
|
|
47
49
|
videoId,
|
|
@@ -8,6 +8,8 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**message** | **string** | | [default to undefined]
|
|
9
9
|
**entities** | [**Array<ActivityEntityInputs>**](ActivityEntityInputs.md) | | [optional] [default to undefined]
|
|
10
10
|
**featured** | **boolean** | | [optional] [default to undefined]
|
|
11
|
+
**pinned** | **boolean** | | [optional] [default to undefined]
|
|
12
|
+
**pinnedExplore** | **boolean** | | [optional] [default to undefined]
|
|
11
13
|
**imageId** | **string** | | [optional] [default to undefined]
|
|
12
14
|
**videoId** | **string** | | [optional] [default to undefined]
|
|
13
15
|
**eventId** | **string** | | [optional] [default to undefined]
|
|
@@ -26,6 +28,8 @@ const instance: ActivityCreateInputs = {
|
|
|
26
28
|
message,
|
|
27
29
|
entities,
|
|
28
30
|
featured,
|
|
31
|
+
pinned,
|
|
32
|
+
pinnedExplore,
|
|
29
33
|
imageId,
|
|
30
34
|
videoId,
|
|
31
35
|
eventId,
|
|
@@ -11,6 +11,7 @@ Name | Type | Description | Notes
|
|
|
11
11
|
**moderation** | [**ModerationStatus**](ModerationStatus.md) | | [optional] [default to undefined]
|
|
12
12
|
**featured** | **boolean** | | [optional] [default to undefined]
|
|
13
13
|
**pinned** | **boolean** | | [optional] [default to undefined]
|
|
14
|
+
**pinnedExplore** | **boolean** | | [optional] [default to undefined]
|
|
14
15
|
**imageId** | **string** | | [optional] [default to undefined]
|
|
15
16
|
**videoId** | **string** | | [optional] [default to undefined]
|
|
16
17
|
**meetingId** | **string** | | [optional] [default to undefined]
|
|
@@ -28,6 +29,7 @@ const instance: ActivityUpdateInputs = {
|
|
|
28
29
|
moderation,
|
|
29
30
|
featured,
|
|
30
31
|
pinned,
|
|
32
|
+
pinnedExplore,
|
|
31
33
|
imageId,
|
|
32
34
|
videoId,
|
|
33
35
|
meetingId,
|
|
@@ -11,6 +11,8 @@ Name | Type | Description | Notes
|
|
|
11
11
|
**eventActivation** | [**BaseEventActivation**](BaseEventActivation.md) | | [default to undefined]
|
|
12
12
|
**earnedPoints** | **number** | | [default to undefined]
|
|
13
13
|
**passId** | **string** | | [default to undefined]
|
|
14
|
+
**imageId** | **string** | | [default to undefined]
|
|
15
|
+
**image** | [**BaseImage**](BaseImage.md) | | [default to undefined]
|
|
14
16
|
|
|
15
17
|
## Example
|
|
16
18
|
|
|
@@ -24,6 +26,8 @@ const instance: BaseActivationCompletion = {
|
|
|
24
26
|
eventActivation,
|
|
25
27
|
earnedPoints,
|
|
26
28
|
passId,
|
|
29
|
+
imageId,
|
|
30
|
+
image,
|
|
27
31
|
};
|
|
28
32
|
```
|
|
29
33
|
|
package/docs/BaseActivity.md
CHANGED
|
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**status** | [**ActivityStatus**](ActivityStatus.md) | | [default to undefined]
|
|
11
11
|
**featured** | **boolean** | | [default to undefined]
|
|
12
12
|
**pinned** | **boolean** | | [default to undefined]
|
|
13
|
+
**pinnedExplore** | **boolean** | | [default to undefined]
|
|
13
14
|
**giphyId** | **string** | | [default to undefined]
|
|
14
15
|
**imageId** | **string** | | [default to undefined]
|
|
15
16
|
**videoId** | **string** | | [default to undefined]
|
|
@@ -35,6 +36,7 @@ const instance: BaseActivity = {
|
|
|
35
36
|
status,
|
|
36
37
|
featured,
|
|
37
38
|
pinned,
|
|
39
|
+
pinnedExplore,
|
|
38
40
|
giphyId,
|
|
39
41
|
imageId,
|
|
40
42
|
videoId,
|
|
@@ -16,6 +16,7 @@ Name | Type | Description | Notes
|
|
|
16
16
|
**accessLevel** | [**PassTypeAccessLevel**](PassTypeAccessLevel.md) | | [default to undefined]
|
|
17
17
|
**sortOrder** | **number** | | [default to undefined]
|
|
18
18
|
**survey** | [**BaseSurvey**](BaseSurvey.md) | | [default to undefined]
|
|
19
|
+
**imageUpload** | **boolean** | | [default to undefined]
|
|
19
20
|
**_count** | [**BaseEventActivationCount**](BaseEventActivationCount.md) | | [default to undefined]
|
|
20
21
|
|
|
21
22
|
## Example
|
|
@@ -35,6 +36,7 @@ const instance: BaseEventActivation = {
|
|
|
35
36
|
accessLevel,
|
|
36
37
|
sortOrder,
|
|
37
38
|
survey,
|
|
39
|
+
imageUpload,
|
|
38
40
|
_count,
|
|
39
41
|
};
|
|
40
42
|
```
|
package/docs/EventActivation.md
CHANGED
|
@@ -16,6 +16,7 @@ Name | Type | Description | Notes
|
|
|
16
16
|
**accessLevel** | [**PassTypeAccessLevel**](PassTypeAccessLevel.md) | | [default to undefined]
|
|
17
17
|
**sortOrder** | **number** | | [default to undefined]
|
|
18
18
|
**survey** | [**BaseSurvey**](BaseSurvey.md) | | [default to undefined]
|
|
19
|
+
**imageUpload** | **boolean** | | [default to undefined]
|
|
19
20
|
**_count** | [**BaseEventActivationCount**](BaseEventActivationCount.md) | | [default to undefined]
|
|
20
21
|
**eventId** | **string** | | [default to undefined]
|
|
21
22
|
**event** | [**BaseEvent**](BaseEvent.md) | | [default to undefined]
|
|
@@ -45,6 +46,7 @@ const instance: EventActivation = {
|
|
|
45
46
|
accessLevel,
|
|
46
47
|
sortOrder,
|
|
47
48
|
survey,
|
|
49
|
+
imageUpload,
|
|
48
50
|
_count,
|
|
49
51
|
eventId,
|
|
50
52
|
event,
|
|
@@ -21,6 +21,7 @@ Name | Type | Description | Notes
|
|
|
21
21
|
**continuousScanning** | **boolean** | | [optional] [default to undefined]
|
|
22
22
|
**scanType** | [**OnSiteScanType**](OnSiteScanType.md) | | [optional] [default to undefined]
|
|
23
23
|
**sortOrder** | [**AdvertisementCreateInputsWeight**](AdvertisementCreateInputsWeight.md) | | [optional] [default to undefined]
|
|
24
|
+
**imageUpload** | **boolean** | | [optional] [default to undefined]
|
|
24
25
|
|
|
25
26
|
## Example
|
|
26
27
|
|
|
@@ -44,6 +45,7 @@ const instance: EventActivationCreateInputs = {
|
|
|
44
45
|
continuousScanning,
|
|
45
46
|
scanType,
|
|
46
47
|
sortOrder,
|
|
48
|
+
imageUpload,
|
|
47
49
|
};
|
|
48
50
|
```
|
|
49
51
|
|
|
@@ -19,6 +19,7 @@ Name | Type | Description | Notes
|
|
|
19
19
|
**continuousScanning** | **boolean** | | [optional] [default to undefined]
|
|
20
20
|
**scanType** | [**OnSiteScanType**](OnSiteScanType.md) | | [optional] [default to undefined]
|
|
21
21
|
**sortOrder** | [**AdvertisementCreateInputsWeight**](AdvertisementCreateInputsWeight.md) | | [optional] [default to undefined]
|
|
22
|
+
**imageUpload** | **boolean** | | [optional] [default to undefined]
|
|
22
23
|
|
|
23
24
|
## Example
|
|
24
25
|
|
|
@@ -40,6 +41,7 @@ const instance: EventActivationUpdateInputs = {
|
|
|
40
41
|
continuousScanning,
|
|
41
42
|
scanType,
|
|
42
43
|
sortOrder,
|
|
44
|
+
imageUpload,
|
|
43
45
|
};
|
|
44
46
|
```
|
|
45
47
|
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# GetPaymentTaxMetadata200Response
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**status** | **string** | | [default to undefined]
|
|
9
|
+
**message** | **string** | | [default to undefined]
|
|
10
|
+
**data** | **{ [key: string]: object; }** | | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { GetPaymentTaxMetadata200Response } from '@connectedxm/admin-sdk';
|
|
16
|
+
|
|
17
|
+
const instance: GetPaymentTaxMetadata200Response = {
|
|
18
|
+
status,
|
|
19
|
+
message,
|
|
20
|
+
data,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/ImageType.md
CHANGED
|
@@ -5,14 +5,16 @@
|
|
|
5
5
|
|
|
6
6
|
* `Admin` (value: `'admin'`)
|
|
7
7
|
|
|
8
|
-
* `
|
|
8
|
+
* `Account` (value: `'account'`)
|
|
9
9
|
|
|
10
|
-
* `
|
|
10
|
+
* `Thread` (value: `'thread'`)
|
|
11
11
|
|
|
12
|
-
* `
|
|
12
|
+
* `Content` (value: `'content'`)
|
|
13
13
|
|
|
14
|
-
* `
|
|
14
|
+
* `Activity` (value: `'activity'`)
|
|
15
15
|
|
|
16
|
-
* `
|
|
16
|
+
* `Event` (value: `'event'`)
|
|
17
|
+
|
|
18
|
+
* `Activation` (value: `'activation'`)
|
|
17
19
|
|
|
18
20
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -9,6 +9,7 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
9
9
|
|[**getOrganizationPaymentIntegration**](#getorganizationpaymentintegration) | **GET** /organization/payment/{integrationId} | Get Organization Payment Integration|
|
|
10
10
|
|[**getOrganizationPaymentIntegrations**](#getorganizationpaymentintegrations) | **GET** /organization/payment | Get Organization Payment Integrations|
|
|
11
11
|
|[**getPayment**](#getpayment) | **GET** /payments/{paymentId} | Get Payment|
|
|
12
|
+
|[**getPaymentTaxMetadata**](#getpaymenttaxmetadata) | **GET** /payments/{paymentId}/tax-metadata | Get Payment Tax Metadata|
|
|
12
13
|
|[**getPayments**](#getpayments) | **GET** /payments | Get Payments|
|
|
13
14
|
|[**refundOrganizationPayment**](#refundorganizationpayment) | **POST** /payments/{paymentId}/refund | Refund Organization Payment|
|
|
14
15
|
|[**toggleOrganizationPaymentIntegration**](#toggleorganizationpaymentintegration) | **PUT** /organization/payment/{integrationId}/toggle | Toggle Organization Payment Integration|
|
|
@@ -272,6 +273,57 @@ const { status, data } = await apiInstance.getPayment(
|
|
|
272
273
|
- **Accept**: application/json
|
|
273
274
|
|
|
274
275
|
|
|
276
|
+
### HTTP response details
|
|
277
|
+
| Status code | Description | Response headers |
|
|
278
|
+
|-------------|-------------|------------------|
|
|
279
|
+
|**200** | Successful response | - |
|
|
280
|
+
|
|
281
|
+
[[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)
|
|
282
|
+
|
|
283
|
+
# **getPaymentTaxMetadata**
|
|
284
|
+
> GetPaymentTaxMetadata200Response getPaymentTaxMetadata()
|
|
285
|
+
|
|
286
|
+
Get Payment Tax Metadata endpoint
|
|
287
|
+
|
|
288
|
+
### Example
|
|
289
|
+
|
|
290
|
+
```typescript
|
|
291
|
+
import {
|
|
292
|
+
OrganizationPaymentsApi,
|
|
293
|
+
Configuration
|
|
294
|
+
} from '@connectedxm/admin-sdk';
|
|
295
|
+
|
|
296
|
+
const configuration = new Configuration();
|
|
297
|
+
const apiInstance = new OrganizationPaymentsApi(configuration);
|
|
298
|
+
|
|
299
|
+
let paymentId: string; //The payment identifier (default to undefined)
|
|
300
|
+
|
|
301
|
+
const { status, data } = await apiInstance.getPaymentTaxMetadata(
|
|
302
|
+
paymentId
|
|
303
|
+
);
|
|
304
|
+
```
|
|
305
|
+
|
|
306
|
+
### Parameters
|
|
307
|
+
|
|
308
|
+
|Name | Type | Description | Notes|
|
|
309
|
+
|------------- | ------------- | ------------- | -------------|
|
|
310
|
+
| **paymentId** | [**string**] | The payment identifier | defaults to undefined|
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
### Return type
|
|
314
|
+
|
|
315
|
+
**GetPaymentTaxMetadata200Response**
|
|
316
|
+
|
|
317
|
+
### Authorization
|
|
318
|
+
|
|
319
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
320
|
+
|
|
321
|
+
### HTTP request headers
|
|
322
|
+
|
|
323
|
+
- **Content-Type**: Not defined
|
|
324
|
+
- **Accept**: application/json
|
|
325
|
+
|
|
326
|
+
|
|
275
327
|
### HTTP response details
|
|
276
328
|
| Status code | Description | Response headers |
|
|
277
329
|
|-------------|-------------|------------------|
|