@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.
- package/README.md +1212 -1212
- package/api.ts +9696 -9696
- package/dist/api.d.ts +9696 -9696
- package/dist/api.js +9696 -9696
- package/dist/esm/api.d.ts +9696 -9696
- package/dist/esm/api.js +9696 -9696
- package/docs/AccountsAddressesApi.md +10 -10
- package/docs/AccountsApi.md +42 -42
- package/docs/AccountsFollowersApi.md +6 -6
- package/docs/AccountsFollowingApi.md +6 -6
- package/docs/AccountsGroupsApi.md +6 -6
- package/docs/AccountsInterestsApi.md +6 -6
- package/docs/AccountsInvitationsApi.md +6 -6
- package/docs/AccountsLeadsApi.md +8 -8
- package/docs/AccountsTiersApi.md +8 -8
- package/docs/ActivitiesApi.md +18 -18
- package/docs/ActivitiesScheduleApi.md +4 -4
- package/docs/AdvertisementsApi.md +14 -14
- package/docs/AnnouncementsApi.md +16 -16
- package/docs/AnnouncementsScheduleApi.md +4 -4
- package/docs/AnnouncementsTranslationsApi.md +8 -8
- package/docs/ApiLogsApi.md +4 -4
- package/docs/AuthSessionsApi.md +4 -4
- package/docs/BenefitsApi.md +12 -12
- package/docs/BenefitsTranslationsApi.md +8 -8
- package/docs/BookingsApi.md +56 -56
- package/docs/BookingsAvailabilitiesApi.md +6 -6
- package/docs/BookingsBlackoutsApi.md +6 -6
- package/docs/BookingsPlacesApi.md +6 -6
- package/docs/BookingsPlacesTranslationsApi.md +4 -4
- package/docs/BookingsQuestionsApi.md +16 -16
- package/docs/BookingsQuestionsChoicesApi.md +12 -12
- package/docs/BookingsQuestionsChoicesTranslationsApi.md +8 -8
- package/docs/BookingsQuestionsTranslationsApi.md +8 -8
- package/docs/BookingsSpacesApi.md +6 -6
- package/docs/BookingsSpacesTranslationsApi.md +4 -4
- package/docs/ChannelsApi.md +58 -58
- package/docs/ChannelsTranslationsApi.md +24 -24
- package/docs/DashboardsApi.md +10 -10
- package/docs/DashboardsWidgetsApi.md +8 -8
- package/docs/EmailReceiptsApi.md +4 -4
- package/docs/EventsAccessApi.md +6 -6
- package/docs/EventsActivationsApi.md +22 -22
- package/docs/EventsActivationsSessionsApi.md +6 -6
- package/docs/EventsActivationsTranslationsApi.md +8 -8
- package/docs/EventsAddonsApi.md +24 -24
- package/docs/EventsAddonsTranslationsApi.md +8 -8
- package/docs/EventsApi.md +22 -22
- package/docs/EventsAttendeesApi.md +24 -24
- package/docs/EventsAttendeesPackagesApi.md +10 -10
- package/docs/EventsAttendeesReservationsApi.md +18 -18
- package/docs/EventsAttributesApi.md +10 -10
- package/docs/EventsBenefitsApi.md +4 -4
- package/docs/EventsBlocksApi.md +16 -16
- package/docs/EventsBypassApi.md +10 -10
- package/docs/EventsCohostsApi.md +6 -6
- package/docs/EventsCouponsApi.md +28 -28
- package/docs/EventsEmailsApi.md +4 -4
- package/docs/EventsEmailsTranslationsApi.md +8 -8
- package/docs/EventsFaqsApi.md +22 -22
- package/docs/EventsFaqsTranslationsApi.md +16 -16
- package/docs/EventsFollowupsApi.md +38 -38
- package/docs/EventsFollowupsTranslationsApi.md +8 -8
- package/docs/EventsMatchesApi.md +34 -34
- package/docs/EventsMediaApi.md +16 -16
- package/docs/EventsMediaTranslationsApi.md +8 -8
- package/docs/EventsOnSiteApi.md +6 -6
- package/docs/EventsPackagesApi.md +10 -10
- package/docs/EventsPackagesPassesApi.md +10 -10
- package/docs/EventsPackagesTranslationsApi.md +8 -8
- package/docs/EventsPagesApi.md +16 -16
- package/docs/EventsPagesTranslationsApi.md +8 -8
- package/docs/EventsPassesAccessesApi.md +10 -10
- package/docs/EventsPassesAddonsApi.md +6 -6
- package/docs/EventsPassesApi.md +34 -34
- package/docs/EventsPassesAttributesApi.md +6 -6
- package/docs/EventsPassesFollowupsApi.md +8 -8
- package/docs/EventsPassesResponsesApi.md +10 -10
- package/docs/EventsPasstypesApi.md +34 -34
- package/docs/EventsPasstypesPriceschedulesApi.md +10 -10
- package/docs/EventsPasstypesRefundschedulesApi.md +10 -10
- package/docs/EventsPasstypesTranslationsApi.md +8 -8
- package/docs/EventsQuestionsApi.md +44 -44
- package/docs/EventsQuestionsTranslationsApi.md +16 -16
- package/docs/EventsRoomsApi.md +18 -18
- package/docs/EventsRoomtypesApi.md +24 -24
- package/docs/EventsRoomtypesTranslationsApi.md +8 -8
- package/docs/EventsSectionsApi.md +38 -38
- package/docs/EventsSectionsTranslationsApi.md +8 -8
- package/docs/EventsSessionsAccessesApi.md +6 -6
- package/docs/EventsSessionsApi.md +70 -70
- package/docs/EventsSessionsLocationsApi.md +16 -16
- package/docs/EventsSessionsLocationsTranslationsApi.md +8 -8
- package/docs/EventsSessionsMatchesApi.md +32 -32
- package/docs/EventsSessionsPricesApi.md +6 -6
- package/docs/EventsSessionsQuestionsApi.md +38 -38
- package/docs/EventsSessionsQuestionsTranslationsApi.md +16 -16
- package/docs/EventsSessionsSectionsApi.md +20 -20
- package/docs/EventsSessionsSectionsTranslationsApi.md +8 -8
- package/docs/EventsSessionsTimesApi.md +16 -16
- package/docs/EventsSessionsTimesTranslationsApi.md +8 -8
- package/docs/EventsSessionsTranslationsApi.md +8 -8
- package/docs/EventsSpeakersApi.md +16 -16
- package/docs/EventsSpeakersTranslationsApi.md +8 -8
- package/docs/EventsSponsorsApi.md +8 -8
- package/docs/EventsSponsorshiplevelsApi.md +12 -12
- package/docs/EventsSponsorshiplevelsTranslationsApi.md +8 -8
- package/docs/EventsSponsorshipsApi.md +12 -12
- package/docs/EventsSponsorshipsTranslationsApi.md +8 -8
- package/docs/EventsTemplatesApi.md +2 -2
- package/docs/EventsTracksApi.md +22 -22
- package/docs/EventsTracksTranslationsApi.md +8 -8
- package/docs/EventsTransfersApi.md +4 -4
- package/docs/EventsTranslationsApi.md +8 -8
- package/docs/FilesApi.md +4 -4
- package/docs/GroupsApi.md +12 -12
- package/docs/GroupsEventsApi.md +6 -6
- package/docs/GroupsInterestsApi.md +6 -6
- package/docs/GroupsInvitationsApi.md +12 -12
- package/docs/GroupsMembersApi.md +8 -8
- package/docs/GroupsModeratorsApi.md +6 -6
- package/docs/GroupsRequestsApi.md +10 -10
- package/docs/GroupsSponsorsApi.md +6 -6
- package/docs/GroupsTranslationsApi.md +8 -8
- package/docs/ImportsApi.md +8 -8
- package/docs/InterestsApi.md +22 -22
- package/docs/InvoicesApi.md +20 -20
- package/docs/InvoicesLineitemsApi.md +6 -6
- package/docs/LoginsAccountsApi.md +6 -6
- package/docs/LoginsApi.md +16 -16
- package/docs/MeetingsApi.md +14 -14
- package/docs/MeetingsLinksApi.md +10 -10
- package/docs/MeetingsLivestreamsApi.md +12 -12
- package/docs/MeetingsParticipantsApi.md +12 -12
- package/docs/MeetingsPresetsApi.md +10 -10
- package/docs/MeetingsRecordingsApi.md +4 -4
- package/docs/MeetingsSessionsApi.md +16 -16
- package/docs/NotificationsApi.md +8 -8
- package/docs/OrganizationApi.md +18 -18
- package/docs/OrganizationAttributesApi.md +14 -14
- package/docs/OrganizationDomainsApi.md +6 -6
- package/docs/OrganizationIntegrationsApi.md +10 -10
- package/docs/OrganizationModulesApi.md +6 -6
- package/docs/OrganizationModulesCustomApi.md +10 -10
- package/docs/OrganizationModulesCustomTranslationsApi.md +8 -8
- package/docs/OrganizationModulesSettingsApi.md +4 -4
- package/docs/OrganizationModulesSettingsTranslationsApi.md +8 -8
- package/docs/OrganizationModulesTiersApi.md +12 -12
- package/docs/OrganizationPaymentsApi.md +20 -20
- package/docs/OrganizationSideeffectsApi.md +8 -8
- package/docs/OrganizationTaxApi.md +22 -22
- package/docs/OrganizationTeammembersApi.md +10 -10
- package/docs/OrganizationUsersApi.md +6 -6
- package/docs/OrganizationWebhooksApi.md +12 -12
- package/docs/PaymentsApi.md +2 -2
- package/docs/PreferencesApi.md +4 -4
- package/docs/PushDevicesApi.md +6 -6
- package/docs/ReportsApi.md +22 -22
- package/docs/ReportsUsersApi.md +6 -6
- package/docs/SearchlistsApi.md +10 -10
- package/docs/SearchlistsValuesApi.md +14 -14
- package/docs/SelfApi.md +10 -10
- package/docs/SelfApikeysApi.md +8 -8
- package/docs/SelfImagesApi.md +4 -4
- package/docs/SeriesApi.md +18 -18
- package/docs/SeriesQuestionsApi.md +14 -14
- package/docs/SeriesQuestionsChoicesApi.md +8 -8
- package/docs/SeriesQuestionsTranslationsApi.md +4 -4
- package/docs/SeriesRegistrationsApi.md +18 -18
- package/docs/SeriesTranslationsApi.md +8 -8
- package/docs/SponsorsAccountsApi.md +6 -6
- package/docs/SponsorsApi.md +10 -10
- package/docs/SponsorsTranslationsApi.md +8 -8
- package/docs/StorageFilesApi.md +6 -6
- package/docs/StorageImagesApi.md +18 -18
- package/docs/StorageVideosApi.md +14 -14
- package/docs/StorageVideosCaptionsApi.md +10 -10
- package/docs/StreamsApi.md +14 -14
- package/docs/StreamsOutputsApi.md +10 -10
- package/docs/StreamsSessionsApi.md +12 -12
- package/docs/SupportApi.md +14 -14
- package/docs/SupportMessagesApi.md +4 -4
- package/docs/SupportNotesApi.md +6 -6
- package/docs/SurveysApi.md +12 -12
- package/docs/SurveysQuestionsApi.md +38 -38
- package/docs/SurveysQuestionsTranslationsApi.md +16 -16
- package/docs/SurveysSectionsApi.md +20 -20
- package/docs/SurveysSectionsTranslationsApi.md +8 -8
- package/docs/SurveysSessionsApi.md +4 -4
- package/docs/SurveysSubmissionsApi.md +14 -14
- package/docs/SurveysTranslationsApi.md +8 -8
- package/docs/ThreadsAccountsApi.md +8 -8
- package/docs/ThreadsApi.md +10 -10
- package/docs/ThreadsMessagesApi.md +12 -12
- package/docs/ThreadsMessagesFilesApi.md +6 -6
- package/docs/ThreadsMessagesImagesApi.md +6 -6
- package/docs/ThreadsMessagesReactionsApi.md +6 -6
- package/docs/ThreadsMessagesVideosApi.md +6 -6
- package/docs/ThreadsStorageApi.md +6 -6
- package/docs/TiersApi.md +20 -20
- package/package.json +1 -1
|
@@ -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
|
-
|[**createAccountAddress**](#createaccountaddress) | **POST** /accounts/{accountId}/addresses | Create
|
|
8
|
-
|[**deleteAccountAddress**](#deleteaccountaddress) | **DELETE** /accounts/{accountId}/addresses/{addressId} | Delete
|
|
9
|
-
|[**getAccountAddress**](#getaccountaddress) | **GET** /accounts/{accountId}/addresses/{addressId} | Get
|
|
10
|
-
|[**getAccountAddresses**](#getaccountaddresses) | **GET** /accounts/{accountId}/addresses |
|
|
11
|
-
|[**updateAccountAddress**](#updateaccountaddress) | **PUT** /accounts/{accountId}/addresses/{addressId} | Update
|
|
7
|
+
|[**createAccountAddress**](#createaccountaddress) | **POST** /accounts/{accountId}/addresses | Create an address for an account|
|
|
8
|
+
|[**deleteAccountAddress**](#deleteaccountaddress) | **DELETE** /accounts/{accountId}/addresses/{addressId} | Delete an account\'s address|
|
|
9
|
+
|[**getAccountAddress**](#getaccountaddress) | **GET** /accounts/{accountId}/addresses/{addressId} | Get a single account address|
|
|
10
|
+
|[**getAccountAddresses**](#getaccountaddresses) | **GET** /accounts/{accountId}/addresses | List an account\'s saved addresses|
|
|
11
|
+
|[**updateAccountAddress**](#updateaccountaddress) | **PUT** /accounts/{accountId}/addresses/{addressId} | Update an account\'s address|
|
|
12
12
|
|
|
13
13
|
# **createAccountAddress**
|
|
14
14
|
> CreateAccountAddress200Response createAccountAddress(accountAddressCreateInputs)
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
Creates a new mailing address on the given account, validating and optionally geocoding the address unless skipValidation is set, and requires update permission on accounts.
|
|
17
17
|
|
|
18
18
|
### Example
|
|
19
19
|
|
|
@@ -68,7 +68,7 @@ const { status, data } = await apiInstance.createAccountAddress(
|
|
|
68
68
|
# **deleteAccountAddress**
|
|
69
69
|
> CreateAccountInvitations200Response deleteAccountAddress()
|
|
70
70
|
|
|
71
|
-
|
|
71
|
+
Permanently deletes a specific address from the given account, requiring update permission on accounts.
|
|
72
72
|
|
|
73
73
|
### Example
|
|
74
74
|
|
|
@@ -122,7 +122,7 @@ const { status, data } = await apiInstance.deleteAccountAddress(
|
|
|
122
122
|
# **getAccountAddress**
|
|
123
123
|
> CreateAccountAddress200Response getAccountAddress()
|
|
124
124
|
|
|
125
|
-
|
|
125
|
+
Retrieves one saved address belonging to the specified account by its address ID; requires permission to read accounts.
|
|
126
126
|
|
|
127
127
|
### Example
|
|
128
128
|
|
|
@@ -176,7 +176,7 @@ const { status, data } = await apiInstance.getAccountAddress(
|
|
|
176
176
|
# **getAccountAddresses**
|
|
177
177
|
> GetAccountAddresses200Response getAccountAddresses()
|
|
178
178
|
|
|
179
|
-
|
|
179
|
+
Returns a paginated list of addresses saved to the specified account, supporting search across address line, city, state, and country, and requires permission to read accounts.
|
|
180
180
|
|
|
181
181
|
### Example
|
|
182
182
|
|
|
@@ -239,7 +239,7 @@ const { status, data } = await apiInstance.getAccountAddresses(
|
|
|
239
239
|
# **updateAccountAddress**
|
|
240
240
|
> CreateAccountAddress200Response updateAccountAddress(accountAddressUpdateInputs)
|
|
241
241
|
|
|
242
|
-
|
|
242
|
+
Updates the fields of an existing address on the given account, re-validating the address unless skipValidation is set, and requires update permission on accounts.
|
|
243
243
|
|
|
244
244
|
### Example
|
|
245
245
|
|
package/docs/AccountsApi.md
CHANGED
|
@@ -4,32 +4,32 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**createAccount**](#createaccount) | **POST** /accounts | Create
|
|
8
|
-
|[**deleteAccount**](#deleteaccount) | **DELETE** /accounts/{accountId} | Delete
|
|
9
|
-
|[**exportAccount**](#exportaccount) | **POST** /accounts/{accountId}/export | Export
|
|
10
|
-
|[**getAcccountEmailReceipts**](#getacccountemailreceipts) | **GET** /accounts/{accountId}/email-receipts |
|
|
11
|
-
|[**getAccount**](#getaccount) | **GET** /accounts/{accountId} | Get
|
|
12
|
-
|[**getAccountActivities**](#getaccountactivities) | **GET** /accounts/{accountId}/activities |
|
|
13
|
-
|[**getAccountBookings**](#getaccountbookings) | **GET** /accounts/{accountId}/bookings |
|
|
14
|
-
|[**getAccountComments**](#getaccountcomments) | **GET** /accounts/{accountId}/comments |
|
|
15
|
-
|[**getAccountEvents**](#getaccountevents) | **GET** /accounts/{accountId}/events |
|
|
16
|
-
|[**getAccountLikes**](#getaccountlikes) | **GET** /accounts/{accountId}/likes |
|
|
17
|
-
|[**getAccountNotificationPreferences**](#getaccountnotificationpreferences) | **GET** /accounts/{accountId}/notification-preferences | Get
|
|
18
|
-
|[**getAccountPayments**](#getaccountpayments) | **GET** /accounts/{accountId}/payments |
|
|
19
|
-
|[**getAccountRegistrations**](#getaccountregistrations) | **GET** /accounts/{accountId}/registrations |
|
|
20
|
-
|[**getAccountSupportTickets**](#getaccountsupporttickets) | **GET** /accounts/{accountId}/supportTickets |
|
|
21
|
-
|[**getAccountThreads**](#getaccountthreads) | **GET** /accounts/{accountId}/threads |
|
|
22
|
-
|[**getAccounts**](#getaccounts) | **GET** /accounts |
|
|
23
|
-
|[**getAccountsByInternalRefId**](#getaccountsbyinternalrefid) | **GET** /accounts/internal-ref-id/{internalRefId} |
|
|
24
|
-
|[**impersonateAccount**](#impersonateaccount) | **POST** /accounts/{accountId}/impersonate/{username} | Impersonate
|
|
25
|
-
|[**syncAccount**](#syncaccount) | **POST** /accounts/{accountId}/sync | Sync
|
|
26
|
-
|[**syncAccounts**](#syncaccounts) | **POST** /accounts/sync | Sync
|
|
27
|
-
|[**updateAccount**](#updateaccount) | **PUT** /accounts/{accountId} | Update
|
|
7
|
+
|[**createAccount**](#createaccount) | **POST** /accounts | Create a new account|
|
|
8
|
+
|[**deleteAccount**](#deleteaccount) | **DELETE** /accounts/{accountId} | Delete an account|
|
|
9
|
+
|[**exportAccount**](#exportaccount) | **POST** /accounts/{accountId}/export | Export an account\'s data|
|
|
10
|
+
|[**getAcccountEmailReceipts**](#getacccountemailreceipts) | **GET** /accounts/{accountId}/email-receipts | List an account\'s email receipts|
|
|
11
|
+
|[**getAccount**](#getaccount) | **GET** /accounts/{accountId} | Get an account\'s profile|
|
|
12
|
+
|[**getAccountActivities**](#getaccountactivities) | **GET** /accounts/{accountId}/activities | List an account\'s activity feed posts|
|
|
13
|
+
|[**getAccountBookings**](#getaccountbookings) | **GET** /accounts/{accountId}/bookings | List an account\'s space bookings|
|
|
14
|
+
|[**getAccountComments**](#getaccountcomments) | **GET** /accounts/{accountId}/comments | List an account\'s posted comments|
|
|
15
|
+
|[**getAccountEvents**](#getaccountevents) | **GET** /accounts/{accountId}/events | List an account\'s events|
|
|
16
|
+
|[**getAccountLikes**](#getaccountlikes) | **GET** /accounts/{accountId}/likes | List an account\'s likes|
|
|
17
|
+
|[**getAccountNotificationPreferences**](#getaccountnotificationpreferences) | **GET** /accounts/{accountId}/notification-preferences | Get an account\'s notification preferences|
|
|
18
|
+
|[**getAccountPayments**](#getaccountpayments) | **GET** /accounts/{accountId}/payments | List an account\'s payments|
|
|
19
|
+
|[**getAccountRegistrations**](#getaccountregistrations) | **GET** /accounts/{accountId}/registrations | List an account\'s event registrations|
|
|
20
|
+
|[**getAccountSupportTickets**](#getaccountsupporttickets) | **GET** /accounts/{accountId}/supportTickets | List an account\'s support tickets|
|
|
21
|
+
|[**getAccountThreads**](#getaccountthreads) | **GET** /accounts/{accountId}/threads | List an account\'s message threads|
|
|
22
|
+
|[**getAccounts**](#getaccounts) | **GET** /accounts | List accounts in the organization|
|
|
23
|
+
|[**getAccountsByInternalRefId**](#getaccountsbyinternalrefid) | **GET** /accounts/internal-ref-id/{internalRefId} | Find accounts by internal reference ID|
|
|
24
|
+
|[**impersonateAccount**](#impersonateaccount) | **POST** /accounts/{accountId}/impersonate/{username} | Impersonate account|
|
|
25
|
+
|[**syncAccount**](#syncaccount) | **POST** /accounts/{accountId}/sync | Sync a single account|
|
|
26
|
+
|[**syncAccounts**](#syncaccounts) | **POST** /accounts/sync | Sync all accounts|
|
|
27
|
+
|[**updateAccount**](#updateaccount) | **PUT** /accounts/{accountId} | Update an account|
|
|
28
28
|
|
|
29
29
|
# **createAccount**
|
|
30
30
|
> CreateAccount200Response createAccount(accountCreateInputs)
|
|
31
31
|
|
|
32
|
-
|
|
32
|
+
Creates a new account profile in the organization from the supplied account fields, requiring create permission on accounts.
|
|
33
33
|
|
|
34
34
|
### Example
|
|
35
35
|
|
|
@@ -81,7 +81,7 @@ const { status, data } = await apiInstance.createAccount(
|
|
|
81
81
|
# **deleteAccount**
|
|
82
82
|
> CreateAccountInvitations200Response deleteAccount()
|
|
83
83
|
|
|
84
|
-
|
|
84
|
+
Permanently queues deletion of the given account and its related data, requiring delete permission on accounts.
|
|
85
85
|
|
|
86
86
|
### Example
|
|
87
87
|
|
|
@@ -132,7 +132,7 @@ const { status, data } = await apiInstance.deleteAccount(
|
|
|
132
132
|
# **exportAccount**
|
|
133
133
|
> CreateAccount200Response exportAccount()
|
|
134
134
|
|
|
135
|
-
|
|
135
|
+
Queues a data export for the given account and emails the resulting file to the requesting admin user, requiring read permission on accounts.
|
|
136
136
|
|
|
137
137
|
### Example
|
|
138
138
|
|
|
@@ -183,7 +183,7 @@ const { status, data } = await apiInstance.exportAccount(
|
|
|
183
183
|
# **getAcccountEmailReceipts**
|
|
184
184
|
> GetAcccountEmailReceipts200Response getAcccountEmailReceipts()
|
|
185
185
|
|
|
186
|
-
|
|
186
|
+
Returns a paginated list of email delivery receipts sent to the given account, optionally filtered by delivery status and searchable by recipient address or subject; requires read access to accounts and logs.
|
|
187
187
|
|
|
188
188
|
### Example
|
|
189
189
|
|
|
@@ -249,7 +249,7 @@ const { status, data } = await apiInstance.getAcccountEmailReceipts(
|
|
|
249
249
|
# **getAccount**
|
|
250
250
|
> CreateAccount200Response getAccount()
|
|
251
251
|
|
|
252
|
-
|
|
252
|
+
Returns the full profile record for a single account identified by its account ID or username; requires read access to accounts.
|
|
253
253
|
|
|
254
254
|
### Example
|
|
255
255
|
|
|
@@ -300,7 +300,7 @@ const { status, data } = await apiInstance.getAccount(
|
|
|
300
300
|
# **getAccountActivities**
|
|
301
301
|
> GetAccountActivities200Response getAccountActivities()
|
|
302
302
|
|
|
303
|
-
|
|
303
|
+
Returns a paginated list of top-level activity feed posts authored by the given account (excludes comments and event/content/group-scoped activities), optionally filtered by activity status and searchable by message text; requires read access to accounts and activities.
|
|
304
304
|
|
|
305
305
|
### Example
|
|
306
306
|
|
|
@@ -366,7 +366,7 @@ const { status, data } = await apiInstance.getAccountActivities(
|
|
|
366
366
|
# **getAccountBookings**
|
|
367
367
|
> GetAccountBookings200Response getAccountBookings()
|
|
368
368
|
|
|
369
|
-
|
|
369
|
+
Returns a paginated list of non-draft space/place bookings made by the given account, with optional search over the booked space or place name; requires read access to accounts and bookings.
|
|
370
370
|
|
|
371
371
|
### Example
|
|
372
372
|
|
|
@@ -429,7 +429,7 @@ const { status, data } = await apiInstance.getAccountBookings(
|
|
|
429
429
|
# **getAccountComments**
|
|
430
430
|
> GetAccountActivities200Response getAccountComments()
|
|
431
431
|
|
|
432
|
-
|
|
432
|
+
Returns a paginated list of comments the given account has left on other activity feed posts, with optional search over the comment message text; requires read access to accounts.
|
|
433
433
|
|
|
434
434
|
### Example
|
|
435
435
|
|
|
@@ -492,7 +492,7 @@ const { status, data } = await apiInstance.getAccountComments(
|
|
|
492
492
|
# **getAccountEvents**
|
|
493
493
|
> GetAccountEvents200Response getAccountEvents()
|
|
494
494
|
|
|
495
|
-
|
|
495
|
+
Returns a paginated list of events an account is associated with, optionally filtered to past or upcoming events via the `past` flag and by a search term; requires the `read accounts` and `read events` permissions.
|
|
496
496
|
|
|
497
497
|
### Example
|
|
498
498
|
|
|
@@ -558,7 +558,7 @@ const { status, data } = await apiInstance.getAccountEvents(
|
|
|
558
558
|
# **getAccountLikes**
|
|
559
559
|
> GetAccountLikes200Response getAccountLikes()
|
|
560
560
|
|
|
561
|
-
|
|
561
|
+
Returns a paginated list of likes made by the given account, searchable by the liked activity\'s message or the account\'s name; requires the `read accounts` permission.
|
|
562
562
|
|
|
563
563
|
### Example
|
|
564
564
|
|
|
@@ -621,7 +621,7 @@ const { status, data } = await apiInstance.getAccountLikes(
|
|
|
621
621
|
# **getAccountNotificationPreferences**
|
|
622
622
|
> GetAccountNotificationPreferences200Response getAccountNotificationPreferences()
|
|
623
623
|
|
|
624
|
-
|
|
624
|
+
Returns the notification preferences for the given account, creating a default preferences record on the account if one does not yet exist; requires the `read accounts` permission.
|
|
625
625
|
|
|
626
626
|
### Example
|
|
627
627
|
|
|
@@ -672,7 +672,7 @@ const { status, data } = await apiInstance.getAccountNotificationPreferences(
|
|
|
672
672
|
# **getAccountPayments**
|
|
673
673
|
> GetAccountPayments200Response getAccountPayments()
|
|
674
674
|
|
|
675
|
-
|
|
675
|
+
Returns a paginated list of payments made by the given account, searchable by payment ID, account email, or account name; requires the `read accounts` and `read payments` permissions.
|
|
676
676
|
|
|
677
677
|
### Example
|
|
678
678
|
|
|
@@ -735,7 +735,7 @@ const { status, data } = await apiInstance.getAccountPayments(
|
|
|
735
735
|
# **getAccountRegistrations**
|
|
736
736
|
> GetAccountRegistrations200Response getAccountRegistrations()
|
|
737
737
|
|
|
738
|
-
|
|
738
|
+
Returns a paginated list of event registrations for the given account, ordered by event start date by default; requires the `read accounts` and `read events` permissions.
|
|
739
739
|
|
|
740
740
|
### Example
|
|
741
741
|
|
|
@@ -798,7 +798,7 @@ const { status, data } = await apiInstance.getAccountRegistrations(
|
|
|
798
798
|
# **getAccountSupportTickets**
|
|
799
799
|
> GetAccountSupportTickets200Response getAccountSupportTickets()
|
|
800
800
|
|
|
801
|
-
|
|
801
|
+
Returns a paginated list of support tickets filed by the given account, searchable by a search term; requires the `read accounts` and `read support` permissions.
|
|
802
802
|
|
|
803
803
|
### Example
|
|
804
804
|
|
|
@@ -861,7 +861,7 @@ const { status, data } = await apiInstance.getAccountSupportTickets(
|
|
|
861
861
|
# **getAccountThreads**
|
|
862
862
|
> GetAccountThreads200Response getAccountThreads()
|
|
863
863
|
|
|
864
|
-
|
|
864
|
+
Returns a paginated list of message threads (conversations) that the given account is a participant in, supporting search by subject or thread ID and requiring read permission on accounts and threads.
|
|
865
865
|
|
|
866
866
|
### Example
|
|
867
867
|
|
|
@@ -924,7 +924,7 @@ const { status, data } = await apiInstance.getAccountThreads(
|
|
|
924
924
|
# **getAccounts**
|
|
925
925
|
> GetAccounts200Response getAccounts()
|
|
926
926
|
|
|
927
|
-
|
|
927
|
+
Returns a paginated list of accounts for the organization, filterable by verified status, online status, and a search term; requires the `read accounts` permission.
|
|
928
928
|
|
|
929
929
|
### Example
|
|
930
930
|
|
|
@@ -990,7 +990,7 @@ const { status, data } = await apiInstance.getAccounts(
|
|
|
990
990
|
# **getAccountsByInternalRefId**
|
|
991
991
|
> GetAccountsByInternalRefId200Response getAccountsByInternalRefId()
|
|
992
992
|
|
|
993
|
-
|
|
993
|
+
Returns all accounts in the organization whose `internalRefId` matches the given value, ordered by creation date descending; requires the `read accounts` permission.
|
|
994
994
|
|
|
995
995
|
### Example
|
|
996
996
|
|
|
@@ -1041,7 +1041,7 @@ const { status, data } = await apiInstance.getAccountsByInternalRefId(
|
|
|
1041
1041
|
# **impersonateAccount**
|
|
1042
1042
|
> ImpersonateAccount200Response impersonateAccount()
|
|
1043
1043
|
|
|
1044
|
-
|
|
1044
|
+
Starts an admin impersonation session for the specified account, returning a token that lets an admin act as the given user identified by account ID and username.
|
|
1045
1045
|
|
|
1046
1046
|
### Example
|
|
1047
1047
|
|
|
@@ -1095,7 +1095,7 @@ const { status, data } = await apiInstance.impersonateAccount(
|
|
|
1095
1095
|
# **syncAccount**
|
|
1096
1096
|
> SyncAccounts200Response syncAccount()
|
|
1097
1097
|
|
|
1098
|
-
|
|
1098
|
+
Enqueues a background job to resync the given account\'s data, requiring update permission on accounts.
|
|
1099
1099
|
|
|
1100
1100
|
### Example
|
|
1101
1101
|
|
|
@@ -1146,7 +1146,7 @@ const { status, data } = await apiInstance.syncAccount(
|
|
|
1146
1146
|
# **syncAccounts**
|
|
1147
1147
|
> SyncAccounts200Response syncAccounts()
|
|
1148
1148
|
|
|
1149
|
-
|
|
1149
|
+
Enqueues a background job to resync every account in the organization and returns the number of accounts enqueued, requiring update permission on accounts.
|
|
1150
1150
|
|
|
1151
1151
|
### Example
|
|
1152
1152
|
|
|
@@ -1190,7 +1190,7 @@ This endpoint does not have any parameters.
|
|
|
1190
1190
|
# **updateAccount**
|
|
1191
1191
|
> CreateAccount200Response updateAccount(accountUpdateInputs)
|
|
1192
1192
|
|
|
1193
|
-
|
|
1193
|
+
Updates the profile fields of the given account as an administrator, requiring update permission on accounts.
|
|
1194
1194
|
|
|
1195
1195
|
### Example
|
|
1196
1196
|
|
|
@@ -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
|
-
|[**addAccountFollower**](#addaccountfollower) | **POST** /accounts/{accountId}/followers/{followerId} | Add
|
|
8
|
-
|[**getAccountFollowers**](#getaccountfollowers) | **GET** /accounts/{accountId}/followers |
|
|
9
|
-
|[**removeAccountFollower**](#removeaccountfollower) | **DELETE** /accounts/{accountId}/followers/{followerId} | Remove
|
|
7
|
+
|[**addAccountFollower**](#addaccountfollower) | **POST** /accounts/{accountId}/followers/{followerId} | Add a follower to an account|
|
|
8
|
+
|[**getAccountFollowers**](#getaccountfollowers) | **GET** /accounts/{accountId}/followers | List an account\'s followers|
|
|
9
|
+
|[**removeAccountFollower**](#removeaccountfollower) | **DELETE** /accounts/{accountId}/followers/{followerId} | Remove a follower from an account|
|
|
10
10
|
|
|
11
11
|
# **addAccountFollower**
|
|
12
12
|
> CreateAccount200Response addAccountFollower()
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
Makes the given follower account follow the target account, failing if the follower has already reached the 5000 following limit, and requires update permission on accounts.
|
|
15
15
|
|
|
16
16
|
### Example
|
|
17
17
|
|
|
@@ -65,7 +65,7 @@ const { status, data } = await apiInstance.addAccountFollower(
|
|
|
65
65
|
# **getAccountFollowers**
|
|
66
66
|
> GetAccounts200Response getAccountFollowers()
|
|
67
67
|
|
|
68
|
-
|
|
68
|
+
Returns a paginated list of accounts that follow the specified account, with optional search, and requires permission to read accounts.
|
|
69
69
|
|
|
70
70
|
### Example
|
|
71
71
|
|
|
@@ -128,7 +128,7 @@ const { status, data } = await apiInstance.getAccountFollowers(
|
|
|
128
128
|
# **removeAccountFollower**
|
|
129
129
|
> CreateAccount200Response removeAccountFollower()
|
|
130
130
|
|
|
131
|
-
|
|
131
|
+
Removes the given follower account from the target account\'s followers and deletes any related follow notification, requiring update permission on accounts.
|
|
132
132
|
|
|
133
133
|
### Example
|
|
134
134
|
|
|
@@ -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
|
-
|[**addAccountFollowing**](#addaccountfollowing) | **POST** /accounts/{accountId}/following/{followingId} |
|
|
8
|
-
|[**getAccountFollowing**](#getaccountfollowing) | **GET** /accounts/{accountId}/following |
|
|
9
|
-
|[**removeAccountFollowing**](#removeaccountfollowing) | **DELETE** /accounts/{accountId}/following/{followingId} |
|
|
7
|
+
|[**addAccountFollowing**](#addaccountfollowing) | **POST** /accounts/{accountId}/following/{followingId} | Follow another account|
|
|
8
|
+
|[**getAccountFollowing**](#getaccountfollowing) | **GET** /accounts/{accountId}/following | List accounts an account is following|
|
|
9
|
+
|[**removeAccountFollowing**](#removeaccountfollowing) | **DELETE** /accounts/{accountId}/following/{followingId} | Unfollow another account|
|
|
10
10
|
|
|
11
11
|
# **addAccountFollowing**
|
|
12
12
|
> CreateAccount200Response addAccountFollowing()
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
Makes the given account start following the specified target account, requiring update permission on accounts.
|
|
15
15
|
|
|
16
16
|
### Example
|
|
17
17
|
|
|
@@ -65,7 +65,7 @@ const { status, data } = await apiInstance.addAccountFollowing(
|
|
|
65
65
|
# **getAccountFollowing**
|
|
66
66
|
> GetAccounts200Response getAccountFollowing()
|
|
67
67
|
|
|
68
|
-
|
|
68
|
+
Returns a paginated list of accounts that the specified account follows, with optional search, and requires permission to read accounts.
|
|
69
69
|
|
|
70
70
|
### Example
|
|
71
71
|
|
|
@@ -128,7 +128,7 @@ const { status, data } = await apiInstance.getAccountFollowing(
|
|
|
128
128
|
# **removeAccountFollowing**
|
|
129
129
|
> CreateAccount200Response removeAccountFollowing()
|
|
130
130
|
|
|
131
|
-
|
|
131
|
+
Makes the given account stop following the specified target account, requiring update permission on accounts.
|
|
132
132
|
|
|
133
133
|
### Example
|
|
134
134
|
|
|
@@ -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
|
-
|[**addAccountGroup**](#addaccountgroup) | **POST** /accounts/{accountId}/groups/{groupId} | Add
|
|
8
|
-
|[**getAccountGroups**](#getaccountgroups) | **GET** /accounts/{accountId}/groups |
|
|
9
|
-
|[**removeAccountGroup**](#removeaccountgroup) | **DELETE** /accounts/{accountId}/groups/{groupId} | Remove
|
|
7
|
+
|[**addAccountGroup**](#addaccountgroup) | **POST** /accounts/{accountId}/groups/{groupId} | Add an account to a group|
|
|
8
|
+
|[**getAccountGroups**](#getaccountgroups) | **GET** /accounts/{accountId}/groups | List an account\'s group memberships|
|
|
9
|
+
|[**removeAccountGroup**](#removeaccountgroup) | **DELETE** /accounts/{accountId}/groups/{groupId} | Remove an account from a group|
|
|
10
10
|
|
|
11
11
|
# **addAccountGroup**
|
|
12
12
|
> AddAccountGroup200Response addAccountGroup()
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
Creates a group membership adding the given account to the specified group as a member, requiring update permission on both accounts and groups.
|
|
15
15
|
|
|
16
16
|
### Example
|
|
17
17
|
|
|
@@ -65,7 +65,7 @@ const { status, data } = await apiInstance.addAccountGroup(
|
|
|
65
65
|
# **getAccountGroups**
|
|
66
66
|
> GetAccountGroups200Response getAccountGroups()
|
|
67
67
|
|
|
68
|
-
|
|
68
|
+
Returns a paginated list of groups the specified account belongs to, with optional search, and requires permission to read accounts and groups.
|
|
69
69
|
|
|
70
70
|
### Example
|
|
71
71
|
|
|
@@ -128,7 +128,7 @@ const { status, data } = await apiInstance.getAccountGroups(
|
|
|
128
128
|
# **removeAccountGroup**
|
|
129
129
|
> CreateAccountInvitations200Response removeAccountGroup()
|
|
130
130
|
|
|
131
|
-
|
|
131
|
+
Removes the given account\'s membership from the specified group, deleting the group membership record; requires update permission on accounts and groups.
|
|
132
132
|
|
|
133
133
|
### Example
|
|
134
134
|
|
|
@@ -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
|
-
|[**addAccountInterest**](#addaccountinterest) | **POST** /accounts/{accountId}/interests/{interestId} | Add
|
|
8
|
-
|[**getAccountInterests**](#getaccountinterests) | **GET** /accounts/{accountId}/interests |
|
|
9
|
-
|[**removeAccountInterest**](#removeaccountinterest) | **DELETE** /accounts/{accountId}/interests/{interestId} | Remove
|
|
7
|
+
|[**addAccountInterest**](#addaccountinterest) | **POST** /accounts/{accountId}/interests/{interestId} | Add an interest to an account|
|
|
8
|
+
|[**getAccountInterests**](#getaccountinterests) | **GET** /accounts/{accountId}/interests | List an account\'s interests|
|
|
9
|
+
|[**removeAccountInterest**](#removeaccountinterest) | **DELETE** /accounts/{accountId}/interests/{interestId} | Remove an interest from an account|
|
|
10
10
|
|
|
11
11
|
# **addAccountInterest**
|
|
12
12
|
> CreateAccount200Response addAccountInterest()
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
Associates the given interest with the specified account and returns the updated account; requires update permission on accounts and interests.
|
|
15
15
|
|
|
16
16
|
### Example
|
|
17
17
|
|
|
@@ -65,7 +65,7 @@ const { status, data } = await apiInstance.addAccountInterest(
|
|
|
65
65
|
# **getAccountInterests**
|
|
66
66
|
> GetAccountInterests200Response getAccountInterests()
|
|
67
67
|
|
|
68
|
-
|
|
68
|
+
Returns a paginated list of interests associated with the specified account, with optional search by interest name, and requires permission to read accounts and interests.
|
|
69
69
|
|
|
70
70
|
### Example
|
|
71
71
|
|
|
@@ -128,7 +128,7 @@ const { status, data } = await apiInstance.getAccountInterests(
|
|
|
128
128
|
# **removeAccountInterest**
|
|
129
129
|
> CreateAccount200Response removeAccountInterest()
|
|
130
130
|
|
|
131
|
-
|
|
131
|
+
Removes the association between the given interest and the specified account and returns the updated account; requires update permission on accounts and interests.
|
|
132
132
|
|
|
133
133
|
### Example
|
|
134
134
|
|
|
@@ -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
|
-
|[**createAccountInvitations**](#createaccountinvitations) | **POST** /accounts/invitations |
|
|
8
|
-
|[**deleteAccountInvitation**](#deleteaccountinvitation) | **DELETE** /accounts/invitations/{email} | Delete
|
|
9
|
-
|[**getAccountInvitations**](#getaccountinvitations) | **GET** /accounts/invitations |
|
|
7
|
+
|[**createAccountInvitations**](#createaccountinvitations) | **POST** /accounts/invitations | Invite people to create accounts|
|
|
8
|
+
|[**deleteAccountInvitation**](#deleteaccountinvitation) | **DELETE** /accounts/invitations/{email} | Delete a pending account invitation|
|
|
9
|
+
|[**getAccountInvitations**](#getaccountinvitations) | **GET** /accounts/invitations | List pending account invitations|
|
|
10
10
|
|
|
11
11
|
# **createAccountInvitations**
|
|
12
12
|
> CreateAccountInvitations200Response createAccountInvitations(requestBody)
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
Creates pending account invitations for the given list of email addresses so those people can register with the organization; duplicate emails are skipped and requires create permission on accounts.
|
|
15
15
|
|
|
16
16
|
### Example
|
|
17
17
|
|
|
@@ -62,7 +62,7 @@ const { status, data } = await apiInstance.createAccountInvitations(
|
|
|
62
62
|
# **deleteAccountInvitation**
|
|
63
63
|
> CreateAccountInvitations200Response deleteAccountInvitation()
|
|
64
64
|
|
|
65
|
-
|
|
65
|
+
Deletes the pending account invitation for the given email address, revoking the invite; requires delete permission on accounts.
|
|
66
66
|
|
|
67
67
|
### Example
|
|
68
68
|
|
|
@@ -113,7 +113,7 @@ const { status, data } = await apiInstance.deleteAccountInvitation(
|
|
|
113
113
|
# **getAccountInvitations**
|
|
114
114
|
> GetAccountInvitations200Response getAccountInvitations()
|
|
115
115
|
|
|
116
|
-
|
|
116
|
+
Returns a paginated list of outstanding invitations for people to join the organization\'s accounts, with optional search by email, and requires permission to read accounts.
|
|
117
117
|
|
|
118
118
|
### Example
|
|
119
119
|
|
package/docs/AccountsLeadsApi.md
CHANGED
|
@@ -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
|
-
|[**deleteAccountLead**](#deleteaccountlead) | **DELETE** /accounts/{accountId}/leads/{leadId} | Delete
|
|
8
|
-
|[**getAccountLead**](#getaccountlead) | **GET** /accounts/{accountId}/leads/{leadId} | Get
|
|
9
|
-
|[**getAccountLeads**](#getaccountleads) | **GET** /accounts/{accountId}/leads |
|
|
10
|
-
|[**updateAccountLead**](#updateaccountlead) | **PUT** /accounts/{accountId}/leads/{leadId} | Update
|
|
7
|
+
|[**deleteAccountLead**](#deleteaccountlead) | **DELETE** /accounts/{accountId}/leads/{leadId} | Delete an account\'s lead|
|
|
8
|
+
|[**getAccountLead**](#getaccountlead) | **GET** /accounts/{accountId}/leads/{leadId} | Get a single account lead|
|
|
9
|
+
|[**getAccountLeads**](#getaccountleads) | **GET** /accounts/{accountId}/leads | List an account\'s leads|
|
|
10
|
+
|[**updateAccountLead**](#updateaccountlead) | **PUT** /accounts/{accountId}/leads/{leadId} | Update an account\'s lead|
|
|
11
11
|
|
|
12
12
|
# **deleteAccountLead**
|
|
13
13
|
> CreateAccountInvitations200Response deleteAccountLead()
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
Permanently deletes the specified lead record captured by the given account; requires update permission on accounts.
|
|
16
16
|
|
|
17
17
|
### Example
|
|
18
18
|
|
|
@@ -66,7 +66,7 @@ const { status, data } = await apiInstance.deleteAccountLead(
|
|
|
66
66
|
# **getAccountLead**
|
|
67
67
|
> GetAccountLead200Response getAccountLead()
|
|
68
68
|
|
|
69
|
-
|
|
69
|
+
Retrieves one lead record captured by the specified account by its lead ID, and requires permission to read accounts.
|
|
70
70
|
|
|
71
71
|
### Example
|
|
72
72
|
|
|
@@ -120,7 +120,7 @@ const { status, data } = await apiInstance.getAccountLead(
|
|
|
120
120
|
# **getAccountLeads**
|
|
121
121
|
> GetAccountLeads200Response getAccountLeads()
|
|
122
122
|
|
|
123
|
-
|
|
123
|
+
Returns a paginated list of leads captured by the given account, optionally filtered by lead status or by the event where they were captured, with search over the lead\'s name, title, company, or email; requires read access to accounts.
|
|
124
124
|
|
|
125
125
|
### Example
|
|
126
126
|
|
|
@@ -189,7 +189,7 @@ const { status, data } = await apiInstance.getAccountLeads(
|
|
|
189
189
|
# **updateAccountLead**
|
|
190
190
|
> GetAccountLead200Response updateAccountLead(leadUpdateInputs)
|
|
191
191
|
|
|
192
|
-
|
|
192
|
+
Updates fields (such as status or contact details) on the specified lead captured by the given account and returns the updated lead; requires update permission on accounts.
|
|
193
193
|
|
|
194
194
|
### Example
|
|
195
195
|
|
package/docs/AccountsTiersApi.md
CHANGED
|
@@ -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
|
-
|[**addAccountTier**](#addaccounttier) | **POST** /accounts/{accountId}/tiers/{tierId} | Add
|
|
8
|
-
|[**getAccountLevels**](#getaccountlevels) | **GET** /accounts/{accountId}/levels |
|
|
9
|
-
|[**getAccountTiers**](#getaccounttiers) | **GET** /accounts/{accountId}/tiers |
|
|
10
|
-
|[**removeAccountTier**](#removeaccounttier) | **DELETE** /accounts/{accountId}/tiers/{tierId} | Remove
|
|
7
|
+
|[**addAccountTier**](#addaccounttier) | **POST** /accounts/{accountId}/tiers/{tierId} | Add a tier to an account|
|
|
8
|
+
|[**getAccountLevels**](#getaccountlevels) | **GET** /accounts/{accountId}/levels | List an account\'s sponsorship levels|
|
|
9
|
+
|[**getAccountTiers**](#getaccounttiers) | **GET** /accounts/{accountId}/tiers | List an account\'s tiers|
|
|
10
|
+
|[**removeAccountTier**](#removeaccounttier) | **DELETE** /accounts/{accountId}/tiers/{tierId} | Remove a tier from an account|
|
|
11
11
|
|
|
12
12
|
# **addAccountTier**
|
|
13
13
|
> CreateAccount200Response addAccountTier()
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
Assigns the given membership tier to the specified account and returns the updated account; requires update permission on accounts and tiers.
|
|
16
16
|
|
|
17
17
|
### Example
|
|
18
18
|
|
|
@@ -66,7 +66,7 @@ const { status, data } = await apiInstance.addAccountTier(
|
|
|
66
66
|
# **getAccountLevels**
|
|
67
67
|
> GetAccountLevels200Response getAccountLevels()
|
|
68
68
|
|
|
69
|
-
|
|
69
|
+
Returns a paginated list of the sponsorship levels the given account is assigned to, with optional search over the level\'s name or description; requires read access to accounts and sponsors.
|
|
70
70
|
|
|
71
71
|
### Example
|
|
72
72
|
|
|
@@ -129,7 +129,7 @@ const { status, data } = await apiInstance.getAccountLevels(
|
|
|
129
129
|
# **getAccountTiers**
|
|
130
130
|
> GetAccountTiers200Response getAccountTiers()
|
|
131
131
|
|
|
132
|
-
|
|
132
|
+
Returns a paginated list of the account tiers assigned to the given account, optionally filtered to only \"internal\" or \"external\" tiers, with search over the tier\'s name or description; requires read access to accounts and tiers.
|
|
133
133
|
|
|
134
134
|
### Example
|
|
135
135
|
|
|
@@ -195,7 +195,7 @@ const { status, data } = await apiInstance.getAccountTiers(
|
|
|
195
195
|
# **removeAccountTier**
|
|
196
196
|
> CreateAccount200Response removeAccountTier()
|
|
197
197
|
|
|
198
|
-
|
|
198
|
+
Removes the association between the given tier and account, requiring update permission on both accounts and tiers.
|
|
199
199
|
|
|
200
200
|
### Example
|
|
201
201
|
|