@connectedxm/admin-sdk 7.9.4 → 7.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.
@@ -5,8 +5,10 @@ All URIs are relative to *https://admin-api.connected.dev*
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
7
  |[**addEventPassAddOn**](#addeventpassaddon) | **POST** /events/{eventId}/passes/{passId}/addOns/{addOnId} | Add an add-on to an attendee\'s pass|
8
+ |[**fulfillEventPassAddOn**](#fulfilleventpassaddon) | **POST** /events/{eventId}/passes/{passId}/addOns/{addOnId}/fulfill | Fulfill an add-on on an attendee\'s pass|
8
9
  |[**getEventPassAddOns**](#geteventpassaddons) | **GET** /events/{eventId}/passes/{passId}/addOns | List an event pass\'s add-ons|
9
10
  |[**removeEventPassAddOn**](#removeeventpassaddon) | **DELETE** /events/{eventId}/passes/{passId}/addOns/{addOnId} | Remove an add-on from an attendee\'s pass|
11
+ |[**unfulfillEventPassAddOn**](#unfulfilleventpassaddon) | **POST** /events/{eventId}/passes/{passId}/addOns/{addOnId}/undo | Undo an add-on fulfillment|
10
12
 
11
13
  # **addEventPassAddOn**
12
14
  > CreateEventPass200Response addEventPassAddOn()
@@ -58,6 +60,63 @@ const { status, data } = await apiInstance.addEventPassAddOn(
58
60
  - **Accept**: application/json
59
61
 
60
62
 
63
+ ### HTTP response details
64
+ | Status code | Description | Response headers |
65
+ |-------------|-------------|------------------|
66
+ |**200** | Successful response | - |
67
+
68
+ [[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)
69
+
70
+ # **fulfillEventPassAddOn**
71
+ > FulfillEventPassAddOn200Response fulfillEventPassAddOn()
72
+
73
+ Marks the given pass add-on as fulfilled, requires read permission on events and read/update permission on attendees.
74
+
75
+ ### Example
76
+
77
+ ```typescript
78
+ import {
79
+ EventsPassesAddonsApi,
80
+ Configuration
81
+ } from '@connectedxm/admin-sdk';
82
+
83
+ const configuration = new Configuration();
84
+ const apiInstance = new EventsPassesAddonsApi(configuration);
85
+
86
+ let eventId: string; //The event identifier (default to undefined)
87
+ let passId: string; //The pass identifier (default to undefined)
88
+ let addOnId: string; //The addOn identifier (default to undefined)
89
+
90
+ const { status, data } = await apiInstance.fulfillEventPassAddOn(
91
+ eventId,
92
+ passId,
93
+ addOnId
94
+ );
95
+ ```
96
+
97
+ ### Parameters
98
+
99
+ |Name | Type | Description | Notes|
100
+ |------------- | ------------- | ------------- | -------------|
101
+ | **eventId** | [**string**] | The event identifier | defaults to undefined|
102
+ | **passId** | [**string**] | The pass identifier | defaults to undefined|
103
+ | **addOnId** | [**string**] | The addOn identifier | defaults to undefined|
104
+
105
+
106
+ ### Return type
107
+
108
+ **FulfillEventPassAddOn200Response**
109
+
110
+ ### Authorization
111
+
112
+ [ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
113
+
114
+ ### HTTP request headers
115
+
116
+ - **Content-Type**: Not defined
117
+ - **Accept**: application/json
118
+
119
+
61
120
  ### HTTP response details
62
121
  | Status code | Description | Response headers |
63
122
  |-------------|-------------|------------------|
@@ -188,3 +247,60 @@ const { status, data } = await apiInstance.removeEventPassAddOn(
188
247
 
189
248
  [[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)
190
249
 
250
+ # **unfulfillEventPassAddOn**
251
+ > FulfillEventPassAddOn200Response unfulfillEventPassAddOn()
252
+
253
+ Reverses a previous fulfillment of the given pass add-on, requires read permission on events and read/update permission on attendees.
254
+
255
+ ### Example
256
+
257
+ ```typescript
258
+ import {
259
+ EventsPassesAddonsApi,
260
+ Configuration
261
+ } from '@connectedxm/admin-sdk';
262
+
263
+ const configuration = new Configuration();
264
+ const apiInstance = new EventsPassesAddonsApi(configuration);
265
+
266
+ let eventId: string; //The event identifier (default to undefined)
267
+ let passId: string; //The pass identifier (default to undefined)
268
+ let addOnId: string; //The addOn identifier (default to undefined)
269
+
270
+ const { status, data } = await apiInstance.unfulfillEventPassAddOn(
271
+ eventId,
272
+ passId,
273
+ addOnId
274
+ );
275
+ ```
276
+
277
+ ### Parameters
278
+
279
+ |Name | Type | Description | Notes|
280
+ |------------- | ------------- | ------------- | -------------|
281
+ | **eventId** | [**string**] | The event identifier | defaults to undefined|
282
+ | **passId** | [**string**] | The pass identifier | defaults to undefined|
283
+ | **addOnId** | [**string**] | The addOn identifier | defaults to undefined|
284
+
285
+
286
+ ### Return type
287
+
288
+ **FulfillEventPassAddOn200Response**
289
+
290
+ ### Authorization
291
+
292
+ [ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
293
+
294
+ ### HTTP request headers
295
+
296
+ - **Content-Type**: Not defined
297
+ - **Accept**: application/json
298
+
299
+
300
+ ### HTTP response details
301
+ | Status code | Description | Response headers |
302
+ |-------------|-------------|------------------|
303
+ |**200** | Successful response | - |
304
+
305
+ [[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)
306
+
@@ -0,0 +1,24 @@
1
+ # FulfillEventPassAddOn200Response
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** | [**PassAddOn**](PassAddOn.md) | | [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { FulfillEventPassAddOn200Response } from '@connectedxm/admin-sdk';
16
+
17
+ const instance: FulfillEventPassAddOn200Response = {
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)
@@ -0,0 +1,26 @@
1
+ # GetOrganizationLanguageOverrides200Response
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<OrganizationLanguageOverride>**](OrganizationLanguageOverride.md) | | [default to undefined]
11
+ **count** | **number** | | [optional] [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { GetOrganizationLanguageOverrides200Response } from '@connectedxm/admin-sdk';
17
+
18
+ const instance: GetOrganizationLanguageOverrides200Response = {
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)
@@ -0,0 +1,28 @@
1
+ # OrganizationLanguageOverride
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **locale** | **string** | | [default to undefined]
9
+ **key** | **string** | | [default to undefined]
10
+ **value** | **string** | | [default to undefined]
11
+ **createdAt** | **string** | | [default to undefined]
12
+ **updatedAt** | **string** | | [default to undefined]
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import { OrganizationLanguageOverride } from '@connectedxm/admin-sdk';
18
+
19
+ const instance: OrganizationLanguageOverride = {
20
+ locale,
21
+ key,
22
+ value,
23
+ createdAt,
24
+ updatedAt,
25
+ };
26
+ ```
27
+
28
+ [[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,22 @@
1
+ # OrganizationLanguageOverrideUpsertInputs
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **key** | **string** | | [default to undefined]
9
+ **value** | **string** | | [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { OrganizationLanguageOverrideUpsertInputs } from '@connectedxm/admin-sdk';
15
+
16
+ const instance: OrganizationLanguageOverrideUpsertInputs = {
17
+ key,
18
+ value,
19
+ };
20
+ ```
21
+
22
+ [[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,182 @@
1
+ # OrganizationLanguageoverridesApi
2
+
3
+ All URIs are relative to *https://admin-api.connected.dev*
4
+
5
+ |Method | HTTP request | Description|
6
+ |------------- | ------------- | -------------|
7
+ |[**deleteOrganizationLanguageOverride**](#deleteorganizationlanguageoverride) | **DELETE** /organization/language-overrides/{locale} | Delete a language override|
8
+ |[**getOrganizationLanguageOverrides**](#getorganizationlanguageoverrides) | **GET** /organization/language-overrides | List an organization\'s language overrides|
9
+ |[**upsertOrganizationLanguageOverride**](#upsertorganizationlanguageoverride) | **PUT** /organization/language-overrides/{locale} | Create or update a language override|
10
+
11
+ # **deleteOrganizationLanguageOverride**
12
+ > SyncAccounts200Response deleteOrganizationLanguageOverride()
13
+
14
+ Deletes the organization\'s i18n string override for the given locale and key (sent as a query parameter since keys can contain spaces), requires the update org permission, and refreshes the language overrides list on success.
15
+
16
+ ### Example
17
+
18
+ ```typescript
19
+ import {
20
+ OrganizationLanguageoverridesApi,
21
+ Configuration
22
+ } from '@connectedxm/admin-sdk';
23
+
24
+ const configuration = new Configuration();
25
+ const apiInstance = new OrganizationLanguageoverridesApi(configuration);
26
+
27
+ let locale: string; //The locale identifier (default to undefined)
28
+ let key: string; //Filter by key (default to undefined)
29
+
30
+ const { status, data } = await apiInstance.deleteOrganizationLanguageOverride(
31
+ locale,
32
+ key
33
+ );
34
+ ```
35
+
36
+ ### Parameters
37
+
38
+ |Name | Type | Description | Notes|
39
+ |------------- | ------------- | ------------- | -------------|
40
+ | **locale** | [**string**] | The locale identifier | defaults to undefined|
41
+ | **key** | [**string**] | Filter by key | defaults to undefined|
42
+
43
+
44
+ ### Return type
45
+
46
+ **SyncAccounts200Response**
47
+
48
+ ### Authorization
49
+
50
+ [ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
51
+
52
+ ### HTTP request headers
53
+
54
+ - **Content-Type**: Not defined
55
+ - **Accept**: application/json
56
+
57
+
58
+ ### HTTP response details
59
+ | Status code | Description | Response headers |
60
+ |-------------|-------------|------------------|
61
+ |**200** | Successful response | - |
62
+
63
+ [[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)
64
+
65
+ # **getOrganizationLanguageOverrides**
66
+ > GetOrganizationLanguageOverrides200Response getOrganizationLanguageOverrides()
67
+
68
+ Returns a paginated list of the organization\'s i18n string overrides, optionally filtered by locale and searchable by key or value; requires org read permission.
69
+
70
+ ### Example
71
+
72
+ ```typescript
73
+ import {
74
+ OrganizationLanguageoverridesApi,
75
+ Configuration
76
+ } from '@connectedxm/admin-sdk';
77
+
78
+ const configuration = new Configuration();
79
+ const apiInstance = new OrganizationLanguageoverridesApi(configuration);
80
+
81
+ let locale: string; //Filter by locale (optional) (default to undefined)
82
+ let page: number; //Page number (optional) (default to 1)
83
+ let pageSize: number; //Number of items per page (optional) (default to 25)
84
+ let orderBy: string; //Field to order by (optional) (default to undefined)
85
+ let search: string; //Search query (optional) (default to undefined)
86
+
87
+ const { status, data } = await apiInstance.getOrganizationLanguageOverrides(
88
+ locale,
89
+ page,
90
+ pageSize,
91
+ orderBy,
92
+ search
93
+ );
94
+ ```
95
+
96
+ ### Parameters
97
+
98
+ |Name | Type | Description | Notes|
99
+ |------------- | ------------- | ------------- | -------------|
100
+ | **locale** | [**string**] | Filter by locale | (optional) defaults to undefined|
101
+ | **page** | [**number**] | Page number | (optional) defaults to 1|
102
+ | **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
103
+ | **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
104
+ | **search** | [**string**] | Search query | (optional) defaults to undefined|
105
+
106
+
107
+ ### Return type
108
+
109
+ **GetOrganizationLanguageOverrides200Response**
110
+
111
+ ### Authorization
112
+
113
+ [ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
114
+
115
+ ### HTTP request headers
116
+
117
+ - **Content-Type**: Not defined
118
+ - **Accept**: application/json
119
+
120
+
121
+ ### HTTP response details
122
+ | Status code | Description | Response headers |
123
+ |-------------|-------------|------------------|
124
+ |**200** | Successful response | - |
125
+
126
+ [[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)
127
+
128
+ # **upsertOrganizationLanguageOverride**
129
+ > SyncAccounts200Response upsertOrganizationLanguageOverride(organizationLanguageOverrideUpsertInputs)
130
+
131
+ Upserts the organization\'s i18n string override for the given locale and key, requires the update org permission, and refreshes the language overrides list on success.
132
+
133
+ ### Example
134
+
135
+ ```typescript
136
+ import {
137
+ OrganizationLanguageoverridesApi,
138
+ Configuration,
139
+ OrganizationLanguageOverrideUpsertInputs
140
+ } from '@connectedxm/admin-sdk';
141
+
142
+ const configuration = new Configuration();
143
+ const apiInstance = new OrganizationLanguageoverridesApi(configuration);
144
+
145
+ let locale: string; //The locale identifier (default to undefined)
146
+ let organizationLanguageOverrideUpsertInputs: OrganizationLanguageOverrideUpsertInputs; //
147
+
148
+ const { status, data } = await apiInstance.upsertOrganizationLanguageOverride(
149
+ locale,
150
+ organizationLanguageOverrideUpsertInputs
151
+ );
152
+ ```
153
+
154
+ ### Parameters
155
+
156
+ |Name | Type | Description | Notes|
157
+ |------------- | ------------- | ------------- | -------------|
158
+ | **organizationLanguageOverrideUpsertInputs** | **OrganizationLanguageOverrideUpsertInputs**| | |
159
+ | **locale** | [**string**] | The locale identifier | defaults to undefined|
160
+
161
+
162
+ ### Return type
163
+
164
+ **SyncAccounts200Response**
165
+
166
+ ### Authorization
167
+
168
+ [ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
169
+
170
+ ### HTTP request headers
171
+
172
+ - **Content-Type**: application/json
173
+ - **Accept**: application/json
174
+
175
+
176
+ ### HTTP response details
177
+ | Status code | Description | Response headers |
178
+ |-------------|-------------|------------------|
179
+ |**200** | Successful response | - |
180
+
181
+ [[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)
182
+
package/docs/PassAddOn.md CHANGED
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
8
  **addOnId** | **string** | | [default to undefined]
9
9
  **addOn** | [**BaseEventAddOn**](BaseEventAddOn.md) | | [default to undefined]
10
+ **fulfilledAt** | **string** | | [default to undefined]
10
11
  **createdAt** | **string** | | [default to undefined]
11
12
  **pass** | [**BaseEventPass**](BaseEventPass.md) | | [default to undefined]
12
13
  **updatedAt** | **string** | | [default to undefined]
@@ -19,6 +20,7 @@ import { PassAddOn } from '@connectedxm/admin-sdk';
19
20
  const instance: PassAddOn = {
20
21
  addOnId,
21
22
  addOn,
23
+ fulfilledAt,
22
24
  createdAt,
23
25
  pass,
24
26
  updatedAt,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@connectedxm/admin-sdk",
3
- "version": "7.9.4",
3
+ "version": "7.10.0",
4
4
  "description": "OpenAPI client for @connectedxm/admin-sdk",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {