@connectedxm/admin-sdk 7.4.1 → 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 (202) hide show
  1. package/README.md +1212 -1209
  2. package/api.ts +10059 -9672
  3. package/dist/api.d.ts +9869 -9672
  4. package/dist/api.js +9948 -9672
  5. package/dist/esm/api.d.ts +9869 -9672
  6. package/dist/esm/api.js +9948 -9672
  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/Coupon.md +4 -0
  40. package/docs/DashboardsApi.md +10 -10
  41. package/docs/DashboardsWidgetsApi.md +8 -8
  42. package/docs/EmailReceiptsApi.md +4 -4
  43. package/docs/EventsAccessApi.md +6 -6
  44. package/docs/EventsActivationsApi.md +22 -22
  45. package/docs/EventsActivationsSessionsApi.md +6 -6
  46. package/docs/EventsActivationsTranslationsApi.md +8 -8
  47. package/docs/EventsAddonsApi.md +24 -24
  48. package/docs/EventsAddonsTranslationsApi.md +8 -8
  49. package/docs/EventsApi.md +22 -22
  50. package/docs/EventsAttendeesApi.md +24 -24
  51. package/docs/EventsAttendeesPackagesApi.md +10 -10
  52. package/docs/EventsAttendeesReservationsApi.md +18 -18
  53. package/docs/EventsAttributesApi.md +10 -10
  54. package/docs/EventsBenefitsApi.md +4 -4
  55. package/docs/EventsBlocksApi.md +16 -16
  56. package/docs/EventsBypassApi.md +10 -10
  57. package/docs/EventsCohostsApi.md +6 -6
  58. package/docs/EventsCouponsApi.md +214 -22
  59. package/docs/EventsEmailsApi.md +4 -4
  60. package/docs/EventsEmailsTranslationsApi.md +8 -8
  61. package/docs/EventsFaqsApi.md +22 -22
  62. package/docs/EventsFaqsTranslationsApi.md +16 -16
  63. package/docs/EventsFollowupsApi.md +38 -38
  64. package/docs/EventsFollowupsTranslationsApi.md +8 -8
  65. package/docs/EventsMatchesApi.md +34 -34
  66. package/docs/EventsMediaApi.md +16 -16
  67. package/docs/EventsMediaTranslationsApi.md +8 -8
  68. package/docs/EventsOnSiteApi.md +6 -6
  69. package/docs/EventsPackagesApi.md +10 -10
  70. package/docs/EventsPackagesPassesApi.md +10 -10
  71. package/docs/EventsPackagesTranslationsApi.md +8 -8
  72. package/docs/EventsPagesApi.md +16 -16
  73. package/docs/EventsPagesTranslationsApi.md +8 -8
  74. package/docs/EventsPassesAccessesApi.md +10 -10
  75. package/docs/EventsPassesAddonsApi.md +6 -6
  76. package/docs/EventsPassesApi.md +34 -34
  77. package/docs/EventsPassesAttributesApi.md +6 -6
  78. package/docs/EventsPassesFollowupsApi.md +8 -8
  79. package/docs/EventsPassesResponsesApi.md +10 -10
  80. package/docs/EventsPasstypesApi.md +34 -34
  81. package/docs/EventsPasstypesPriceschedulesApi.md +10 -10
  82. package/docs/EventsPasstypesRefundschedulesApi.md +10 -10
  83. package/docs/EventsPasstypesTranslationsApi.md +8 -8
  84. package/docs/EventsQuestionsApi.md +44 -44
  85. package/docs/EventsQuestionsTranslationsApi.md +16 -16
  86. package/docs/EventsRoomsApi.md +18 -18
  87. package/docs/EventsRoomtypesApi.md +24 -24
  88. package/docs/EventsRoomtypesTranslationsApi.md +8 -8
  89. package/docs/EventsSectionsApi.md +38 -38
  90. package/docs/EventsSectionsTranslationsApi.md +8 -8
  91. package/docs/EventsSessionsAccessesApi.md +6 -6
  92. package/docs/EventsSessionsApi.md +70 -70
  93. package/docs/EventsSessionsLocationsApi.md +16 -16
  94. package/docs/EventsSessionsLocationsTranslationsApi.md +8 -8
  95. package/docs/EventsSessionsMatchesApi.md +32 -32
  96. package/docs/EventsSessionsPricesApi.md +6 -6
  97. package/docs/EventsSessionsQuestionsApi.md +38 -38
  98. package/docs/EventsSessionsQuestionsTranslationsApi.md +16 -16
  99. package/docs/EventsSessionsSectionsApi.md +20 -20
  100. package/docs/EventsSessionsSectionsTranslationsApi.md +8 -8
  101. package/docs/EventsSessionsTimesApi.md +16 -16
  102. package/docs/EventsSessionsTimesTranslationsApi.md +8 -8
  103. package/docs/EventsSessionsTranslationsApi.md +8 -8
  104. package/docs/EventsSpeakersApi.md +16 -16
  105. package/docs/EventsSpeakersTranslationsApi.md +8 -8
  106. package/docs/EventsSponsorsApi.md +8 -8
  107. package/docs/EventsSponsorshiplevelsApi.md +12 -12
  108. package/docs/EventsSponsorshiplevelsTranslationsApi.md +8 -8
  109. package/docs/EventsSponsorshipsApi.md +12 -12
  110. package/docs/EventsSponsorshipsTranslationsApi.md +8 -8
  111. package/docs/EventsTemplatesApi.md +2 -2
  112. package/docs/EventsTracksApi.md +22 -22
  113. package/docs/EventsTracksTranslationsApi.md +8 -8
  114. package/docs/EventsTransfersApi.md +4 -4
  115. package/docs/EventsTranslationsApi.md +8 -8
  116. package/docs/FilesApi.md +4 -4
  117. package/docs/GroupsApi.md +12 -12
  118. package/docs/GroupsEventsApi.md +6 -6
  119. package/docs/GroupsInterestsApi.md +6 -6
  120. package/docs/GroupsInvitationsApi.md +12 -12
  121. package/docs/GroupsMembersApi.md +8 -8
  122. package/docs/GroupsModeratorsApi.md +6 -6
  123. package/docs/GroupsRequestsApi.md +10 -10
  124. package/docs/GroupsSponsorsApi.md +6 -6
  125. package/docs/GroupsTranslationsApi.md +8 -8
  126. package/docs/ImportsApi.md +8 -8
  127. package/docs/InterestsApi.md +22 -22
  128. package/docs/InvoicesApi.md +20 -20
  129. package/docs/InvoicesLineitemsApi.md +6 -6
  130. package/docs/LoginsAccountsApi.md +6 -6
  131. package/docs/LoginsApi.md +16 -16
  132. package/docs/MeetingsApi.md +14 -14
  133. package/docs/MeetingsLinksApi.md +10 -10
  134. package/docs/MeetingsLivestreamsApi.md +12 -12
  135. package/docs/MeetingsParticipantsApi.md +12 -12
  136. package/docs/MeetingsPresetsApi.md +10 -10
  137. package/docs/MeetingsRecordingsApi.md +4 -4
  138. package/docs/MeetingsSessionsApi.md +16 -16
  139. package/docs/NotificationsApi.md +8 -8
  140. package/docs/OrganizationApi.md +18 -18
  141. package/docs/OrganizationAttributesApi.md +14 -14
  142. package/docs/OrganizationDomainsApi.md +6 -6
  143. package/docs/OrganizationIntegrationsApi.md +10 -10
  144. package/docs/OrganizationModulesApi.md +6 -6
  145. package/docs/OrganizationModulesCustomApi.md +10 -10
  146. package/docs/OrganizationModulesCustomTranslationsApi.md +8 -8
  147. package/docs/OrganizationModulesSettingsApi.md +4 -4
  148. package/docs/OrganizationModulesSettingsTranslationsApi.md +8 -8
  149. package/docs/OrganizationModulesTiersApi.md +12 -12
  150. package/docs/OrganizationPaymentsApi.md +20 -20
  151. package/docs/OrganizationSideeffectsApi.md +8 -8
  152. package/docs/OrganizationTaxApi.md +22 -22
  153. package/docs/OrganizationTeammembersApi.md +10 -10
  154. package/docs/OrganizationUsersApi.md +6 -6
  155. package/docs/OrganizationWebhooksApi.md +12 -12
  156. package/docs/PaymentsApi.md +2 -2
  157. package/docs/PreferencesApi.md +4 -4
  158. package/docs/PushDevicesApi.md +6 -6
  159. package/docs/ReportsApi.md +22 -22
  160. package/docs/ReportsUsersApi.md +6 -6
  161. package/docs/SearchlistsApi.md +10 -10
  162. package/docs/SearchlistsValuesApi.md +14 -14
  163. package/docs/SelfApi.md +10 -10
  164. package/docs/SelfApikeysApi.md +8 -8
  165. package/docs/SelfImagesApi.md +4 -4
  166. package/docs/SeriesApi.md +18 -18
  167. package/docs/SeriesQuestionsApi.md +14 -14
  168. package/docs/SeriesQuestionsChoicesApi.md +8 -8
  169. package/docs/SeriesQuestionsTranslationsApi.md +4 -4
  170. package/docs/SeriesRegistrationsApi.md +18 -18
  171. package/docs/SeriesTranslationsApi.md +8 -8
  172. package/docs/SponsorsAccountsApi.md +6 -6
  173. package/docs/SponsorsApi.md +10 -10
  174. package/docs/SponsorsTranslationsApi.md +8 -8
  175. package/docs/StorageFilesApi.md +6 -6
  176. package/docs/StorageImagesApi.md +18 -18
  177. package/docs/StorageVideosApi.md +14 -14
  178. package/docs/StorageVideosCaptionsApi.md +10 -10
  179. package/docs/StreamsApi.md +14 -14
  180. package/docs/StreamsOutputsApi.md +10 -10
  181. package/docs/StreamsSessionsApi.md +12 -12
  182. package/docs/SupportApi.md +14 -14
  183. package/docs/SupportMessagesApi.md +4 -4
  184. package/docs/SupportNotesApi.md +6 -6
  185. package/docs/SurveysApi.md +12 -12
  186. package/docs/SurveysQuestionsApi.md +38 -38
  187. package/docs/SurveysQuestionsTranslationsApi.md +16 -16
  188. package/docs/SurveysSectionsApi.md +20 -20
  189. package/docs/SurveysSectionsTranslationsApi.md +8 -8
  190. package/docs/SurveysSessionsApi.md +4 -4
  191. package/docs/SurveysSubmissionsApi.md +14 -14
  192. package/docs/SurveysTranslationsApi.md +8 -8
  193. package/docs/ThreadsAccountsApi.md +8 -8
  194. package/docs/ThreadsApi.md +10 -10
  195. package/docs/ThreadsMessagesApi.md +12 -12
  196. package/docs/ThreadsMessagesFilesApi.md +6 -6
  197. package/docs/ThreadsMessagesImagesApi.md +6 -6
  198. package/docs/ThreadsMessagesReactionsApi.md +6 -6
  199. package/docs/ThreadsMessagesVideosApi.md +6 -6
  200. package/docs/ThreadsStorageApi.md +6 -6
  201. package/docs/TiersApi.md +20 -20
  202. package/package.json +1 -1
@@ -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
- |[**cancelGroupInvitation**](#cancelgroupinvitation) | **PUT** /groups/{groupId}/invitations/{invitationId}/cancel | Cancel Group Invitation|
8
- |[**createGroupInvitations**](#creategroupinvitations) | **POST** /groups/{groupId}/invitations | Create Group Invitations|
9
- |[**deleteGroupInvitation**](#deletegroupinvitation) | **DELETE** /groups/{groupId}/invitations/{invitationId} | Delete Group Invitation|
10
- |[**getGroupInvitation**](#getgroupinvitation) | **GET** /groups/{groupId}/invitations/{invitationId} | Get Group Invitation|
11
- |[**getGroupInvitations**](#getgroupinvitations) | **GET** /groups/{groupId}/invitations | Get Group Invitations|
12
- |[**reinviteGroupInvitation**](#reinvitegroupinvitation) | **PUT** /groups/{groupId}/invitations/{invitationId}/reinvite | Reinvite Group Invitation|
7
+ |[**cancelGroupInvitation**](#cancelgroupinvitation) | **PUT** /groups/{groupId}/invitations/{invitationId}/cancel | Cancel a group invitation|
8
+ |[**createGroupInvitations**](#creategroupinvitations) | **POST** /groups/{groupId}/invitations | Invite accounts to join a group|
9
+ |[**deleteGroupInvitation**](#deletegroupinvitation) | **DELETE** /groups/{groupId}/invitations/{invitationId} | Permanently delete a group invitation|
10
+ |[**getGroupInvitation**](#getgroupinvitation) | **GET** /groups/{groupId}/invitations/{invitationId} | Get a single group invitation|
11
+ |[**getGroupInvitations**](#getgroupinvitations) | **GET** /groups/{groupId}/invitations | List a group\'s invitations|
12
+ |[**reinviteGroupInvitation**](#reinvitegroupinvitation) | **PUT** /groups/{groupId}/invitations/{invitationId}/reinvite | Reinvite a canceled group invitation|
13
13
 
14
14
  # **cancelGroupInvitation**
15
15
  > GetGroupInvitation200Response cancelGroupInvitation()
16
16
 
17
- Cancel Group Invitation endpoint
17
+ Marks a pending group invitation as canceled so the invited account can no longer accept it, requiring update permission on groups; the group\'s invitations list is invalidated.
18
18
 
19
19
  ### Example
20
20
 
@@ -68,7 +68,7 @@ const { status, data } = await apiInstance.cancelGroupInvitation(
68
68
  # **createGroupInvitations**
69
69
  > CreateGroupInvitations200Response createGroupInvitations()
70
70
 
71
- Create Group Invitations endpoint
71
+ Creates up to 10 pending invitations for the given account IDs to join a group on behalf of a moderator account, requiring update permission on groups; the group\'s invitations list is invalidated.
72
72
 
73
73
  ### Example
74
74
 
@@ -125,7 +125,7 @@ const { status, data } = await apiInstance.createGroupInvitations(
125
125
  # **deleteGroupInvitation**
126
126
  > CreateAccountInvitations200Response deleteGroupInvitation()
127
127
 
128
- Delete Group Invitation endpoint
128
+ Removes a group invitation record entirely, requiring update permission on groups; the group\'s invitations list is invalidated.
129
129
 
130
130
  ### Example
131
131
 
@@ -179,7 +179,7 @@ const { status, data } = await apiInstance.deleteGroupInvitation(
179
179
  # **getGroupInvitation**
180
180
  > GetGroupInvitation200Response getGroupInvitation()
181
181
 
182
- Get Group Invitation endpoint
182
+ Returns the details of a single invitation to the given group by its invitation ID, including its status (invited, canceled, rejected, or accepted); requires \"read\" permission on groups.
183
183
 
184
184
  ### Example
185
185
 
@@ -233,7 +233,7 @@ const { status, data } = await apiInstance.getGroupInvitation(
233
233
  # **getGroupInvitations**
234
234
  > GetGroupInvitations200Response getGroupInvitations()
235
235
 
236
- Get Group Invitations endpoint
236
+ Returns a paginated list of invitations sent for the given group, filterable by status (e.g. invited, canceled, rejected, accepted) and a search term, with sorting via orderBy; requires \"read\" permission on groups.
237
237
 
238
238
  ### Example
239
239
 
@@ -299,7 +299,7 @@ const { status, data } = await apiInstance.getGroupInvitations(
299
299
  # **reinviteGroupInvitation**
300
300
  > GetGroupInvitation200Response reinviteGroupInvitation()
301
301
 
302
- Reinvite Group Invitation endpoint
302
+ Restores a previously canceled group invitation back to invited status so the account can accept it again, requiring update permission on groups; the group\'s invitations list is invalidated.
303
303
 
304
304
  ### Example
305
305
 
@@ -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
- |[**addGroupMember**](#addgroupmember) | **POST** /groups/{groupId}/members/{accountId} | Add Group Member|
8
- |[**getGroupMembers**](#getgroupmembers) | **GET** /groups/{groupId}/members | Get Group Members|
9
- |[**removeAllGroupMembers**](#removeallgroupmembers) | **DELETE** /groups/{groupId}/members | Remove All Group Members|
10
- |[**removeGroupMember**](#removegroupmember) | **DELETE** /groups/{groupId}/members/{accountId} | Remove Group Member|
7
+ |[**addGroupMember**](#addgroupmember) | **POST** /groups/{groupId}/members/{accountId} | Add a member to a group|
8
+ |[**getGroupMembers**](#getgroupmembers) | **GET** /groups/{groupId}/members | List a group\'s members|
9
+ |[**removeAllGroupMembers**](#removeallgroupmembers) | **DELETE** /groups/{groupId}/members | Remove all members from a group|
10
+ |[**removeGroupMember**](#removegroupmember) | **DELETE** /groups/{groupId}/members/{accountId} | Remove a member from a group|
11
11
 
12
12
  # **addGroupMember**
13
13
  > AddAccountGroup200Response addGroupMember()
14
14
 
15
- Add Group Member endpoint
15
+ Creates a membership record adding an account to a group with the default member role, requiring update permission on both groups and accounts; the group\'s members list and the account\'s groups list are invalidated.
16
16
 
17
17
  ### Example
18
18
 
@@ -66,7 +66,7 @@ const { status, data } = await apiInstance.addGroupMember(
66
66
  # **getGroupMembers**
67
67
  > GetAccountGroups200Response getGroupMembers()
68
68
 
69
- Get Group Members endpoint
69
+ Returns a paginated list of accounts with the \"member\" role in the given group, optionally filtered by a search term matching the account\'s name or email and sorted via orderBy; requires \"read\" permission on groups and accounts.
70
70
 
71
71
  ### Example
72
72
 
@@ -129,7 +129,7 @@ const { status, data } = await apiInstance.getGroupMembers(
129
129
  # **removeAllGroupMembers**
130
130
  > CreateGroup200Response removeAllGroupMembers()
131
131
 
132
- Remove All Group Members endpoint
132
+ Deletes every membership record for a group, clearing all of its members and moderators at once, requiring read/update/delete permission on groups and accounts; the group\'s cached data, members list, and moderators list are invalidated.
133
133
 
134
134
  ### Example
135
135
 
@@ -180,7 +180,7 @@ const { status, data } = await apiInstance.removeAllGroupMembers(
180
180
  # **removeGroupMember**
181
181
  > AddAccountGroup200Response removeGroupMember()
182
182
 
183
- Remove Group Member endpoint
183
+ Removes the specified account\'s membership from the given group, deleting their group membership record entirely; requires read and update permissions on both groups and accounts.
184
184
 
185
185
  ### Example
186
186
 
@@ -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
- |[**addGroupModerator**](#addgroupmoderator) | **POST** /groups/{groupId}/moderators/{accountId} | Add Group Moderator|
8
- |[**getGroupModerators**](#getgroupmoderators) | **GET** /groups/{groupId}/moderators | Get Group Moderators|
9
- |[**removeGroupModerator**](#removegroupmoderator) | **DELETE** /groups/{groupId}/moderators/{accountId} | Remove Group Moderator|
7
+ |[**addGroupModerator**](#addgroupmoderator) | **POST** /groups/{groupId}/moderators/{accountId} | Promote a group member to moderator|
8
+ |[**getGroupModerators**](#getgroupmoderators) | **GET** /groups/{groupId}/moderators | List a group\'s moderators|
9
+ |[**removeGroupModerator**](#removegroupmoderator) | **DELETE** /groups/{groupId}/moderators/{accountId} | Demote a group moderator to member|
10
10
 
11
11
  # **addGroupModerator**
12
12
  > AddAccountGroup200Response addGroupModerator()
13
13
 
14
- Add Group Moderator endpoint
14
+ Promotes the specified account to moderator of the given group, creating a moderator-role membership if none exists and clearing any pending join requests or invitations for that account; requires read and update permissions on both groups and accounts.
15
15
 
16
16
  ### Example
17
17
 
@@ -65,7 +65,7 @@ const { status, data } = await apiInstance.addGroupModerator(
65
65
  # **getGroupModerators**
66
66
  > GetAccountGroups200Response getGroupModerators()
67
67
 
68
- Get Group Moderators endpoint
68
+ Returns a paginated list of accounts with the \"moderator\" role in the given group, optionally filtered by a search term matching the account\'s name or email and sorted via orderBy; requires \"read\" permission on groups and accounts.
69
69
 
70
70
  ### Example
71
71
 
@@ -128,7 +128,7 @@ const { status, data } = await apiInstance.getGroupModerators(
128
128
  # **removeGroupModerator**
129
129
  > AddAccountGroup200Response removeGroupModerator()
130
130
 
131
- Remove Group Moderator endpoint
131
+ Demotes the specified account from moderator back to a regular member of the given group; requires read and update permissions on both groups and accounts.
132
132
 
133
133
  ### Example
134
134
 
@@ -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
- |[**acceptGroupRequest**](#acceptgrouprequest) | **PUT** /groups/{groupId}/requests/{requestId}/accept | Accept Group Request|
8
- |[**deleteGroupRequest**](#deletegrouprequest) | **DELETE** /groups/{groupId}/requests/{requestId} | Delete Group Request|
9
- |[**getGroupRequest**](#getgrouprequest) | **GET** /groups/{groupId}/requests/{requestId} | Get Group Request|
10
- |[**getGroupRequests**](#getgrouprequests) | **GET** /groups/{groupId}/requests | Get Group Requests|
11
- |[**rejectGroupRequest**](#rejectgrouprequest) | **PUT** /groups/{groupId}/requests/{requestId}/reject | Reject Group Request|
7
+ |[**acceptGroupRequest**](#acceptgrouprequest) | **PUT** /groups/{groupId}/requests/{requestId}/accept | Accept a group join request|
8
+ |[**deleteGroupRequest**](#deletegrouprequest) | **DELETE** /groups/{groupId}/requests/{requestId} | Delete a group join request|
9
+ |[**getGroupRequest**](#getgrouprequest) | **GET** /groups/{groupId}/requests/{requestId} | Get a single group join request|
10
+ |[**getGroupRequests**](#getgrouprequests) | **GET** /groups/{groupId}/requests | List a group\'s join requests|
11
+ |[**rejectGroupRequest**](#rejectgrouprequest) | **PUT** /groups/{groupId}/requests/{requestId}/reject | Reject a group join request|
12
12
 
13
13
  # **acceptGroupRequest**
14
14
  > GetGroupRequest200Response acceptGroupRequest()
15
15
 
16
- Accept Group Request endpoint
16
+ Accepts the specified pending join request for the given group, deleting the request and any related invitation, and creating a membership for the requesting account; requires read and update permissions on groups.
17
17
 
18
18
  ### Example
19
19
 
@@ -67,7 +67,7 @@ const { status, data } = await apiInstance.acceptGroupRequest(
67
67
  # **deleteGroupRequest**
68
68
  > CreateAccountInvitations200Response deleteGroupRequest()
69
69
 
70
- Delete Group Request endpoint
70
+ Permanently deletes the specified join request for the given group, regardless of its status; requires read and update permissions on groups.
71
71
 
72
72
  ### Example
73
73
 
@@ -121,7 +121,7 @@ const { status, data } = await apiInstance.deleteGroupRequest(
121
121
  # **getGroupRequest**
122
122
  > GetGroupRequest200Response getGroupRequest()
123
123
 
124
- Get Group Request endpoint
124
+ Returns the details of a single request to join the given group by its request ID, including its status (pending, accepted, or rejected); requires \"read\" permission on groups.
125
125
 
126
126
  ### Example
127
127
 
@@ -175,7 +175,7 @@ const { status, data } = await apiInstance.getGroupRequest(
175
175
  # **getGroupRequests**
176
176
  > GetGroupRequests200Response getGroupRequests()
177
177
 
178
- Get Group Requests endpoint
178
+ Returns a paginated list of join requests for the given group, filterable by request status (e.g. requested, accepted, rejected) and searchable by requester name or username; requires read access to groups.
179
179
 
180
180
  ### Example
181
181
 
@@ -241,7 +241,7 @@ const { status, data } = await apiInstance.getGroupRequests(
241
241
  # **rejectGroupRequest**
242
242
  > GetGroupRequest200Response rejectGroupRequest()
243
243
 
244
- Reject Group Request endpoint
244
+ Marks the specified pending join request for the given group as rejected without deleting it or creating a membership; requires read and update permissions on groups.
245
245
 
246
246
  ### Example
247
247
 
@@ -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
- |[**addGroupSponsor**](#addgroupsponsor) | **POST** /groups/{groupId}/sponsors/{accountId} | Add Group Sponsor|
8
- |[**getGroupSponsors**](#getgroupsponsors) | **GET** /groups/{groupId}/sponsors | Get Group Sponsors|
9
- |[**removeGroupSponsor**](#removegroupsponsor) | **DELETE** /groups/{groupId}/sponsors/{accountId} | Remove Group Sponsor|
7
+ |[**addGroupSponsor**](#addgroupsponsor) | **POST** /groups/{groupId}/sponsors/{accountId} | Add a sponsor account to a group|
8
+ |[**getGroupSponsors**](#getgroupsponsors) | **GET** /groups/{groupId}/sponsors | List a group\'s sponsor accounts|
9
+ |[**removeGroupSponsor**](#removegroupsponsor) | **DELETE** /groups/{groupId}/sponsors/{accountId} | Remove a sponsor account from a group|
10
10
 
11
11
  # **addGroupSponsor**
12
12
  > CreateGroup200Response addGroupSponsor()
13
13
 
14
- Add Group Sponsor endpoint
14
+ Connects the specified account as a sponsor of the given group; requires read and update permissions on both groups and accounts.
15
15
 
16
16
  ### Example
17
17
 
@@ -65,7 +65,7 @@ const { status, data } = await apiInstance.addGroupSponsor(
65
65
  # **getGroupSponsors**
66
66
  > GetAccounts200Response getGroupSponsors()
67
67
 
68
- Get Group Sponsors endpoint
68
+ Returns a paginated list of accounts sponsoring the given group, searchable by account name, email, or ID; requires read access to groups and accounts.
69
69
 
70
70
  ### Example
71
71
 
@@ -128,7 +128,7 @@ const { status, data } = await apiInstance.getGroupSponsors(
128
128
  # **removeGroupSponsor**
129
129
  > CreateGroup200Response removeGroupSponsor()
130
130
 
131
- Remove Group Sponsor endpoint
131
+ Disconnects the specified account as a sponsor of the given group; requires read and update permissions on both groups and accounts.
132
132
 
133
133
  ### Example
134
134
 
@@ -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
- |[**deleteGroupTranslation**](#deletegrouptranslation) | **DELETE** /groups/{groupId}/translations/{locale} | Delete Group Translation|
8
- |[**getGroupTranslation**](#getgrouptranslation) | **GET** /groups/{groupId}/translations/{locale} | Get Group Translation|
9
- |[**getGroupTranslations**](#getgrouptranslations) | **GET** /groups/{groupId}/translations | Get Group Translations|
10
- |[**updateGroupTranslation**](#updategrouptranslation) | **PUT** /groups/{groupId}/translations/{locale} | Update Group Translation|
7
+ |[**deleteGroupTranslation**](#deletegrouptranslation) | **DELETE** /groups/{groupId}/translations/{locale} | Delete a group\'s translation for a locale|
8
+ |[**getGroupTranslation**](#getgrouptranslation) | **GET** /groups/{groupId}/translations/{locale} | Get a group\'s translation for a locale|
9
+ |[**getGroupTranslations**](#getgrouptranslations) | **GET** /groups/{groupId}/translations | List a group\'s translations|
10
+ |[**updateGroupTranslation**](#updategrouptranslation) | **PUT** /groups/{groupId}/translations/{locale} | Update a group\'s translation for a locale|
11
11
 
12
12
  # **deleteGroupTranslation**
13
13
  > SyncAccounts200Response deleteGroupTranslation()
14
14
 
15
- Delete Group Translation endpoint
15
+ Permanently deletes the translated content for the given group in the specified locale; requires read and update permissions on groups.
16
16
 
17
17
  ### Example
18
18
 
@@ -66,7 +66,7 @@ const { status, data } = await apiInstance.deleteGroupTranslation(
66
66
  # **getGroupTranslation**
67
67
  > GetGroupTranslation200Response getGroupTranslation()
68
68
 
69
- Get Group Translation endpoint
69
+ Returns the translated content (e.g. name, description) for the given group in the specified locale, or null if no translation exists; requires read access to groups.
70
70
 
71
71
  ### Example
72
72
 
@@ -120,7 +120,7 @@ const { status, data } = await apiInstance.getGroupTranslation(
120
120
  # **getGroupTranslations**
121
121
  > GetGroupTranslations200Response getGroupTranslations()
122
122
 
123
- Get Group Translations endpoint
123
+ Returns a paginated list of locale translations available for the given group, with optional search and ordering; requires read access to groups.
124
124
 
125
125
  ### Example
126
126
 
@@ -183,7 +183,7 @@ const { status, data } = await apiInstance.getGroupTranslations(
183
183
  # **updateGroupTranslation**
184
184
  > SyncAccounts200Response updateGroupTranslation(groupTranslationUpdateInputs)
185
185
 
186
- Update Group Translation endpoint
186
+ Creates or updates the translated content (such as name, description, and images) for the given group in the specified locale; requires read and update permissions on groups.
187
187
 
188
188
  ### Example
189
189
 
@@ -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
- |[**createImport**](#createimport) | **POST** /imports/{type} | Create Import|
8
- |[**getImport**](#getimport) | **GET** /imports/{importId} | Get Import|
9
- |[**getImportItems**](#getimportitems) | **GET** /imports/{importId}/items | Get Import Items|
10
- |[**getImports**](#getimports) | **GET** /imports | Get Imports|
7
+ |[**createImport**](#createimport) | **POST** /imports/{type} | Start a bulk data import|
8
+ |[**getImport**](#getimport) | **GET** /imports/{importId} | Get a single import|
9
+ |[**getImportItems**](#getimportitems) | **GET** /imports/{importId}/items | List the rows in an import job|
10
+ |[**getImports**](#getimports) | **GET** /imports | List bulk import jobs|
11
11
 
12
12
  # **createImport**
13
13
  > GetImport200Response createImport()
14
14
 
15
- Create Import endpoint
15
+ Starts an asynchronous import job of the given type (currently \"account-tiers\") that queues each supplied row for background processing, such as assigning a tier to accounts by email, and requires the \"update\" permission on the organization.
16
16
 
17
17
  ### Example
18
18
 
@@ -70,7 +70,7 @@ const { status, data } = await apiInstance.createImport(
70
70
  # **getImport**
71
71
  > GetImport200Response getImport()
72
72
 
73
- Get Import endpoint
73
+ Returns the details and status of a single bulk import job by its ID; requires organization-level read access.
74
74
 
75
75
  ### Example
76
76
 
@@ -121,7 +121,7 @@ const { status, data } = await apiInstance.getImport(
121
121
  # **getImportItems**
122
122
  > GetImportItems200Response getImportItems()
123
123
 
124
- Get Import Items endpoint
124
+ Returns a paginated list of individual row items belonging to the given import job, along with each item\'s processing result, and supports search (e.g. by email for account-tier imports); requires organization-level read access.
125
125
 
126
126
  ### Example
127
127
 
@@ -184,7 +184,7 @@ const { status, data } = await apiInstance.getImportItems(
184
184
  # **getImports**
185
185
  > GetImports200Response getImports()
186
186
 
187
- Get Imports endpoint
187
+ Returns a paginated list of bulk import jobs for the organization, optionally filtered by tier and searchable by import type; requires organization-level read access.
188
188
 
189
189
  ### Example
190
190
 
@@ -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
- |[**createInterest**](#createinterest) | **POST** /interests | Create Interest|
8
- |[**deleteInterest**](#deleteinterest) | **DELETE** /interests/{interestId} | Delete Interest|
9
- |[**getInterest**](#getinterest) | **GET** /interests/{interestId} | Get Interest|
10
- |[**getInterestAccounts**](#getinterestaccounts) | **GET** /interests/{interestId}/accounts | Get Interest Accounts|
11
- |[**getInterestActivities**](#getinterestactivities) | **GET** /interests/{interestId}/activities | Get Interest Activities|
12
- |[**getInterestChannels**](#getinterestchannels) | **GET** /interests/{interestId}/channels | Get Interest Channels|
13
- |[**getInterestContents**](#getinterestcontents) | **GET** /interests/{interestId}/contents | Get Interest Contents|
14
- |[**getInterestEvents**](#getinterestevents) | **GET** /interests/{interestId}/events | Get Interest Events|
15
- |[**getInterestGroups**](#getinterestgroups) | **GET** /interests/{interestId}/groups | Get Interest Groups|
16
- |[**getInterests**](#getinterests) | **GET** /interests | Get Interests|
17
- |[**updateInterest**](#updateinterest) | **PUT** /interests/{interestId} | Update Interest|
7
+ |[**createInterest**](#createinterest) | **POST** /interests | Create or fetch an interest|
8
+ |[**deleteInterest**](#deleteinterest) | **DELETE** /interests/{interestId} | Delete an interest|
9
+ |[**getInterest**](#getinterest) | **GET** /interests/{interestId} | Get an interest|
10
+ |[**getInterestAccounts**](#getinterestaccounts) | **GET** /interests/{interestId}/accounts | List accounts tagged with an interest|
11
+ |[**getInterestActivities**](#getinterestactivities) | **GET** /interests/{interestId}/activities | List activity posts tagged with an interest|
12
+ |[**getInterestChannels**](#getinterestchannels) | **GET** /interests/{interestId}/channels | List channels tagged with an interest|
13
+ |[**getInterestContents**](#getinterestcontents) | **GET** /interests/{interestId}/contents | List content items tagged with an interest|
14
+ |[**getInterestEvents**](#getinterestevents) | **GET** /interests/{interestId}/events | List events tagged with an interest|
15
+ |[**getInterestGroups**](#getinterestgroups) | **GET** /interests/{interestId}/groups | List groups tagged with an interest|
16
+ |[**getInterests**](#getinterests) | **GET** /interests | List interests|
17
+ |[**updateInterest**](#updateinterest) | **PUT** /interests/{interestId} | Update an interest|
18
18
 
19
19
  # **createInterest**
20
20
  > CreateInterest200Response createInterest(interestCreateInputs)
21
21
 
22
- Create Interest endpoint
22
+ Creates a new interest for the organization with the given name, or returns the existing interest if one with that name already exists, and requires the \"create\" permission on interests.
23
23
 
24
24
  ### Example
25
25
 
@@ -71,7 +71,7 @@ const { status, data } = await apiInstance.createInterest(
71
71
  # **deleteInterest**
72
72
  > CreateAccountInvitations200Response deleteInterest()
73
73
 
74
- Delete Interest endpoint
74
+ Permanently deletes the specified interest from the organization and requires the \"del\" permission on interests.
75
75
 
76
76
  ### Example
77
77
 
@@ -122,7 +122,7 @@ const { status, data } = await apiInstance.deleteInterest(
122
122
  # **getInterest**
123
123
  > CreateInterest200Response getInterest()
124
124
 
125
- Get Interest endpoint
125
+ Retrieves a single interest by ID or name for the organization, requiring the \"read\" permission on interests.
126
126
 
127
127
  ### Example
128
128
 
@@ -173,7 +173,7 @@ const { status, data } = await apiInstance.getInterest(
173
173
  # **getInterestAccounts**
174
174
  > GetAccounts200Response getInterestAccounts()
175
175
 
176
- Get Interest Accounts endpoint
176
+ Returns a paginated, searchable list of accounts associated with the given interest, filterable by name, email, or ID, and requires the \"read\" permission on both interests and accounts.
177
177
 
178
178
  ### Example
179
179
 
@@ -236,7 +236,7 @@ const { status, data } = await apiInstance.getInterestAccounts(
236
236
  # **getInterestActivities**
237
237
  > GetAccountActivities200Response getInterestActivities()
238
238
 
239
- Get Interest Activities endpoint
239
+ Returns a paginated, searchable list of activity feed posts associated with the given interest, optionally filtered by activity status, and requires the \"read\" permission on both interests and activities.
240
240
 
241
241
  ### Example
242
242
 
@@ -302,7 +302,7 @@ const { status, data } = await apiInstance.getInterestActivities(
302
302
  # **getInterestChannels**
303
303
  > GetChannels200Response getInterestChannels()
304
304
 
305
- Get Interest Channels endpoint
305
+ Returns a paginated, searchable list of channels associated with the given interest, filterable by name, description, or ID, and requires the \"read\" permission on both interests and channels.
306
306
 
307
307
  ### Example
308
308
 
@@ -365,7 +365,7 @@ const { status, data } = await apiInstance.getInterestChannels(
365
365
  # **getInterestContents**
366
366
  > GetChannelContents200Response getInterestContents()
367
367
 
368
- Get Interest Contents endpoint
368
+ Returns a paginated, searchable list of content records associated with the given interest, filterable by title, body, or description, and requires the \"read\" permission on both interests and contents.
369
369
 
370
370
  ### Example
371
371
 
@@ -428,7 +428,7 @@ const { status, data } = await apiInstance.getInterestContents(
428
428
  # **getInterestEvents**
429
429
  > GetAccountEvents200Response getInterestEvents()
430
430
 
431
- Get Interest Events endpoint
431
+ Returns a paginated, searchable list of non-template events associated with the given interest, and requires the \"read\" permission on both interests and events.
432
432
 
433
433
  ### Example
434
434
 
@@ -491,7 +491,7 @@ const { status, data } = await apiInstance.getInterestEvents(
491
491
  # **getInterestGroups**
492
492
  > GetGroups200Response getInterestGroups()
493
493
 
494
- Get Interest Groups endpoint
494
+ Returns a paginated, searchable list of groups associated with the given interest, filterable by name or ID, and requires the \"read\" permission on both interests and groups.
495
495
 
496
496
  ### Example
497
497
 
@@ -554,7 +554,7 @@ const { status, data } = await apiInstance.getInterestGroups(
554
554
  # **getInterests**
555
555
  > GetAccountInterests200Response getInterests()
556
556
 
557
- Get Interests endpoint
557
+ Returns a paginated, searchable list of interests defined for the organization, filterable by name, and requires the \"read\" permission on interests.
558
558
 
559
559
  ### Example
560
560
 
@@ -614,7 +614,7 @@ const { status, data } = await apiInstance.getInterests(
614
614
  # **updateInterest**
615
615
  > CreateInterest200Response updateInterest()
616
616
 
617
- Update Interest endpoint
617
+ Updates the details of an existing interest identified by interestId and requires the \"update\" permission on interests.
618
618
 
619
619
  ### Example
620
620
 
@@ -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
- |[**createInvoice**](#createinvoice) | **POST** /invoices | Create Invoice|
8
- |[**deleteInvoice**](#deleteinvoice) | **DELETE** /invoices/{invoiceId} | Delete Invoice|
9
- |[**getInvoice**](#getinvoice) | **GET** /invoices/{invoiceId} | Get Invoice|
10
- |[**getInvoiceLineItem**](#getinvoicelineitem) | **GET** /invoices/{invoiceId}/items/{lineItemId} | Get Invoice Line Item|
11
- |[**getInvoiceLineItems**](#getinvoicelineitems) | **GET** /invoices/{invoiceId}/items | Get Invoice Line Items|
12
- |[**getInvoicePayments**](#getinvoicepayments) | **GET** /invoices/{invoiceId}/payments | Get Invoice Payments|
13
- |[**getInvoices**](#getinvoices) | **GET** /invoices | Get Invoices|
14
- |[**sendInvoice**](#sendinvoice) | **PUT** /invoices/{invoiceId}/send | Send Invoice|
15
- |[**updateInvoice**](#updateinvoice) | **PUT** /invoices/{invoiceId} | Update Invoice|
16
- |[**voidInvoice**](#voidinvoice) | **PUT** /invoices/{invoiceId}/void | Void Invoice|
7
+ |[**createInvoice**](#createinvoice) | **POST** /invoices | Create an invoice|
8
+ |[**deleteInvoice**](#deleteinvoice) | **DELETE** /invoices/{invoiceId} | Delete an invoice|
9
+ |[**getInvoice**](#getinvoice) | **GET** /invoices/{invoiceId} | Get an invoice|
10
+ |[**getInvoiceLineItem**](#getinvoicelineitem) | **GET** /invoices/{invoiceId}/items/{lineItemId} | Get an invoice line item|
11
+ |[**getInvoiceLineItems**](#getinvoicelineitems) | **GET** /invoices/{invoiceId}/items | List an invoice\'s line items|
12
+ |[**getInvoicePayments**](#getinvoicepayments) | **GET** /invoices/{invoiceId}/payments | List an invoice\'s payments|
13
+ |[**getInvoices**](#getinvoices) | **GET** /invoices | List invoices|
14
+ |[**sendInvoice**](#sendinvoice) | **PUT** /invoices/{invoiceId}/send | Send an invoice|
15
+ |[**updateInvoice**](#updateinvoice) | **PUT** /invoices/{invoiceId} | Update an invoice|
16
+ |[**voidInvoice**](#voidinvoice) | **PUT** /invoices/{invoiceId}/void | Void an invoice|
17
17
 
18
18
  # **createInvoice**
19
19
  > CreateInvoice200Response createInvoice(invoiceCreateInputs)
20
20
 
21
- Create Invoice endpoint
21
+ Creates a new invoice for the organization, optionally linked to an account, event, and payment integration, and requires the \"create\" permission on invoices.
22
22
 
23
23
  ### Example
24
24
 
@@ -70,7 +70,7 @@ const { status, data } = await apiInstance.createInvoice(
70
70
  # **deleteInvoice**
71
71
  > CreateAccountInvitations200Response deleteInvoice()
72
72
 
73
- Delete Invoice endpoint
73
+ Permanently deletes the specified invoice from the organization and requires the \"delete\" permission on invoices.
74
74
 
75
75
  ### Example
76
76
 
@@ -121,7 +121,7 @@ const { status, data } = await apiInstance.deleteInvoice(
121
121
  # **getInvoice**
122
122
  > CreateInvoice200Response getInvoice()
123
123
 
124
- Get Invoice endpoint
124
+ Retrieves a single invoice by ID or alternate ID for the organization, including its line items, and requires the \"read\" permission on invoices.
125
125
 
126
126
  ### Example
127
127
 
@@ -172,7 +172,7 @@ const { status, data } = await apiInstance.getInvoice(
172
172
  # **getInvoiceLineItem**
173
173
  > CreateInvoiceLineItem200Response getInvoiceLineItem()
174
174
 
175
- Get Invoice Line Item endpoint
175
+ Retrieves a single line item belonging to the given invoice by its ID, and requires the \"read\" permission on invoices.
176
176
 
177
177
  ### Example
178
178
 
@@ -226,7 +226,7 @@ const { status, data } = await apiInstance.getInvoiceLineItem(
226
226
  # **getInvoiceLineItems**
227
227
  > GetInvoiceLineItems200Response getInvoiceLineItems()
228
228
 
229
- Get Invoice Line Items endpoint
229
+ Returns a paginated list of line items belonging to the given invoice, with optional search across item name and description and ordering; requires the read permission on invoices.
230
230
 
231
231
  ### Example
232
232
 
@@ -289,7 +289,7 @@ const { status, data } = await apiInstance.getInvoiceLineItems(
289
289
  # **getInvoicePayments**
290
290
  > GetAccountPayments200Response getInvoicePayments()
291
291
 
292
- Get Invoice Payments endpoint
292
+ Returns a paginated list of payments recorded against the given invoice, with optional search and ordering; requires the read permission on invoices.
293
293
 
294
294
  ### Example
295
295
 
@@ -352,7 +352,7 @@ const { status, data } = await apiInstance.getInvoicePayments(
352
352
  # **getInvoices**
353
353
  > GetInvoices200Response getInvoices()
354
354
 
355
- Get Invoices endpoint
355
+ Returns a paginated list of invoices for the organization, optionally filtered by status, account, or event, with search and ordering support; requires the read permission on invoices.
356
356
 
357
357
  ### Example
358
358
 
@@ -421,7 +421,7 @@ const { status, data } = await apiInstance.getInvoices(
421
421
  # **sendInvoice**
422
422
  > CreateInvoice200Response sendInvoice()
423
423
 
424
- Send Invoice endpoint
424
+ Marks a draft or void invoice as sent, requiring it to already have an account and at least one line item, and requires the \"update\" permission on invoices.
425
425
 
426
426
  ### Example
427
427
 
@@ -472,7 +472,7 @@ const { status, data } = await apiInstance.sendInvoice(
472
472
  # **updateInvoice**
473
473
  > CreateInvoice200Response updateInvoice()
474
474
 
475
- Update Invoice endpoint
475
+ Updates the fields of an existing, unpaid invoice such as its account, event, payment integration, or status, and requires the \"update\" permission on invoices.
476
476
 
477
477
  ### Example
478
478
 
@@ -527,7 +527,7 @@ const { status, data } = await apiInstance.updateInvoice(
527
527
  # **voidInvoice**
528
528
  > CreateInvoice200Response voidInvoice()
529
529
 
530
- Void Invoice endpoint
530
+ Marks a previously sent invoice as void, which is only allowed while the invoice\'s status is \"sent\", and requires the \"update\" permission on invoices.
531
531
 
532
532
  ### Example
533
533
 
@@ -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
- |[**createInvoiceLineItem**](#createinvoicelineitem) | **POST** /invoices/{invoiceId}/items | Create Invoice Line Item|
8
- |[**deleteInvoiceLineItem**](#deleteinvoicelineitem) | **DELETE** /invoices/{invoiceId}/items/{lineItemId} | Delete Invoice Line Item|
9
- |[**updateInvoiceLineItem**](#updateinvoicelineitem) | **PUT** /invoices/{invoiceId}/items/{lineItemId} | Update Invoice Line Item|
7
+ |[**createInvoiceLineItem**](#createinvoicelineitem) | **POST** /invoices/{invoiceId}/items | Add a line item to an invoice|
8
+ |[**deleteInvoiceLineItem**](#deleteinvoicelineitem) | **DELETE** /invoices/{invoiceId}/items/{lineItemId} | Remove a line item from an invoice|
9
+ |[**updateInvoiceLineItem**](#updateinvoicelineitem) | **PUT** /invoices/{invoiceId}/items/{lineItemId} | Update an invoice line item|
10
10
 
11
11
  # **createInvoiceLineItem**
12
12
  > CreateInvoiceLineItem200Response createInvoiceLineItem(invoiceLineItemCreateInputs)
13
13
 
14
- Create Invoice Line Item endpoint
14
+ Adds a new line item to the specified invoice, which must currently be in \"draft\" status, and requires the \"update\" permission on invoices.
15
15
 
16
16
  ### Example
17
17
 
@@ -66,7 +66,7 @@ const { status, data } = await apiInstance.createInvoiceLineItem(
66
66
  # **deleteInvoiceLineItem**
67
67
  > CreateAccountInvitations200Response deleteInvoiceLineItem()
68
68
 
69
- Delete Invoice Line Item endpoint
69
+ Deletes a specific line item from the given invoice, which cannot already be in \"paid\" status, and requires the \"update\" permission on invoices.
70
70
 
71
71
  ### Example
72
72
 
@@ -120,7 +120,7 @@ const { status, data } = await apiInstance.deleteInvoiceLineItem(
120
120
  # **updateInvoiceLineItem**
121
121
  > CreateInvoiceLineItem200Response updateInvoiceLineItem()
122
122
 
123
- Update Invoice Line Item endpoint
123
+ Updates the fields of an existing line item on the specified invoice, which must currently be in \"draft\" status, and requires the \"update\" permission on invoices.
124
124
 
125
125
  ### Example
126
126