@connectedxm/admin-sdk 7.5.0 → 7.5.1

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.
Files changed (201) hide show
  1. package/README.md +1212 -1212
  2. package/api.ts +9696 -9696
  3. package/dist/api.d.ts +9696 -9696
  4. package/dist/api.js +9696 -9696
  5. package/dist/esm/api.d.ts +9696 -9696
  6. package/dist/esm/api.js +9696 -9696
  7. package/docs/AccountsAddressesApi.md +10 -10
  8. package/docs/AccountsApi.md +42 -42
  9. package/docs/AccountsFollowersApi.md +6 -6
  10. package/docs/AccountsFollowingApi.md +6 -6
  11. package/docs/AccountsGroupsApi.md +6 -6
  12. package/docs/AccountsInterestsApi.md +6 -6
  13. package/docs/AccountsInvitationsApi.md +6 -6
  14. package/docs/AccountsLeadsApi.md +8 -8
  15. package/docs/AccountsTiersApi.md +8 -8
  16. package/docs/ActivitiesApi.md +18 -18
  17. package/docs/ActivitiesScheduleApi.md +4 -4
  18. package/docs/AdvertisementsApi.md +14 -14
  19. package/docs/AnnouncementsApi.md +16 -16
  20. package/docs/AnnouncementsScheduleApi.md +4 -4
  21. package/docs/AnnouncementsTranslationsApi.md +8 -8
  22. package/docs/ApiLogsApi.md +4 -4
  23. package/docs/AuthSessionsApi.md +4 -4
  24. package/docs/BenefitsApi.md +12 -12
  25. package/docs/BenefitsTranslationsApi.md +8 -8
  26. package/docs/BookingsApi.md +56 -56
  27. package/docs/BookingsAvailabilitiesApi.md +6 -6
  28. package/docs/BookingsBlackoutsApi.md +6 -6
  29. package/docs/BookingsPlacesApi.md +6 -6
  30. package/docs/BookingsPlacesTranslationsApi.md +4 -4
  31. package/docs/BookingsQuestionsApi.md +16 -16
  32. package/docs/BookingsQuestionsChoicesApi.md +12 -12
  33. package/docs/BookingsQuestionsChoicesTranslationsApi.md +8 -8
  34. package/docs/BookingsQuestionsTranslationsApi.md +8 -8
  35. package/docs/BookingsSpacesApi.md +6 -6
  36. package/docs/BookingsSpacesTranslationsApi.md +4 -4
  37. package/docs/ChannelsApi.md +58 -58
  38. package/docs/ChannelsTranslationsApi.md +24 -24
  39. package/docs/DashboardsApi.md +10 -10
  40. package/docs/DashboardsWidgetsApi.md +8 -8
  41. package/docs/EmailReceiptsApi.md +4 -4
  42. package/docs/EventsAccessApi.md +6 -6
  43. package/docs/EventsActivationsApi.md +22 -22
  44. package/docs/EventsActivationsSessionsApi.md +6 -6
  45. package/docs/EventsActivationsTranslationsApi.md +8 -8
  46. package/docs/EventsAddonsApi.md +24 -24
  47. package/docs/EventsAddonsTranslationsApi.md +8 -8
  48. package/docs/EventsApi.md +22 -22
  49. package/docs/EventsAttendeesApi.md +24 -24
  50. package/docs/EventsAttendeesPackagesApi.md +10 -10
  51. package/docs/EventsAttendeesReservationsApi.md +18 -18
  52. package/docs/EventsAttributesApi.md +10 -10
  53. package/docs/EventsBenefitsApi.md +4 -4
  54. package/docs/EventsBlocksApi.md +16 -16
  55. package/docs/EventsBypassApi.md +10 -10
  56. package/docs/EventsCohostsApi.md +6 -6
  57. package/docs/EventsCouponsApi.md +28 -28
  58. package/docs/EventsEmailsApi.md +4 -4
  59. package/docs/EventsEmailsTranslationsApi.md +8 -8
  60. package/docs/EventsFaqsApi.md +22 -22
  61. package/docs/EventsFaqsTranslationsApi.md +16 -16
  62. package/docs/EventsFollowupsApi.md +38 -38
  63. package/docs/EventsFollowupsTranslationsApi.md +8 -8
  64. package/docs/EventsMatchesApi.md +34 -34
  65. package/docs/EventsMediaApi.md +16 -16
  66. package/docs/EventsMediaTranslationsApi.md +8 -8
  67. package/docs/EventsOnSiteApi.md +6 -6
  68. package/docs/EventsPackagesApi.md +10 -10
  69. package/docs/EventsPackagesPassesApi.md +10 -10
  70. package/docs/EventsPackagesTranslationsApi.md +8 -8
  71. package/docs/EventsPagesApi.md +16 -16
  72. package/docs/EventsPagesTranslationsApi.md +8 -8
  73. package/docs/EventsPassesAccessesApi.md +10 -10
  74. package/docs/EventsPassesAddonsApi.md +6 -6
  75. package/docs/EventsPassesApi.md +34 -34
  76. package/docs/EventsPassesAttributesApi.md +6 -6
  77. package/docs/EventsPassesFollowupsApi.md +8 -8
  78. package/docs/EventsPassesResponsesApi.md +10 -10
  79. package/docs/EventsPasstypesApi.md +34 -34
  80. package/docs/EventsPasstypesPriceschedulesApi.md +10 -10
  81. package/docs/EventsPasstypesRefundschedulesApi.md +10 -10
  82. package/docs/EventsPasstypesTranslationsApi.md +8 -8
  83. package/docs/EventsQuestionsApi.md +44 -44
  84. package/docs/EventsQuestionsTranslationsApi.md +16 -16
  85. package/docs/EventsRoomsApi.md +18 -18
  86. package/docs/EventsRoomtypesApi.md +24 -24
  87. package/docs/EventsRoomtypesTranslationsApi.md +8 -8
  88. package/docs/EventsSectionsApi.md +38 -38
  89. package/docs/EventsSectionsTranslationsApi.md +8 -8
  90. package/docs/EventsSessionsAccessesApi.md +6 -6
  91. package/docs/EventsSessionsApi.md +70 -70
  92. package/docs/EventsSessionsLocationsApi.md +16 -16
  93. package/docs/EventsSessionsLocationsTranslationsApi.md +8 -8
  94. package/docs/EventsSessionsMatchesApi.md +32 -32
  95. package/docs/EventsSessionsPricesApi.md +6 -6
  96. package/docs/EventsSessionsQuestionsApi.md +38 -38
  97. package/docs/EventsSessionsQuestionsTranslationsApi.md +16 -16
  98. package/docs/EventsSessionsSectionsApi.md +20 -20
  99. package/docs/EventsSessionsSectionsTranslationsApi.md +8 -8
  100. package/docs/EventsSessionsTimesApi.md +16 -16
  101. package/docs/EventsSessionsTimesTranslationsApi.md +8 -8
  102. package/docs/EventsSessionsTranslationsApi.md +8 -8
  103. package/docs/EventsSpeakersApi.md +16 -16
  104. package/docs/EventsSpeakersTranslationsApi.md +8 -8
  105. package/docs/EventsSponsorsApi.md +8 -8
  106. package/docs/EventsSponsorshiplevelsApi.md +12 -12
  107. package/docs/EventsSponsorshiplevelsTranslationsApi.md +8 -8
  108. package/docs/EventsSponsorshipsApi.md +12 -12
  109. package/docs/EventsSponsorshipsTranslationsApi.md +8 -8
  110. package/docs/EventsTemplatesApi.md +2 -2
  111. package/docs/EventsTracksApi.md +22 -22
  112. package/docs/EventsTracksTranslationsApi.md +8 -8
  113. package/docs/EventsTransfersApi.md +4 -4
  114. package/docs/EventsTranslationsApi.md +8 -8
  115. package/docs/FilesApi.md +4 -4
  116. package/docs/GroupsApi.md +12 -12
  117. package/docs/GroupsEventsApi.md +6 -6
  118. package/docs/GroupsInterestsApi.md +6 -6
  119. package/docs/GroupsInvitationsApi.md +12 -12
  120. package/docs/GroupsMembersApi.md +8 -8
  121. package/docs/GroupsModeratorsApi.md +6 -6
  122. package/docs/GroupsRequestsApi.md +10 -10
  123. package/docs/GroupsSponsorsApi.md +6 -6
  124. package/docs/GroupsTranslationsApi.md +8 -8
  125. package/docs/ImportsApi.md +8 -8
  126. package/docs/InterestsApi.md +22 -22
  127. package/docs/InvoicesApi.md +20 -20
  128. package/docs/InvoicesLineitemsApi.md +6 -6
  129. package/docs/LoginsAccountsApi.md +6 -6
  130. package/docs/LoginsApi.md +16 -16
  131. package/docs/MeetingsApi.md +14 -14
  132. package/docs/MeetingsLinksApi.md +10 -10
  133. package/docs/MeetingsLivestreamsApi.md +12 -12
  134. package/docs/MeetingsParticipantsApi.md +12 -12
  135. package/docs/MeetingsPresetsApi.md +10 -10
  136. package/docs/MeetingsRecordingsApi.md +4 -4
  137. package/docs/MeetingsSessionsApi.md +16 -16
  138. package/docs/NotificationsApi.md +8 -8
  139. package/docs/OrganizationApi.md +18 -18
  140. package/docs/OrganizationAttributesApi.md +14 -14
  141. package/docs/OrganizationDomainsApi.md +6 -6
  142. package/docs/OrganizationIntegrationsApi.md +10 -10
  143. package/docs/OrganizationModulesApi.md +6 -6
  144. package/docs/OrganizationModulesCustomApi.md +10 -10
  145. package/docs/OrganizationModulesCustomTranslationsApi.md +8 -8
  146. package/docs/OrganizationModulesSettingsApi.md +4 -4
  147. package/docs/OrganizationModulesSettingsTranslationsApi.md +8 -8
  148. package/docs/OrganizationModulesTiersApi.md +12 -12
  149. package/docs/OrganizationPaymentsApi.md +20 -20
  150. package/docs/OrganizationSideeffectsApi.md +8 -8
  151. package/docs/OrganizationTaxApi.md +22 -22
  152. package/docs/OrganizationTeammembersApi.md +10 -10
  153. package/docs/OrganizationUsersApi.md +6 -6
  154. package/docs/OrganizationWebhooksApi.md +12 -12
  155. package/docs/PaymentsApi.md +2 -2
  156. package/docs/PreferencesApi.md +4 -4
  157. package/docs/PushDevicesApi.md +6 -6
  158. package/docs/ReportsApi.md +22 -22
  159. package/docs/ReportsUsersApi.md +6 -6
  160. package/docs/SearchlistsApi.md +10 -10
  161. package/docs/SearchlistsValuesApi.md +14 -14
  162. package/docs/SelfApi.md +10 -10
  163. package/docs/SelfApikeysApi.md +8 -8
  164. package/docs/SelfImagesApi.md +4 -4
  165. package/docs/SeriesApi.md +18 -18
  166. package/docs/SeriesQuestionsApi.md +14 -14
  167. package/docs/SeriesQuestionsChoicesApi.md +8 -8
  168. package/docs/SeriesQuestionsTranslationsApi.md +4 -4
  169. package/docs/SeriesRegistrationsApi.md +18 -18
  170. package/docs/SeriesTranslationsApi.md +8 -8
  171. package/docs/SponsorsAccountsApi.md +6 -6
  172. package/docs/SponsorsApi.md +10 -10
  173. package/docs/SponsorsTranslationsApi.md +8 -8
  174. package/docs/StorageFilesApi.md +6 -6
  175. package/docs/StorageImagesApi.md +18 -18
  176. package/docs/StorageVideosApi.md +14 -14
  177. package/docs/StorageVideosCaptionsApi.md +10 -10
  178. package/docs/StreamsApi.md +14 -14
  179. package/docs/StreamsOutputsApi.md +10 -10
  180. package/docs/StreamsSessionsApi.md +12 -12
  181. package/docs/SupportApi.md +14 -14
  182. package/docs/SupportMessagesApi.md +4 -4
  183. package/docs/SupportNotesApi.md +6 -6
  184. package/docs/SurveysApi.md +12 -12
  185. package/docs/SurveysQuestionsApi.md +38 -38
  186. package/docs/SurveysQuestionsTranslationsApi.md +16 -16
  187. package/docs/SurveysSectionsApi.md +20 -20
  188. package/docs/SurveysSectionsTranslationsApi.md +8 -8
  189. package/docs/SurveysSessionsApi.md +4 -4
  190. package/docs/SurveysSubmissionsApi.md +14 -14
  191. package/docs/SurveysTranslationsApi.md +8 -8
  192. package/docs/ThreadsAccountsApi.md +8 -8
  193. package/docs/ThreadsApi.md +10 -10
  194. package/docs/ThreadsMessagesApi.md +12 -12
  195. package/docs/ThreadsMessagesFilesApi.md +6 -6
  196. package/docs/ThreadsMessagesImagesApi.md +6 -6
  197. package/docs/ThreadsMessagesReactionsApi.md +6 -6
  198. package/docs/ThreadsMessagesVideosApi.md +6 -6
  199. package/docs/ThreadsStorageApi.md +6 -6
  200. package/docs/TiersApi.md +20 -20
  201. package/package.json +1 -1
@@ -4,21 +4,21 @@ All URIs are relative to *https://admin-api.connected.dev*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
- |[**createOrganizationPaymentIntegration**](#createorganizationpaymentintegration) | **POST** /organization/payment | Create Organization Payment Integration|
8
- |[**deleteOrganizationPaymentIntegration**](#deleteorganizationpaymentintegration) | **DELETE** /organization/payment/{integrationId} | Delete Organization Payment Integration|
9
- |[**getOrganizationPaymentIntegration**](#getorganizationpaymentintegration) | **GET** /organization/payment/{integrationId} | Get Organization Payment Integration|
10
- |[**getOrganizationPaymentIntegrations**](#getorganizationpaymentintegrations) | **GET** /organization/payment | Get Organization Payment Integrations|
11
- |[**getPayment**](#getpayment) | **GET** /payments/{paymentId} | Get Payment|
12
- |[**getPaymentTaxMetadata**](#getpaymenttaxmetadata) | **GET** /payments/{paymentId}/tax-metadata | Get Payment Tax Metadata|
13
- |[**getPayments**](#getpayments) | **GET** /payments | Get Payments|
14
- |[**refundOrganizationPayment**](#refundorganizationpayment) | **POST** /payments/{paymentId}/refund | Refund Organization Payment|
15
- |[**toggleOrganizationPaymentIntegration**](#toggleorganizationpaymentintegration) | **PUT** /organization/payment/{integrationId}/toggle | Toggle Organization Payment Integration|
16
- |[**updateOrganizationPaymentIntegration**](#updateorganizationpaymentintegration) | **PUT** /organization/payment/{integrationId} | Update Organization Payment Integration|
7
+ |[**createOrganizationPaymentIntegration**](#createorganizationpaymentintegration) | **POST** /organization/payment | Create an organization payment integration|
8
+ |[**deleteOrganizationPaymentIntegration**](#deleteorganizationpaymentintegration) | **DELETE** /organization/payment/{integrationId} | Delete an organization payment integration|
9
+ |[**getOrganizationPaymentIntegration**](#getorganizationpaymentintegration) | **GET** /organization/payment/{integrationId} | Get an organization payment integration|
10
+ |[**getOrganizationPaymentIntegrations**](#getorganizationpaymentintegrations) | **GET** /organization/payment | List an organization\'s payment integrations|
11
+ |[**getPayment**](#getpayment) | **GET** /payments/{paymentId} | Get a payment|
12
+ |[**getPaymentTaxMetadata**](#getpaymenttaxmetadata) | **GET** /payments/{paymentId}/tax-metadata | Get a payment\'s tax metadata|
13
+ |[**getPayments**](#getpayments) | **GET** /payments | List an organization\'s payments|
14
+ |[**refundOrganizationPayment**](#refundorganizationpayment) | **POST** /payments/{paymentId}/refund | Refund line items on a payment|
15
+ |[**toggleOrganizationPaymentIntegration**](#toggleorganizationpaymentintegration) | **PUT** /organization/payment/{integrationId}/toggle | Set an organization payment integration as default|
16
+ |[**updateOrganizationPaymentIntegration**](#updateorganizationpaymentintegration) | **PUT** /organization/payment/{integrationId} | Update an organization payment integration|
17
17
 
18
18
  # **createOrganizationPaymentIntegration**
19
19
  > CreateOrganizationPaymentIntegration200Response createOrganizationPaymentIntegration(organizationPaymentIntegrationCreateInputs)
20
20
 
21
- Create Organization Payment Integration endpoint
21
+ Creates a new payment integration (e.g. a Stripe or other payment gateway connection) for the current organization, requiring update permission on the org resource.
22
22
 
23
23
  ### Example
24
24
 
@@ -70,7 +70,7 @@ const { status, data } = await apiInstance.createOrganizationPaymentIntegration(
70
70
  # **deleteOrganizationPaymentIntegration**
71
71
  > SyncAccounts200Response deleteOrganizationPaymentIntegration()
72
72
 
73
- Delete Organization Payment Integration endpoint
73
+ Permanently removes a payment integration, identified by integrationId, from the current organization, requiring update permission on the org resource.
74
74
 
75
75
  ### Example
76
76
 
@@ -121,7 +121,7 @@ const { status, data } = await apiInstance.deleteOrganizationPaymentIntegration(
121
121
  # **getOrganizationPaymentIntegration**
122
122
  > CreateOrganizationPaymentIntegration200Response getOrganizationPaymentIntegration()
123
123
 
124
- Get Organization Payment Integration endpoint
124
+ 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\".
125
125
 
126
126
  ### Example
127
127
 
@@ -172,7 +172,7 @@ const { status, data } = await apiInstance.getOrganizationPaymentIntegration(
172
172
  # **getOrganizationPaymentIntegrations**
173
173
  > GetOrganizationPaymentIntegrations200Response getOrganizationPaymentIntegrations()
174
174
 
175
- Get Organization Payment Integrations endpoint
175
+ Returns a paginated list of payment integrations (e.g. Stripe, Braintree, Authorize.Net, manual) configured for the organization, with optional search across name, type, currency code, and connection ID; requires \"read\" permission on \"org\".
176
176
 
177
177
  ### Example
178
178
 
@@ -232,7 +232,7 @@ const { status, data } = await apiInstance.getOrganizationPaymentIntegrations(
232
232
  # **getPayment**
233
233
  > GetPayment200Response getPayment()
234
234
 
235
- Get Payment endpoint
235
+ Returns the details of a single payment record for the organization, identified by payment ID; requires \"read\" permission on \"payments\".
236
236
 
237
237
  ### Example
238
238
 
@@ -283,7 +283,7 @@ const { status, data } = await apiInstance.getPayment(
283
283
  # **getPaymentTaxMetadata**
284
284
  > GetPaymentTaxMetadata200Response getPaymentTaxMetadata()
285
285
 
286
- Get Payment Tax Metadata endpoint
286
+ 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\".
287
287
 
288
288
  ### Example
289
289
 
@@ -334,7 +334,7 @@ const { status, data } = await apiInstance.getPaymentTaxMetadata(
334
334
  # **getPayments**
335
335
  > GetAccountPayments200Response getPayments()
336
336
 
337
- Get Payments endpoint
337
+ Returns a paginated list of payment records for the organization, with optional search and sort ordering; requires \"read\" permission on \"payments\".
338
338
 
339
339
  ### Example
340
340
 
@@ -394,7 +394,7 @@ const { status, data } = await apiInstance.getPayments(
394
394
  # **refundOrganizationPayment**
395
395
  > GetPayment200Response refundOrganizationPayment(refundLineItem)
396
396
 
397
- Refund Organization Payment endpoint
397
+ Issues a refund for one or more line items on the specified payment, identified by paymentId, requiring update permission on the payments resource; at least one line item with a positive amount must be provided.
398
398
 
399
399
  ### Example
400
400
 
@@ -451,7 +451,7 @@ const { status, data } = await apiInstance.refundOrganizationPayment(
451
451
  # **toggleOrganizationPaymentIntegration**
452
452
  > CreateOrganizationPaymentIntegration200Response toggleOrganizationPaymentIntegration()
453
453
 
454
- Toggle Organization Payment Integration endpoint
454
+ Toggles the specified payment integration, identified by integrationId, to be the organization\'s default payment integration, requiring update permission on the org resource.
455
455
 
456
456
  ### Example
457
457
 
@@ -502,7 +502,7 @@ const { status, data } = await apiInstance.toggleOrganizationPaymentIntegration(
502
502
  # **updateOrganizationPaymentIntegration**
503
503
  > CreateOrganizationPaymentIntegration200Response updateOrganizationPaymentIntegration(organizationPaymentIntegrationUpdateInputs)
504
504
 
505
- Update Organization Payment Integration endpoint
505
+ Updates the settings of an existing payment integration, identified by integrationId, for the current organization, requiring update permission on the org resource.
506
506
 
507
507
  ### Example
508
508
 
@@ -4,15 +4,15 @@ All URIs are relative to *https://admin-api.connected.dev*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
- |[**createOrganizationSideEffect**](#createorganizationsideeffect) | **POST** /organization/sideEffects | Create Organization Side Effect|
8
- |[**deleteOrganizationSideEffect**](#deleteorganizationsideeffect) | **DELETE** /organization/sideEffects/{sideEffectId} | Delete Organization Side Effect|
9
- |[**getOrganizationSideEffect**](#getorganizationsideeffect) | **GET** /organization/sideEffects/{sideEffectId} | Get Organization Side Effect|
10
- |[**getOrganizationSideEffects**](#getorganizationsideeffects) | **GET** /organization/sideEffects | Get Organization Side Effects|
7
+ |[**createOrganizationSideEffect**](#createorganizationsideeffect) | **POST** /organization/sideEffects | Create an automation side effect|
8
+ |[**deleteOrganizationSideEffect**](#deleteorganizationsideeffect) | **DELETE** /organization/sideEffects/{sideEffectId} | Delete an automation side effect|
9
+ |[**getOrganizationSideEffect**](#getorganizationsideeffect) | **GET** /organization/sideEffects/{sideEffectId} | Get an organization side effect|
10
+ |[**getOrganizationSideEffects**](#getorganizationsideeffects) | **GET** /organization/sideEffects | List an organization\'s side effects|
11
11
 
12
12
  # **createOrganizationSideEffect**
13
13
  > CreateOrganizationSideEffect200Response createOrganizationSideEffect()
14
14
 
15
- Create Organization Side Effect endpoint
15
+ Creates a side effect that automatically performs an action (such as adding a member to a tier or sending a webhook) when a specified trigger occurs (such as a new account tier or a checked-in event pass), requiring update permission on the resources associated with the chosen trigger and action types.
16
16
 
17
17
  ### Example
18
18
 
@@ -72,7 +72,7 @@ const { status, data } = await apiInstance.createOrganizationSideEffect(
72
72
  # **deleteOrganizationSideEffect**
73
73
  > CreateOrganizationSideEffect200Response deleteOrganizationSideEffect()
74
74
 
75
- Delete Organization Side Effect endpoint
75
+ Permanently removes the side effect identified by sideEffectId, requiring update permission on the resource associated with that side effect\'s trigger type.
76
76
 
77
77
  ### Example
78
78
 
@@ -123,7 +123,7 @@ const { status, data } = await apiInstance.deleteOrganizationSideEffect(
123
123
  # **getOrganizationSideEffect**
124
124
  > CreateOrganizationSideEffect200Response getOrganizationSideEffect()
125
125
 
126
- Get Organization Side Effect endpoint
126
+ Returns the details of a single automation side effect (a trigger-to-action rule, e.g. new pass of pass type joins a group) configured for the organization, identified by side effect ID.
127
127
 
128
128
  ### Example
129
129
 
@@ -174,7 +174,7 @@ const { status, data } = await apiInstance.getOrganizationSideEffect(
174
174
  # **getOrganizationSideEffects**
175
175
  > GetOrganizationSideEffects200Response getOrganizationSideEffects()
176
176
 
177
- Get Organization Side Effects endpoint
177
+ Returns a paginated list of automation side effects (trigger-to-action rules, e.g. a new pass of a pass type adding someone to a group) configured for the organization, filterable by trigger type and trigger ID; the required trigger type determines the permission checked (e.g. \"update\" on \"events\" or \"accounts\").
178
178
 
179
179
  ### Example
180
180
 
@@ -4,22 +4,22 @@ All URIs are relative to *https://admin-api.connected.dev*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
- |[**createTaxIntegration**](#createtaxintegration) | **POST** /organization/tax/{type} | Create Tax Integration|
8
- |[**deleteTaxIntegration**](#deletetaxintegration) | **DELETE** /organization/tax/{type} | Delete Tax Integration|
9
- |[**getEntityUseCodes**](#getentityusecodes) | **GET** /organization/tax/{type}/entity-use-codes | Get Entity Use Codes|
10
- |[**getTaxCodes**](#gettaxcodes) | **GET** /organization/tax/{type}/tax-codes | Get Tax Codes|
11
- |[**getTaxIntegration**](#gettaxintegration) | **GET** /organization/tax/{type} | Get Tax Integration|
12
- |[**getTaxIntegrations**](#gettaxintegrations) | **GET** /organization/tax | Get Tax Integrations|
13
- |[**getTaxLog**](#gettaxlog) | **GET** /organization/tax/{type}/logs/{logId} | Get Tax Log|
14
- |[**getTaxLogs**](#gettaxlogs) | **GET** /organization/tax/{type}/logs | Get Tax Logs|
15
- |[**testTaxIntegration**](#testtaxintegration) | **POST** /organization/tax/{type}/test | Test Tax Integration|
16
- |[**toggleTaxIntegration**](#toggletaxintegration) | **PUT** /organization/tax/{type}/toggle | Toggle Tax Integration|
17
- |[**updateTaxIntegration**](#updatetaxintegration) | **PUT** /organization/tax/{type} | Update Tax Integration|
7
+ |[**createTaxIntegration**](#createtaxintegration) | **POST** /organization/tax/{type} | Create an organization tax integration|
8
+ |[**deleteTaxIntegration**](#deletetaxintegration) | **DELETE** /organization/tax/{type} | Delete an organization tax integration|
9
+ |[**getEntityUseCodes**](#getentityusecodes) | **GET** /organization/tax/{type}/entity-use-codes | List entity use codes for a tax integration|
10
+ |[**getTaxCodes**](#gettaxcodes) | **GET** /organization/tax/{type}/tax-codes | List tax codes for a tax integration|
11
+ |[**getTaxIntegration**](#gettaxintegration) | **GET** /organization/tax/{type} | Get an organization tax integration|
12
+ |[**getTaxIntegrations**](#gettaxintegrations) | **GET** /organization/tax | List configured tax integrations|
13
+ |[**getTaxLog**](#gettaxlog) | **GET** /organization/tax/{type}/logs/{logId} | Get a single tax integration log entry|
14
+ |[**getTaxLogs**](#gettaxlogs) | **GET** /organization/tax/{type}/logs | List logs for a tax integration|
15
+ |[**testTaxIntegration**](#testtaxintegration) | **POST** /organization/tax/{type}/test | Test a tax integration connection|
16
+ |[**toggleTaxIntegration**](#toggletaxintegration) | **PUT** /organization/tax/{type}/toggle | Enable or disable a tax integration|
17
+ |[**updateTaxIntegration**](#updatetaxintegration) | **PUT** /organization/tax/{type} | Update a tax integration\'s settings|
18
18
 
19
19
  # **createTaxIntegration**
20
20
  > GetTaxIntegration200Response createTaxIntegration(taxIntegrationCreateInputs)
21
21
 
22
- Create Tax Integration endpoint
22
+ Creates a tax integration of the given type (e.g. Avalara) for the current organization using the supplied credentials/settings, requiring update permission on the org resource.
23
23
 
24
24
  ### Example
25
25
 
@@ -74,7 +74,7 @@ const { status, data } = await apiInstance.createTaxIntegration(
74
74
  # **deleteTaxIntegration**
75
75
  > CreateAccountInvitations200Response deleteTaxIntegration()
76
76
 
77
- Delete Tax Integration endpoint
77
+ Permanently removes the tax integration of the given type from the current organization, requiring update permission on the org resource.
78
78
 
79
79
  ### Example
80
80
 
@@ -125,7 +125,7 @@ const { status, data } = await apiInstance.deleteTaxIntegration(
125
125
  # **getEntityUseCodes**
126
126
  > GetEntityUseCodes200Response getEntityUseCodes()
127
127
 
128
- Get Entity Use Codes endpoint
128
+ Returns the list of entity use codes (exemption/usage classifications) supported by the organization\'s configured tax integration of the given type (e.g. Taxjar, Avalara); requires \"read\" permission on \"org\".
129
129
 
130
130
  ### Example
131
131
 
@@ -176,7 +176,7 @@ const { status, data } = await apiInstance.getEntityUseCodes(
176
176
  # **getTaxCodes**
177
177
  > GetTaxCodes200Response getTaxCodes()
178
178
 
179
- Get Tax Codes endpoint
179
+ Returns the list of product/service tax codes supported by the organization\'s configured tax integration of the given type (e.g. Taxjar, Avalara); requires \"read\" permission on \"org\".
180
180
 
181
181
  ### Example
182
182
 
@@ -227,7 +227,7 @@ const { status, data } = await apiInstance.getTaxCodes(
227
227
  # **getTaxIntegration**
228
228
  > GetTaxIntegration200Response getTaxIntegration()
229
229
 
230
- Get Tax Integration endpoint
230
+ Returns the configuration details of the organization\'s tax integration for the given type (e.g. Taxjar, Avalara); requires \"read\" permission on \"org\".
231
231
 
232
232
  ### Example
233
233
 
@@ -278,7 +278,7 @@ const { status, data } = await apiInstance.getTaxIntegration(
278
278
  # **getTaxIntegrations**
279
279
  > GetTaxIntegrations200Response getTaxIntegrations()
280
280
 
281
- Get Tax Integrations endpoint
281
+ Returns the organization\'s configured tax integrations (e.g. Avalara, TaxJar) with their enabled status, requiring the \"read\" permission on \"org\".
282
282
 
283
283
  ### Example
284
284
 
@@ -338,7 +338,7 @@ const { status, data } = await apiInstance.getTaxIntegrations(
338
338
  # **getTaxLog**
339
339
  > GetTaxLog200Response getTaxLog()
340
340
 
341
- Get Tax Log endpoint
341
+ Returns a single log entry for the given tax integration type and log ID, requiring the \"read\" permission on both \"org\" and \"logs\".
342
342
 
343
343
  ### Example
344
344
 
@@ -392,7 +392,7 @@ const { status, data } = await apiInstance.getTaxLog(
392
392
  # **getTaxLogs**
393
393
  > GetTaxLogs200Response getTaxLogs()
394
394
 
395
- Get Tax Logs endpoint
395
+ Returns a paginated list of log entries for the tax integration of the given type, supporting page, pageSize, orderBy, and search, and requiring the \"read\" permission on both \"org\" and \"logs\".
396
396
 
397
397
  ### Example
398
398
 
@@ -455,7 +455,7 @@ const { status, data } = await apiInstance.getTaxLogs(
455
455
  # **testTaxIntegration**
456
456
  > GetTaxIntegration200Response testTaxIntegration()
457
457
 
458
- Test Tax Integration endpoint
458
+ Verifies that the organization\'s configured tax integration (TaxJar or Avalara) of the given type has valid credentials by making a live test connection to the provider, requiring update permission on the organization.
459
459
 
460
460
  ### Example
461
461
 
@@ -506,7 +506,7 @@ const { status, data } = await apiInstance.testTaxIntegration(
506
506
  # **toggleTaxIntegration**
507
507
  > GetTaxIntegration200Response toggleTaxIntegration()
508
508
 
509
- Toggle Tax Integration endpoint
509
+ Toggles the enabled state of the organization\'s tax integration of the given type, verifying the connection and required tax codes before enabling, and requiring that no other tax integration is currently enabled; requires update permission on the organization.
510
510
 
511
511
  ### Example
512
512
 
@@ -557,7 +557,7 @@ const { status, data } = await apiInstance.toggleTaxIntegration(
557
557
  # **updateTaxIntegration**
558
558
  > GetTaxIntegration200Response updateTaxIntegration(taxIntegrationUpdateInputs)
559
559
 
560
- Update Tax Integration endpoint
560
+ Updates configuration for the organization\'s tax integration of the given type, such as sandbox mode, commit behavior, company code, and per-resource tax codes (passes, packages, reservations, add-ons, access, invoices, bookings, coupons); requires update permission on the organization.
561
561
 
562
562
  ### Example
563
563
 
@@ -4,16 +4,16 @@ All URIs are relative to *https://admin-api.connected.dev*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
- |[**createOrganizationTeamMember**](#createorganizationteammember) | **POST** /organization/team-members | Create Organization Team Member|
8
- |[**deleteOrganizationTeamMember**](#deleteorganizationteammember) | **DELETE** /organization/team-members/{teamMemberId} | Delete Organization Team Member|
9
- |[**getOrganizationTeamMember**](#getorganizationteammember) | **GET** /organization/team-members/{teamMemberId} | Get Organization Team Member|
10
- |[**getOrganizationTeamMembers**](#getorganizationteammembers) | **GET** /organization/team-members | Get Organization Team Members|
11
- |[**updateOrganizationTeamMember**](#updateorganizationteammember) | **PUT** /organization/team-members/{teamMemberId} | Update Organization Team Member|
7
+ |[**createOrganizationTeamMember**](#createorganizationteammember) | **POST** /organization/team-members | Create an organization team member|
8
+ |[**deleteOrganizationTeamMember**](#deleteorganizationteammember) | **DELETE** /organization/team-members/{teamMemberId} | Delete an organization team member|
9
+ |[**getOrganizationTeamMember**](#getorganizationteammember) | **GET** /organization/team-members/{teamMemberId} | Get an organization team member|
10
+ |[**getOrganizationTeamMembers**](#getorganizationteammembers) | **GET** /organization/team-members | List organization team members|
11
+ |[**updateOrganizationTeamMember**](#updateorganizationteammember) | **PUT** /organization/team-members/{teamMemberId} | Update an organization team member|
12
12
 
13
13
  # **createOrganizationTeamMember**
14
14
  > CreateOrganizationTeamMember200Response createOrganizationTeamMember(organizationTeamMemberCreateInputs)
15
15
 
16
- Create Organization Team Member endpoint
16
+ Creates a new team member profile (staff shown on the organization\'s public team page) with fields such as name, title, and image, assigning it the next display priority; requires update permission on the organization.
17
17
 
18
18
  ### Example
19
19
 
@@ -65,7 +65,7 @@ const { status, data } = await apiInstance.createOrganizationTeamMember(
65
65
  # **deleteOrganizationTeamMember**
66
66
  > CreateAccountInvitations200Response deleteOrganizationTeamMember()
67
67
 
68
- Delete Organization Team Member endpoint
68
+ Permanently removes the specified team member from the organization and re-sequences the display priority of the remaining team members; requires update permission on the organization.
69
69
 
70
70
  ### Example
71
71
 
@@ -116,7 +116,7 @@ const { status, data } = await apiInstance.deleteOrganizationTeamMember(
116
116
  # **getOrganizationTeamMember**
117
117
  > SyncAccounts200Response getOrganizationTeamMember()
118
118
 
119
- Get Organization Team Member endpoint
119
+ Returns a single organization team member by ID, requiring the \"read\" permission on \"org\".
120
120
 
121
121
  ### Example
122
122
 
@@ -167,7 +167,7 @@ const { status, data } = await apiInstance.getOrganizationTeamMember(
167
167
  # **getOrganizationTeamMembers**
168
168
  > GetOrganizationTeamMembers200Response getOrganizationTeamMembers()
169
169
 
170
- Get Organization Team Members endpoint
170
+ Returns a paginated list of the organization\'s internal team members, supporting page, pageSize, orderBy, and search, and requiring the \"read\" permission on \"org\".
171
171
 
172
172
  ### Example
173
173
 
@@ -227,7 +227,7 @@ const { status, data } = await apiInstance.getOrganizationTeamMembers(
227
227
  # **updateOrganizationTeamMember**
228
228
  > CreateOrganizationTeamMember200Response updateOrganizationTeamMember()
229
229
 
230
- Update Organization Team Member endpoint
230
+ Updates the specified team member\'s details (name, title, image, etc.) and, if a new display priority is provided, re-sequences the priority of the other team members accordingly; requires update permission on the organization.
231
231
 
232
232
  ### Example
233
233
 
@@ -4,14 +4,14 @@ All URIs are relative to *https://admin-api.connected.dev*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
- |[**addOrganizationUser**](#addorganizationuser) | **POST** /organization/users | Add Organization User|
8
- |[**deleteOrganizationUser**](#deleteorganizationuser) | **DELETE** /organization/users/{userId} | Delete Organization User|
9
- |[**getOrganizationUsers**](#getorganizationusers) | **GET** /organization/users | Get Organization Users|
7
+ |[**addOrganizationUser**](#addorganizationuser) | **POST** /organization/users | Add a user to the organization|
8
+ |[**deleteOrganizationUser**](#deleteorganizationuser) | **DELETE** /organization/users/{userId} | Remove a user from the organization|
9
+ |[**getOrganizationUsers**](#getorganizationusers) | **GET** /organization/users | List organization member users|
10
10
 
11
11
  # **addOrganizationUser**
12
12
  > AddOrganizationUser200Response addOrganizationUser()
13
13
 
14
- Add Organization User endpoint
14
+ Looks up an existing platform user by email and creates an organization membership for them with default (no) permissions, granting them access as an admin team member; requires create permission on users.
15
15
 
16
16
  ### Example
17
17
 
@@ -62,7 +62,7 @@ const { status, data } = await apiInstance.addOrganizationUser(
62
62
  # **deleteOrganizationUser**
63
63
  > CreateAccountInvitations200Response deleteOrganizationUser()
64
64
 
65
- Delete Organization User endpoint
65
+ Deletes the organization membership for the given user, revoking their admin access to the organization; a user cannot delete their own membership, and the caller needs delete permission on users.
66
66
 
67
67
  ### Example
68
68
 
@@ -113,7 +113,7 @@ const { status, data } = await apiInstance.deleteOrganizationUser(
113
113
  # **getOrganizationUsers**
114
114
  > GetOrganizationUsers200Response getOrganizationUsers()
115
115
 
116
- Get Organization Users endpoint
116
+ Returns a paginated list of users who are members of the organization, supporting page, pageSize, orderBy, and search, and requiring the \"read\" permission on both \"org\" and \"users\".
117
117
 
118
118
  ### Example
119
119
 
@@ -4,17 +4,17 @@ All URIs are relative to *https://admin-api.connected.dev*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
- |[**createOrganizationWebhook**](#createorganizationwebhook) | **POST** /organization/webhooks | Create Organization Webhook|
8
- |[**deleteOrganizationWebhook**](#deleteorganizationwebhook) | **DELETE** /organization/webhooks/{webhookId} | Delete Organization Webhook|
9
- |[**getOrganizationWebhook**](#getorganizationwebhook) | **GET** /organization/webhooks/{webhookId} | Get Organization Webhook|
10
- |[**getOrganizationWebhooks**](#getorganizationwebhooks) | **GET** /organization/webhooks | Get Organization Webhooks|
11
- |[**updateOrganizationWebhook**](#updateorganizationwebhook) | **PUT** /organization/webhooks/{webhookId} | Update Organization Webhook|
12
- |[**verifyOrganizationWebhook**](#verifyorganizationwebhook) | **POST** /organization/webhooks/{webhookId}/verify | Verify Organization Webhook|
7
+ |[**createOrganizationWebhook**](#createorganizationwebhook) | **POST** /organization/webhooks | Create an organization webhook|
8
+ |[**deleteOrganizationWebhook**](#deleteorganizationwebhook) | **DELETE** /organization/webhooks/{webhookId} | Delete an organization webhook|
9
+ |[**getOrganizationWebhook**](#getorganizationwebhook) | **GET** /organization/webhooks/{webhookId} | Get an organization webhook|
10
+ |[**getOrganizationWebhooks**](#getorganizationwebhooks) | **GET** /organization/webhooks | List an organization\'s webhooks|
11
+ |[**updateOrganizationWebhook**](#updateorganizationwebhook) | **PUT** /organization/webhooks/{webhookId} | Update an organization webhook|
12
+ |[**verifyOrganizationWebhook**](#verifyorganizationwebhook) | **POST** /organization/webhooks/{webhookId}/verify | Verify an organization webhook endpoint|
13
13
 
14
14
  # **createOrganizationWebhook**
15
15
  > CreateOrganizationWebhook200Response createOrganizationWebhook(webhookCreateInputs)
16
16
 
17
- Create Organization Webhook endpoint
17
+ Registers a new outbound webhook endpoint for the organization with a name, URL, and secret, requires organization read and update permissions; the new webhook starts unverified until the verify endpoint is called.
18
18
 
19
19
  ### Example
20
20
 
@@ -66,7 +66,7 @@ const { status, data } = await apiInstance.createOrganizationWebhook(
66
66
  # **deleteOrganizationWebhook**
67
67
  > CreateAccountInvitations200Response deleteOrganizationWebhook()
68
68
 
69
- Delete Organization Webhook endpoint
69
+ Permanently removes the specified webhook endpoint from the organization so it no longer receives event deliveries, requires organization read and update permissions.
70
70
 
71
71
  ### Example
72
72
 
@@ -117,7 +117,7 @@ const { status, data } = await apiInstance.deleteOrganizationWebhook(
117
117
  # **getOrganizationWebhook**
118
118
  > CreateOrganizationWebhook200Response getOrganizationWebhook()
119
119
 
120
- Get Organization Webhook endpoint
120
+ Retrieves a single outbound webhook configuration by ID for the current organization, including its URL, subscribed events, and status; requires read permission on the org resource.
121
121
 
122
122
  ### Example
123
123
 
@@ -168,7 +168,7 @@ const { status, data } = await apiInstance.getOrganizationWebhook(
168
168
  # **getOrganizationWebhooks**
169
169
  > GetOrganizationWebhooks200Response getOrganizationWebhooks()
170
170
 
171
- Get Organization Webhooks endpoint
171
+ Returns a paginated, searchable list of outbound webhook configurations registered for the current organization, matching on name, URL, or ID and supporting sorting via orderBy; requires read permission on the org resource.
172
172
 
173
173
  ### Example
174
174
 
@@ -228,7 +228,7 @@ const { status, data } = await apiInstance.getOrganizationWebhooks(
228
228
  # **updateOrganizationWebhook**
229
229
  > CreateOrganizationWebhook200Response updateOrganizationWebhook(webhookUpdateInputs)
230
230
 
231
- Update Organization Webhook endpoint
231
+ Modifies an existing webhook\'s name, URL, secret, or other settings for the organization, requires organization read and update permissions.
232
232
 
233
233
  ### Example
234
234
 
@@ -283,7 +283,7 @@ const { status, data } = await apiInstance.updateOrganizationWebhook(
283
283
  # **verifyOrganizationWebhook**
284
284
  > CreateOrganizationWebhook200Response verifyOrganizationWebhook()
285
285
 
286
- Verify Organization Webhook endpoint
286
+ Sends a signed test payload to the webhook\'s URL and, if delivery succeeds, marks the webhook as verified so it can start receiving real event deliveries, requires organization read and update permissions.
287
287
 
288
288
  ### Example
289
289
 
@@ -4,12 +4,12 @@ All URIs are relative to *https://admin-api.connected.dev*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
- |[**updatePayment**](#updatepayment) | **PUT** /payments/{paymentId} | Update Payment|
7
+ |[**updatePayment**](#updatepayment) | **PUT** /payments/{paymentId} | Update a payment record|
8
8
 
9
9
  # **updatePayment**
10
10
  > GetPayment200Response updatePayment(paymentUpdateInputs)
11
11
 
12
- Update Payment endpoint
12
+ Updates fields on an existing payment, such as linking or unlinking it to a registration, requires read and update permissions on payments.
13
13
 
14
14
  ### Example
15
15
 
@@ -4,13 +4,13 @@ All URIs are relative to *https://admin-api.connected.dev*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
- |[**getPreferences**](#getpreferences) | **GET** /preferences | Get Preferences|
8
- |[**updatePreferences**](#updatepreferences) | **PUT** /preferences | Update Preferences|
7
+ |[**getPreferences**](#getpreferences) | **GET** /preferences | Get the current user\'s notification preferences|
8
+ |[**updatePreferences**](#updatepreferences) | **PUT** /preferences | Update the current admin user\'s notification preferences|
9
9
 
10
10
  # **getPreferences**
11
11
  > GetPreferences200Response getPreferences()
12
12
 
13
- Get Preferences endpoint
13
+ Returns the calling admin user\'s support ticket notification preferences (in-app and email) for the current organization membership.
14
14
 
15
15
  ### Example
16
16
 
@@ -54,7 +54,7 @@ This endpoint does not have any parameters.
54
54
  # **updatePreferences**
55
55
  > GetPreferences200Response updatePreferences(adminNotificationPreferencesUpdateInputs)
56
56
 
57
- Update Preferences endpoint
57
+ Updates the calling admin user\'s own support ticket notification settings (in-app and email toggles for new, assigned, and message-received tickets) for their organization membership.
58
58
 
59
59
  ### Example
60
60
 
@@ -4,14 +4,14 @@ All URIs are relative to *https://admin-api.connected.dev*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
- |[**deletePushDevice**](#deletepushdevice) | **DELETE** /push-devices/{pushDeviceId} | Delete Push Device|
8
- |[**getPushDevice**](#getpushdevice) | **GET** /push-devices/{pushDeviceId} | Get Push Device|
9
- |[**getPushDevices**](#getpushdevices) | **GET** /push-devices | Get Push Devices|
7
+ |[**deletePushDevice**](#deletepushdevice) | **DELETE** /push-devices/{pushDeviceId} | Delete a registered push notification device|
8
+ |[**getPushDevice**](#getpushdevice) | **GET** /push-devices/{pushDeviceId} | Get a registered push device|
9
+ |[**getPushDevices**](#getpushdevices) | **GET** /push-devices | List registered push devices|
10
10
 
11
11
  # **deletePushDevice**
12
12
  > CreateAccountInvitations200Response deletePushDevice()
13
13
 
14
- Delete Push Device endpoint
14
+ Removes a mobile push device registration by its ID so it no longer receives push notifications, requires read and update permissions on accounts.
15
15
 
16
16
  ### Example
17
17
 
@@ -62,7 +62,7 @@ const { status, data } = await apiInstance.deletePushDevice(
62
62
  # **getPushDevice**
63
63
  > GetPushDevice200Response getPushDevice()
64
64
 
65
- Get Push Device endpoint
65
+ Retrieves a single registered push notification device by its ID, including its device token and associated account; requires read permission on the accounts resource.
66
66
 
67
67
  ### Example
68
68
 
@@ -113,7 +113,7 @@ const { status, data } = await apiInstance.getPushDevice(
113
113
  # **getPushDevices**
114
114
  > GetLoginDevices200Response getPushDevices()
115
115
 
116
- Get Push Devices endpoint
116
+ Returns a paginated, searchable list of registered push notification devices across the organization, optionally filtered to a single account by accountId and sortable via orderBy; requires read permission on the accounts resource.
117
117
 
118
118
  ### Example
119
119