@connectedxm/admin-sdk 7.4.1 → 7.5.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 +3 -0
- package/api.ts +387 -0
- package/dist/api.d.ts +197 -0
- package/dist/api.js +276 -0
- package/dist/esm/api.d.ts +197 -0
- package/dist/esm/api.js +276 -0
- package/docs/Coupon.md +4 -0
- package/docs/EventsCouponsApi.md +192 -0
- package/package.json +1 -1
package/docs/Coupon.md
CHANGED
|
@@ -29,6 +29,8 @@ Name | Type | Description | Notes
|
|
|
29
29
|
**applyToSessions** | **boolean** | | [default to undefined]
|
|
30
30
|
**registrationId** | **string** | | [default to undefined]
|
|
31
31
|
**registration** | [**BaseEventAttendee**](BaseEventAttendee.md) | | [default to undefined]
|
|
32
|
+
**allowedTiers** | [**Array<BaseTier>**](BaseTier.md) | | [default to undefined]
|
|
33
|
+
**disallowedTiers** | [**Array<BaseTier>**](BaseTier.md) | | [default to undefined]
|
|
32
34
|
**lineItem** | [**PaymentLineItem**](PaymentLineItem.md) | | [default to undefined]
|
|
33
35
|
**parentCouponId** | **string** | | [default to undefined]
|
|
34
36
|
**parentCoupon** | [**BaseCoupon**](BaseCoupon.md) | | [default to undefined]
|
|
@@ -66,6 +68,8 @@ const instance: Coupon = {
|
|
|
66
68
|
applyToSessions,
|
|
67
69
|
registrationId,
|
|
68
70
|
registration,
|
|
71
|
+
allowedTiers,
|
|
72
|
+
disallowedTiers,
|
|
69
73
|
lineItem,
|
|
70
74
|
parentCouponId,
|
|
71
75
|
parentCoupon,
|
package/docs/EventsCouponsApi.md
CHANGED
|
@@ -4,6 +4,7 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
+
|[**addEventCouponTier**](#addeventcoupontier) | **POST** /events/{eventId}/coupons/{couponId}/tiers/{tierId} | Add Event Coupon Tier|
|
|
7
8
|
|[**createEventCoupon**](#createeventcoupon) | **POST** /events/{eventId}/coupons | Create Event Coupon|
|
|
8
9
|
|[**createEventCouponVariants**](#createeventcouponvariants) | **POST** /events/{eventId}/coupons/{couponId}/variants | Create Event Coupon Variants|
|
|
9
10
|
|[**deleteEventCoupon**](#deleteeventcoupon) | **DELETE** /events/{eventId}/coupons/{couponId} | Delete Event Coupon|
|
|
@@ -11,11 +12,73 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
11
12
|
|[**getEventCoupon**](#geteventcoupon) | **GET** /events/{eventId}/coupons/{couponId} | Get Event Coupon|
|
|
12
13
|
|[**getEventCouponPasses**](#geteventcouponpasses) | **GET** /events/{eventId}/coupons/{couponId}/passes | Get Event Coupon Passes|
|
|
13
14
|
|[**getEventCouponPayments**](#geteventcouponpayments) | **GET** /events/{eventId}/coupons/{couponId}/payments | Get Event Coupon Payments|
|
|
15
|
+
|[**getEventCouponTiers**](#geteventcoupontiers) | **GET** /events/{eventId}/coupons/{couponId}/tiers | Get Event Coupon Tiers|
|
|
14
16
|
|[**getEventCouponVariants**](#geteventcouponvariants) | **GET** /events/{eventId}/coupons/{parentCouponId}/variants | Get Event Coupon Variants|
|
|
15
17
|
|[**getEventCoupons**](#geteventcoupons) | **GET** /events/{eventId}/coupons | Get Event Coupons|
|
|
18
|
+
|[**removeEventCouponTier**](#removeeventcoupontier) | **DELETE** /events/{eventId}/coupons/{couponId}/tiers/{tierId} | Remove Event Coupon Tier|
|
|
16
19
|
|[**syncEventCouponToVariants**](#synceventcoupontovariants) | **PUT** /events/{eventId}/coupons/{couponId}/variants | Sync Event Coupon To Variants|
|
|
17
20
|
|[**updateEventCoupon**](#updateeventcoupon) | **PUT** /events/{eventId}/coupons/{couponId} | Update Event Coupon|
|
|
18
21
|
|
|
22
|
+
# **addEventCouponTier**
|
|
23
|
+
> CreateEventCoupon200Response addEventCouponTier()
|
|
24
|
+
|
|
25
|
+
Add Event Coupon Tier endpoint
|
|
26
|
+
|
|
27
|
+
### Example
|
|
28
|
+
|
|
29
|
+
```typescript
|
|
30
|
+
import {
|
|
31
|
+
EventsCouponsApi,
|
|
32
|
+
Configuration
|
|
33
|
+
} from '@connectedxm/admin-sdk';
|
|
34
|
+
|
|
35
|
+
const configuration = new Configuration();
|
|
36
|
+
const apiInstance = new EventsCouponsApi(configuration);
|
|
37
|
+
|
|
38
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
39
|
+
let couponId: string; //The coupon identifier (default to undefined)
|
|
40
|
+
let tierId: string; //The tier identifier (default to undefined)
|
|
41
|
+
let allowed: boolean; //Filter by allowed (default to undefined)
|
|
42
|
+
|
|
43
|
+
const { status, data } = await apiInstance.addEventCouponTier(
|
|
44
|
+
eventId,
|
|
45
|
+
couponId,
|
|
46
|
+
tierId,
|
|
47
|
+
allowed
|
|
48
|
+
);
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
### Parameters
|
|
52
|
+
|
|
53
|
+
|Name | Type | Description | Notes|
|
|
54
|
+
|------------- | ------------- | ------------- | -------------|
|
|
55
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
56
|
+
| **couponId** | [**string**] | The coupon identifier | defaults to undefined|
|
|
57
|
+
| **tierId** | [**string**] | The tier identifier | defaults to undefined|
|
|
58
|
+
| **allowed** | [**boolean**] | Filter by allowed | defaults to undefined|
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
### Return type
|
|
62
|
+
|
|
63
|
+
**CreateEventCoupon200Response**
|
|
64
|
+
|
|
65
|
+
### Authorization
|
|
66
|
+
|
|
67
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
68
|
+
|
|
69
|
+
### HTTP request headers
|
|
70
|
+
|
|
71
|
+
- **Content-Type**: Not defined
|
|
72
|
+
- **Accept**: application/json
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
### HTTP response details
|
|
76
|
+
| Status code | Description | Response headers |
|
|
77
|
+
|-------------|-------------|------------------|
|
|
78
|
+
|**200** | Successful response | - |
|
|
79
|
+
|
|
80
|
+
[[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)
|
|
81
|
+
|
|
19
82
|
# **createEventCoupon**
|
|
20
83
|
> CreateEventCoupon200Response createEventCoupon(eventCouponCreateInputs)
|
|
21
84
|
|
|
@@ -416,6 +479,75 @@ const { status, data } = await apiInstance.getEventCouponPayments(
|
|
|
416
479
|
- **Accept**: application/json
|
|
417
480
|
|
|
418
481
|
|
|
482
|
+
### HTTP response details
|
|
483
|
+
| Status code | Description | Response headers |
|
|
484
|
+
|-------------|-------------|------------------|
|
|
485
|
+
|**200** | Successful response | - |
|
|
486
|
+
|
|
487
|
+
[[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)
|
|
488
|
+
|
|
489
|
+
# **getEventCouponTiers**
|
|
490
|
+
> GetAccountTiers200Response getEventCouponTiers()
|
|
491
|
+
|
|
492
|
+
Get Event Coupon Tiers endpoint
|
|
493
|
+
|
|
494
|
+
### Example
|
|
495
|
+
|
|
496
|
+
```typescript
|
|
497
|
+
import {
|
|
498
|
+
EventsCouponsApi,
|
|
499
|
+
Configuration
|
|
500
|
+
} from '@connectedxm/admin-sdk';
|
|
501
|
+
|
|
502
|
+
const configuration = new Configuration();
|
|
503
|
+
const apiInstance = new EventsCouponsApi(configuration);
|
|
504
|
+
|
|
505
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
506
|
+
let couponId: string; //The coupon identifier (default to undefined)
|
|
507
|
+
let allowed: boolean; //Filter by allowed (default to undefined)
|
|
508
|
+
let page: number; //Page number (optional) (default to 1)
|
|
509
|
+
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
510
|
+
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
511
|
+
let search: string; //Search query (optional) (default to undefined)
|
|
512
|
+
|
|
513
|
+
const { status, data } = await apiInstance.getEventCouponTiers(
|
|
514
|
+
eventId,
|
|
515
|
+
couponId,
|
|
516
|
+
allowed,
|
|
517
|
+
page,
|
|
518
|
+
pageSize,
|
|
519
|
+
orderBy,
|
|
520
|
+
search
|
|
521
|
+
);
|
|
522
|
+
```
|
|
523
|
+
|
|
524
|
+
### Parameters
|
|
525
|
+
|
|
526
|
+
|Name | Type | Description | Notes|
|
|
527
|
+
|------------- | ------------- | ------------- | -------------|
|
|
528
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
529
|
+
| **couponId** | [**string**] | The coupon identifier | defaults to undefined|
|
|
530
|
+
| **allowed** | [**boolean**] | Filter by allowed | defaults to undefined|
|
|
531
|
+
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
532
|
+
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
533
|
+
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
534
|
+
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
535
|
+
|
|
536
|
+
|
|
537
|
+
### Return type
|
|
538
|
+
|
|
539
|
+
**GetAccountTiers200Response**
|
|
540
|
+
|
|
541
|
+
### Authorization
|
|
542
|
+
|
|
543
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
544
|
+
|
|
545
|
+
### HTTP request headers
|
|
546
|
+
|
|
547
|
+
- **Content-Type**: Not defined
|
|
548
|
+
- **Accept**: application/json
|
|
549
|
+
|
|
550
|
+
|
|
419
551
|
### HTTP response details
|
|
420
552
|
| Status code | Description | Response headers |
|
|
421
553
|
|-------------|-------------|------------------|
|
|
@@ -551,6 +683,66 @@ const { status, data } = await apiInstance.getEventCoupons(
|
|
|
551
683
|
- **Accept**: application/json
|
|
552
684
|
|
|
553
685
|
|
|
686
|
+
### HTTP response details
|
|
687
|
+
| Status code | Description | Response headers |
|
|
688
|
+
|-------------|-------------|------------------|
|
|
689
|
+
|**200** | Successful response | - |
|
|
690
|
+
|
|
691
|
+
[[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)
|
|
692
|
+
|
|
693
|
+
# **removeEventCouponTier**
|
|
694
|
+
> CreateEventCoupon200Response removeEventCouponTier()
|
|
695
|
+
|
|
696
|
+
Remove Event Coupon Tier endpoint
|
|
697
|
+
|
|
698
|
+
### Example
|
|
699
|
+
|
|
700
|
+
```typescript
|
|
701
|
+
import {
|
|
702
|
+
EventsCouponsApi,
|
|
703
|
+
Configuration
|
|
704
|
+
} from '@connectedxm/admin-sdk';
|
|
705
|
+
|
|
706
|
+
const configuration = new Configuration();
|
|
707
|
+
const apiInstance = new EventsCouponsApi(configuration);
|
|
708
|
+
|
|
709
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
710
|
+
let couponId: string; //The coupon identifier (default to undefined)
|
|
711
|
+
let tierId: string; //The tier identifier (default to undefined)
|
|
712
|
+
let allowed: boolean; //Filter by allowed (default to undefined)
|
|
713
|
+
|
|
714
|
+
const { status, data } = await apiInstance.removeEventCouponTier(
|
|
715
|
+
eventId,
|
|
716
|
+
couponId,
|
|
717
|
+
tierId,
|
|
718
|
+
allowed
|
|
719
|
+
);
|
|
720
|
+
```
|
|
721
|
+
|
|
722
|
+
### Parameters
|
|
723
|
+
|
|
724
|
+
|Name | Type | Description | Notes|
|
|
725
|
+
|------------- | ------------- | ------------- | -------------|
|
|
726
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
727
|
+
| **couponId** | [**string**] | The coupon identifier | defaults to undefined|
|
|
728
|
+
| **tierId** | [**string**] | The tier identifier | defaults to undefined|
|
|
729
|
+
| **allowed** | [**boolean**] | Filter by allowed | defaults to undefined|
|
|
730
|
+
|
|
731
|
+
|
|
732
|
+
### Return type
|
|
733
|
+
|
|
734
|
+
**CreateEventCoupon200Response**
|
|
735
|
+
|
|
736
|
+
### Authorization
|
|
737
|
+
|
|
738
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
739
|
+
|
|
740
|
+
### HTTP request headers
|
|
741
|
+
|
|
742
|
+
- **Content-Type**: Not defined
|
|
743
|
+
- **Accept**: application/json
|
|
744
|
+
|
|
745
|
+
|
|
554
746
|
### HTTP response details
|
|
555
747
|
| Status code | Description | Response headers |
|
|
556
748
|
|-------------|-------------|------------------|
|