@connectedxm/admin-sdk 10.8.2 → 10.10.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.
@@ -0,0 +1,34 @@
1
+ # EventBadgeColorRuleCreateInputs
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **name** | **string** | | [default to undefined]
9
+ **type** | [**BadgeColorRuleType**](BadgeColorRuleType.md) | | [default to undefined]
10
+ **color** | **string** | | [default to undefined]
11
+ **sortOrder** | **number** | | [optional] [default to undefined]
12
+ **attributeId** | **string** | | [optional] [default to undefined]
13
+ **attributeValue** | **string** | | [optional] [default to undefined]
14
+ **tierId** | **string** | | [optional] [default to undefined]
15
+ **passTypeId** | **string** | | [optional] [default to undefined]
16
+
17
+ ## Example
18
+
19
+ ```typescript
20
+ import { EventBadgeColorRuleCreateInputs } from '@connectedxm/admin-sdk';
21
+
22
+ const instance: EventBadgeColorRuleCreateInputs = {
23
+ name,
24
+ type,
25
+ color,
26
+ sortOrder,
27
+ attributeId,
28
+ attributeValue,
29
+ tierId,
30
+ passTypeId,
31
+ };
32
+ ```
33
+
34
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,34 @@
1
+ # EventBadgeColorRuleUpdateInputs
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **name** | **string** | | [optional] [default to undefined]
9
+ **type** | [**BadgeColorRuleType**](BadgeColorRuleType.md) | | [optional] [default to undefined]
10
+ **color** | **string** | | [optional] [default to undefined]
11
+ **sortOrder** | **number** | | [optional] [default to undefined]
12
+ **attributeId** | **string** | | [optional] [default to undefined]
13
+ **attributeValue** | **string** | | [optional] [default to undefined]
14
+ **tierId** | **string** | | [optional] [default to undefined]
15
+ **passTypeId** | **string** | | [optional] [default to undefined]
16
+
17
+ ## Example
18
+
19
+ ```typescript
20
+ import { EventBadgeColorRuleUpdateInputs } from '@connectedxm/admin-sdk';
21
+
22
+ const instance: EventBadgeColorRuleUpdateInputs = {
23
+ name,
24
+ type,
25
+ color,
26
+ sortOrder,
27
+ attributeId,
28
+ attributeValue,
29
+ tierId,
30
+ passTypeId,
31
+ };
32
+ ```
33
+
34
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,46 @@
1
+ # EventOnSiteBadgeColorRule
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **id** | **string** | | [default to undefined]
9
+ **name** | **string** | | [default to undefined]
10
+ **type** | [**BadgeColorRuleType**](BadgeColorRuleType.md) | | [default to undefined]
11
+ **color** | **string** | | [default to undefined]
12
+ **sortOrder** | **number** | | [default to undefined]
13
+ **attributeId** | **string** | | [default to undefined]
14
+ **attributeValue** | **string** | | [default to undefined]
15
+ **tierId** | **string** | | [default to undefined]
16
+ **passTypeId** | **string** | | [default to undefined]
17
+ **attribute** | [**BaseAccountAttribute**](BaseAccountAttribute.md) | | [default to undefined]
18
+ **tier** | [**BaseTier**](BaseTier.md) | | [default to undefined]
19
+ **passType** | [**BaseEventPassType**](BaseEventPassType.md) | | [default to undefined]
20
+ **createdAt** | **string** | | [default to undefined]
21
+ **updatedAt** | **string** | | [default to undefined]
22
+
23
+ ## Example
24
+
25
+ ```typescript
26
+ import { EventOnSiteBadgeColorRule } from '@connectedxm/admin-sdk';
27
+
28
+ const instance: EventOnSiteBadgeColorRule = {
29
+ id,
30
+ name,
31
+ type,
32
+ color,
33
+ sortOrder,
34
+ attributeId,
35
+ attributeValue,
36
+ tierId,
37
+ passTypeId,
38
+ attribute,
39
+ tier,
40
+ passType,
41
+ createdAt,
42
+ updatedAt,
43
+ };
44
+ ```
45
+
46
+ [[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,7 +9,6 @@ Name | Type | Description | Notes
9
9
  **location** | **string** | | [optional] [default to undefined]
10
10
  **ticketId** | **string** | | [optional] [default to undefined]
11
11
  **usedAt** | **string** | | [optional] [default to undefined]
12
- **badgeColor** | **string** | | [optional] [default to undefined]
13
12
 
14
13
  ## Example
15
14
 
@@ -21,7 +20,6 @@ const instance: EventPassCreateInputs = {
21
20
  location,
22
21
  ticketId,
23
22
  usedAt,
24
- badgeColor,
25
23
  };
26
24
  ```
27
25
 
@@ -10,7 +10,6 @@ Name | Type | Description | Notes
10
10
  **ticketId** | **string** | | [optional] [default to undefined]
11
11
  **couponId** | **string** | | [optional] [default to undefined]
12
12
  **usedAt** | **string** | | [optional] [default to undefined]
13
- **badgeColor** | **string** | | [optional] [default to undefined]
14
13
 
15
14
  ## Example
16
15
 
@@ -23,7 +22,6 @@ const instance: EventPassUpdateInputs = {
23
22
  ticketId,
24
23
  couponId,
25
24
  usedAt,
26
- badgeColor,
27
25
  };
28
26
  ```
29
27
 
@@ -4,10 +4,241 @@ All URIs are relative to *https://admin-api.connected.dev*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
+ |[**createEventBadgeColorRule**](#createeventbadgecolorrule) | **POST** /events/{eventId}/on-site/badge-colors | Create an event badge color rule|
8
+ |[**deleteEventBadgeColorRule**](#deleteeventbadgecolorrule) | **DELETE** /events/{eventId}/on-site/badge-colors/{ruleId} | Delete an event badge color rule|
9
+ |[**getEventBadgeColorRule**](#geteventbadgecolorrule) | **GET** /events/{eventId}/on-site/badge-colors/{ruleId} | Get an event badge color rule|
10
+ |[**getEventBadgeColorRules**](#geteventbadgecolorrules) | **GET** /events/{eventId}/on-site/badge-colors | List an event\'s badge color rules|
7
11
  |[**getEventOnSite**](#geteventonsite) | **GET** /events/{eventId}/on-site | Get an event\'s on-site check-in settings|
12
+ |[**updateEventBadgeColorRule**](#updateeventbadgecolorrule) | **PUT** /events/{eventId}/on-site/badge-colors/{ruleId} | Update an event badge color rule|
8
13
  |[**updateEventBadgeTemplate**](#updateeventbadgetemplate) | **PUT** /events/{eventId}/template | Update an event\'s badge template|
9
14
  |[**updateEventCheckinCode**](#updateeventcheckincode) | **POST** /events/{eventId}/on-site | Regenerate an event\'s check-in code|
10
15
 
16
+ # **createEventBadgeColorRule**
17
+ > CreateEventBadgeColorRule200Response createEventBadgeColorRule(eventBadgeColorRuleCreateInputs)
18
+
19
+ Creates a new on-site badge color rule for the given event. Omitting sortOrder appends the rule after the last existing one; requires the \"update\" permission on events.
20
+
21
+ ### Example
22
+
23
+ ```typescript
24
+ import {
25
+ EventsOnSiteApi,
26
+ Configuration,
27
+ EventBadgeColorRuleCreateInputs
28
+ } from '@connectedxm/admin-sdk';
29
+
30
+ const configuration = new Configuration();
31
+ const apiInstance = new EventsOnSiteApi(configuration);
32
+
33
+ let eventId: string; //The event identifier (default to undefined)
34
+ let eventBadgeColorRuleCreateInputs: EventBadgeColorRuleCreateInputs; //
35
+
36
+ const { status, data } = await apiInstance.createEventBadgeColorRule(
37
+ eventId,
38
+ eventBadgeColorRuleCreateInputs
39
+ );
40
+ ```
41
+
42
+ ### Parameters
43
+
44
+ |Name | Type | Description | Notes|
45
+ |------------- | ------------- | ------------- | -------------|
46
+ | **eventBadgeColorRuleCreateInputs** | **EventBadgeColorRuleCreateInputs**| | |
47
+ | **eventId** | [**string**] | The event identifier | defaults to undefined|
48
+
49
+
50
+ ### Return type
51
+
52
+ **CreateEventBadgeColorRule200Response**
53
+
54
+ ### Authorization
55
+
56
+ [ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
57
+
58
+ ### HTTP request headers
59
+
60
+ - **Content-Type**: application/json
61
+ - **Accept**: application/json
62
+
63
+
64
+ ### HTTP response details
65
+ | Status code | Description | Response headers |
66
+ |-------------|-------------|------------------|
67
+ |**200** | Successful response | - |
68
+
69
+ [[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)
70
+
71
+ # **deleteEventBadgeColorRule**
72
+ > CreateAccountInvitations200Response deleteEventBadgeColorRule()
73
+
74
+ Permanently deletes the specified on-site badge color rule from the given event; requires the \"update\" permission on events.
75
+
76
+ ### Example
77
+
78
+ ```typescript
79
+ import {
80
+ EventsOnSiteApi,
81
+ Configuration
82
+ } from '@connectedxm/admin-sdk';
83
+
84
+ const configuration = new Configuration();
85
+ const apiInstance = new EventsOnSiteApi(configuration);
86
+
87
+ let eventId: string; //The event identifier (default to undefined)
88
+ let ruleId: string; //The rule identifier (default to undefined)
89
+
90
+ const { status, data } = await apiInstance.deleteEventBadgeColorRule(
91
+ eventId,
92
+ ruleId
93
+ );
94
+ ```
95
+
96
+ ### Parameters
97
+
98
+ |Name | Type | Description | Notes|
99
+ |------------- | ------------- | ------------- | -------------|
100
+ | **eventId** | [**string**] | The event identifier | defaults to undefined|
101
+ | **ruleId** | [**string**] | The rule identifier | defaults to undefined|
102
+
103
+
104
+ ### Return type
105
+
106
+ **CreateAccountInvitations200Response**
107
+
108
+ ### Authorization
109
+
110
+ [ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
111
+
112
+ ### HTTP request headers
113
+
114
+ - **Content-Type**: Not defined
115
+ - **Accept**: application/json
116
+
117
+
118
+ ### HTTP response details
119
+ | Status code | Description | Response headers |
120
+ |-------------|-------------|------------------|
121
+ |**200** | Successful response | - |
122
+
123
+ [[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)
124
+
125
+ # **getEventBadgeColorRule**
126
+ > CreateEventBadgeColorRule200Response getEventBadgeColorRule()
127
+
128
+ Returns a single on-site badge color rule belonging to the given event; requires \"read\" permission on events.
129
+
130
+ ### Example
131
+
132
+ ```typescript
133
+ import {
134
+ EventsOnSiteApi,
135
+ Configuration
136
+ } from '@connectedxm/admin-sdk';
137
+
138
+ const configuration = new Configuration();
139
+ const apiInstance = new EventsOnSiteApi(configuration);
140
+
141
+ let eventId: string; //The event identifier (default to undefined)
142
+ let ruleId: string; //The rule identifier (default to undefined)
143
+
144
+ const { status, data } = await apiInstance.getEventBadgeColorRule(
145
+ eventId,
146
+ ruleId
147
+ );
148
+ ```
149
+
150
+ ### Parameters
151
+
152
+ |Name | Type | Description | Notes|
153
+ |------------- | ------------- | ------------- | -------------|
154
+ | **eventId** | [**string**] | The event identifier | defaults to undefined|
155
+ | **ruleId** | [**string**] | The rule identifier | defaults to undefined|
156
+
157
+
158
+ ### Return type
159
+
160
+ **CreateEventBadgeColorRule200Response**
161
+
162
+ ### Authorization
163
+
164
+ [ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
165
+
166
+ ### HTTP request headers
167
+
168
+ - **Content-Type**: Not defined
169
+ - **Accept**: application/json
170
+
171
+
172
+ ### HTTP response details
173
+ | Status code | Description | Response headers |
174
+ |-------------|-------------|------------------|
175
+ |**200** | Successful response | - |
176
+
177
+ [[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)
178
+
179
+ # **getEventBadgeColorRules**
180
+ > GetEventBadgeColorRules200Response getEventBadgeColorRules()
181
+
182
+ Returns a paginated list of on-site badge color rules configured for the given event, with optional search and sort order; requires \"read\" permission on events.
183
+
184
+ ### Example
185
+
186
+ ```typescript
187
+ import {
188
+ EventsOnSiteApi,
189
+ Configuration
190
+ } from '@connectedxm/admin-sdk';
191
+
192
+ const configuration = new Configuration();
193
+ const apiInstance = new EventsOnSiteApi(configuration);
194
+
195
+ let eventId: string; //The event identifier (default to undefined)
196
+ let page: number; //Page number (optional) (default to 1)
197
+ let pageSize: number; //Number of items per page (optional) (default to 25)
198
+ let orderBy: string; //Field to order by (optional) (default to undefined)
199
+ let search: string; //Search query (optional) (default to undefined)
200
+
201
+ const { status, data } = await apiInstance.getEventBadgeColorRules(
202
+ eventId,
203
+ page,
204
+ pageSize,
205
+ orderBy,
206
+ search
207
+ );
208
+ ```
209
+
210
+ ### Parameters
211
+
212
+ |Name | Type | Description | Notes|
213
+ |------------- | ------------- | ------------- | -------------|
214
+ | **eventId** | [**string**] | The event identifier | defaults to undefined|
215
+ | **page** | [**number**] | Page number | (optional) defaults to 1|
216
+ | **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
217
+ | **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
218
+ | **search** | [**string**] | Search query | (optional) defaults to undefined|
219
+
220
+
221
+ ### Return type
222
+
223
+ **GetEventBadgeColorRules200Response**
224
+
225
+ ### Authorization
226
+
227
+ [ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
228
+
229
+ ### HTTP request headers
230
+
231
+ - **Content-Type**: Not defined
232
+ - **Accept**: application/json
233
+
234
+
235
+ ### HTTP response details
236
+ | Status code | Description | Response headers |
237
+ |-------------|-------------|------------------|
238
+ |**200** | Successful response | - |
239
+
240
+ [[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)
241
+
11
242
  # **getEventOnSite**
12
243
  > GetEventOnSite200Response getEventOnSite()
13
244
 
@@ -52,6 +283,64 @@ const { status, data } = await apiInstance.getEventOnSite(
52
283
  - **Accept**: application/json
53
284
 
54
285
 
286
+ ### HTTP response details
287
+ | Status code | Description | Response headers |
288
+ |-------------|-------------|------------------|
289
+ |**200** | Successful response | - |
290
+
291
+ [[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)
292
+
293
+ # **updateEventBadgeColorRule**
294
+ > CreateEventBadgeColorRule200Response updateEventBadgeColorRule(eventBadgeColorRuleUpdateInputs)
295
+
296
+ Partially updates the specified on-site badge color rule. Changing type still nulls unused match branches on the backend, so send the new branch\'s ids when the type changes; requires the \"update\" permission on events.
297
+
298
+ ### Example
299
+
300
+ ```typescript
301
+ import {
302
+ EventsOnSiteApi,
303
+ Configuration,
304
+ EventBadgeColorRuleUpdateInputs
305
+ } from '@connectedxm/admin-sdk';
306
+
307
+ const configuration = new Configuration();
308
+ const apiInstance = new EventsOnSiteApi(configuration);
309
+
310
+ let eventId: string; //The event identifier (default to undefined)
311
+ let ruleId: string; //The rule identifier (default to undefined)
312
+ let eventBadgeColorRuleUpdateInputs: EventBadgeColorRuleUpdateInputs; //
313
+
314
+ const { status, data } = await apiInstance.updateEventBadgeColorRule(
315
+ eventId,
316
+ ruleId,
317
+ eventBadgeColorRuleUpdateInputs
318
+ );
319
+ ```
320
+
321
+ ### Parameters
322
+
323
+ |Name | Type | Description | Notes|
324
+ |------------- | ------------- | ------------- | -------------|
325
+ | **eventBadgeColorRuleUpdateInputs** | **EventBadgeColorRuleUpdateInputs**| | |
326
+ | **eventId** | [**string**] | The event identifier | defaults to undefined|
327
+ | **ruleId** | [**string**] | The rule identifier | defaults to undefined|
328
+
329
+
330
+ ### Return type
331
+
332
+ **CreateEventBadgeColorRule200Response**
333
+
334
+ ### Authorization
335
+
336
+ [ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
337
+
338
+ ### HTTP request headers
339
+
340
+ - **Content-Type**: application/json
341
+ - **Accept**: application/json
342
+
343
+
55
344
  ### HTTP response details
56
345
  | Status code | Description | Response headers |
57
346
  |-------------|-------------|------------------|
@@ -0,0 +1,26 @@
1
+ # GetEventBadgeColorRules200Response
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** | [**Array<EventOnSiteBadgeColorRule>**](EventOnSiteBadgeColorRule.md) | | [default to undefined]
11
+ **count** | **number** | | [optional] [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { GetEventBadgeColorRules200Response } from '@connectedxm/admin-sdk';
17
+
18
+ const instance: GetEventBadgeColorRules200Response = {
19
+ status,
20
+ message,
21
+ data,
22
+ count,
23
+ };
24
+ ```
25
+
26
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -80,6 +80,8 @@ Name | Type | Description | Notes
80
80
  **googleTagManagerId** | **string** | | [default to undefined]
81
81
  **googleMapsApiKey** | **string** | | [default to undefined]
82
82
  **turnstileSiteKey** | **string** | | [default to undefined]
83
+ **appleMerchantIdDomainAssociation** | **string** | | [default to undefined]
84
+ **googleMerchantId** | **string** | | [default to undefined]
83
85
  **_options** | **object** | | [default to undefined]
84
86
  **modulesOrder** | [**Array<ModulesOrder>**](ModulesOrder.md) | | [default to undefined]
85
87
 
@@ -164,6 +166,8 @@ const instance: Organization = {
164
166
  googleTagManagerId,
165
167
  googleMapsApiKey,
166
168
  turnstileSiteKey,
169
+ appleMerchantIdDomainAssociation,
170
+ googleMerchantId,
167
171
  _options,
168
172
  modulesOrder,
169
173
  };
@@ -56,6 +56,8 @@ Name | Type | Description | Notes
56
56
  **googleMapsApiKey** | **string** | | [optional] [default to undefined]
57
57
  **turnstileSiteKey** | **string** | | [optional] [default to undefined]
58
58
  **turnstileSecretKey** | **string** | | [optional] [default to undefined]
59
+ **appleMerchantIdDomainAssociation** | **string** | | [optional] [default to undefined]
60
+ **googleMerchantId** | **string** | | [optional] [default to undefined]
59
61
  **_options** | **object** | | [optional] [default to undefined]
60
62
  **modulesOrder** | [**Array<ModulesOrder>**](ModulesOrder.md) | | [optional] [default to undefined]
61
63
 
@@ -116,6 +118,8 @@ const instance: OrganizationUpdateInputs = {
116
118
  googleMapsApiKey,
117
119
  turnstileSiteKey,
118
120
  turnstileSecretKey,
121
+ appleMerchantIdDomainAssociation,
122
+ googleMerchantId,
119
123
  _options,
120
124
  modulesOrder,
121
125
  };
@@ -32,7 +32,6 @@ Name | Type | Description | Notes
32
32
  **taxIncluded** | **boolean** | | [optional] [default to undefined]
33
33
  **taxLocation** | [**TaxLocationType**](TaxLocationType.md) | | [optional] [default to undefined]
34
34
  **printable** | **boolean** | | [optional] [default to undefined]
35
- **badgeColor** | **string** | | [optional] [default to undefined]
36
35
  **requiresApproval** | **boolean** | | [optional] [default to undefined]
37
36
 
38
37
  ## Example
@@ -68,7 +67,6 @@ const instance: PassTypeCreateInputs = {
68
67
  taxIncluded,
69
68
  taxLocation,
70
69
  printable,
71
- badgeColor,
72
70
  requiresApproval,
73
71
  };
74
72
  ```
@@ -34,7 +34,6 @@ Name | Type | Description | Notes
34
34
  **taxIncluded** | **boolean** | | [optional] [default to undefined]
35
35
  **taxLocation** | [**TaxLocationType**](TaxLocationType.md) | | [optional] [default to undefined]
36
36
  **printable** | **boolean** | | [optional] [default to undefined]
37
- **badgeColor** | **string** | | [optional] [default to undefined]
38
37
  **requiresApproval** | **boolean** | | [optional] [default to undefined]
39
38
 
40
39
  ## Example
@@ -72,7 +71,6 @@ const instance: PassTypeUpdateInputs = {
72
71
  taxIncluded,
73
72
  taxLocation,
74
73
  printable,
75
- badgeColor,
76
74
  requiresApproval,
77
75
  };
78
76
  ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@connectedxm/admin-sdk",
3
- "version": "10.8.2",
3
+ "version": "10.10.0",
4
4
  "description": "OpenAPI client for @connectedxm/admin-sdk",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {