@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
package/docs/OrganizationApi.md
CHANGED
|
@@ -4,20 +4,20 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**getOrganization**](#getorganization) | **GET** /organization | Get
|
|
8
|
-
|[**getOrganizationMembership**](#getorganizationmembership) | **GET** /organization/users/{userId} | Get
|
|
9
|
-
|[**getOrganizationSystemLog**](#getorganizationsystemlog) | **GET** /organization/system-logs/{logId} | Get
|
|
10
|
-
|[**getOrganizationSystemLogs**](#getorganizationsystemlogs) | **GET** /organization/system-logs |
|
|
11
|
-
|[**searchOrganization**](#searchorganization) | **GET** /organization/search | Search
|
|
12
|
-
|[**updateOrganization**](#updateorganization) | **PUT** /organization | Update
|
|
13
|
-
|[**updateOrganizationIntegrations**](#updateorganizationintegrations) | **PUT** /organization/integrations | Update
|
|
14
|
-
|[**updateOrganizationMembership**](#updateorganizationmembership) | **PUT** /organization/users/{userId} | Update
|
|
15
|
-
|[**upsertLinkPreview**](#upsertlinkpreview) | **PUT** /organization/link-preview |
|
|
7
|
+
|[**getOrganization**](#getorganization) | **GET** /organization | Get the organization profile|
|
|
8
|
+
|[**getOrganizationMembership**](#getorganizationmembership) | **GET** /organization/users/{userId} | Get a user\'s organization membership|
|
|
9
|
+
|[**getOrganizationSystemLog**](#getorganizationsystemlog) | **GET** /organization/system-logs/{logId} | Get a single organization system log|
|
|
10
|
+
|[**getOrganizationSystemLogs**](#getorganizationsystemlogs) | **GET** /organization/system-logs | List organization system event logs|
|
|
11
|
+
|[**searchOrganization**](#searchorganization) | **GET** /organization/search | Search across the organization|
|
|
12
|
+
|[**updateOrganization**](#updateorganization) | **PUT** /organization | Update the organization\'s profile|
|
|
13
|
+
|[**updateOrganizationIntegrations**](#updateorganizationintegrations) | **PUT** /organization/integrations | Update the organization\'s Ghost CMS integration|
|
|
14
|
+
|[**updateOrganizationMembership**](#updateorganizationmembership) | **PUT** /organization/users/{userId} | Update a team member\'s organization permissions|
|
|
15
|
+
|[**upsertLinkPreview**](#upsertlinkpreview) | **PUT** /organization/link-preview | Generate or refresh a link preview|
|
|
16
16
|
|
|
17
17
|
# **getOrganization**
|
|
18
18
|
> GetOrganization200Response getOrganization()
|
|
19
19
|
|
|
20
|
-
|
|
20
|
+
Returns the current organization\'s profile; open to any authenticated caller with no specific permission required.
|
|
21
21
|
|
|
22
22
|
### Example
|
|
23
23
|
|
|
@@ -61,7 +61,7 @@ This endpoint does not have any parameters.
|
|
|
61
61
|
# **getOrganizationMembership**
|
|
62
62
|
> AddOrganizationUser200Response getOrganizationMembership()
|
|
63
63
|
|
|
64
|
-
|
|
64
|
+
Returns the organization membership record for the given user ID, requiring the \"read\" permission on both \"org\" and \"users\".
|
|
65
65
|
|
|
66
66
|
### Example
|
|
67
67
|
|
|
@@ -112,7 +112,7 @@ const { status, data } = await apiInstance.getOrganizationMembership(
|
|
|
112
112
|
# **getOrganizationSystemLog**
|
|
113
113
|
> GetOrganizationSystemLog200Response getOrganizationSystemLog()
|
|
114
114
|
|
|
115
|
-
|
|
115
|
+
Returns a single system event log entry by ID for the organization, requiring the \"read\" permission on both \"org\" and \"logs\".
|
|
116
116
|
|
|
117
117
|
### Example
|
|
118
118
|
|
|
@@ -163,7 +163,7 @@ const { status, data } = await apiInstance.getOrganizationSystemLog(
|
|
|
163
163
|
# **getOrganizationSystemLogs**
|
|
164
164
|
> GetOrganizationSystemLogs200Response getOrganizationSystemLogs()
|
|
165
165
|
|
|
166
|
-
|
|
166
|
+
Returns a paginated list of system event logs for the organization, filterable by status and trigger in addition to page, pageSize, orderBy, and search, and requiring the \"read\" permission on both \"org\" and \"logs\".
|
|
167
167
|
|
|
168
168
|
### Example
|
|
169
169
|
|
|
@@ -229,7 +229,7 @@ const { status, data } = await apiInstance.getOrganizationSystemLogs(
|
|
|
229
229
|
# **searchOrganization**
|
|
230
230
|
> SearchOrganization200Response searchOrganization()
|
|
231
231
|
|
|
232
|
-
|
|
232
|
+
Performs a fuzzy, org-wide search using the given search term and optional filters, returning matching records (e.g. accounts, events) as search fields; available to any authenticated user of the organization.
|
|
233
233
|
|
|
234
234
|
### Example
|
|
235
235
|
|
|
@@ -281,7 +281,7 @@ const { status, data } = await apiInstance.searchOrganization(
|
|
|
281
281
|
# **updateOrganization**
|
|
282
282
|
> GetOrganization200Response updateOrganization(organizationUpdateInputs)
|
|
283
283
|
|
|
284
|
-
|
|
284
|
+
Updates the current organization\'s core profile fields (such as name, address, and locales) and returns the updated organization record; requires update permission on the organization.
|
|
285
285
|
|
|
286
286
|
### Example
|
|
287
287
|
|
|
@@ -333,7 +333,7 @@ const { status, data } = await apiInstance.updateOrganization(
|
|
|
333
333
|
# **updateOrganizationIntegrations**
|
|
334
334
|
> CreateAccountInvitations200Response updateOrganizationIntegrations()
|
|
335
335
|
|
|
336
|
-
|
|
336
|
+
Enables or disables the organization\'s Ghost blog integration and stores its connection settings (site URL, admin API key, content API key) so published Ghost content can be surfaced in the platform.
|
|
337
337
|
|
|
338
338
|
### Example
|
|
339
339
|
|
|
@@ -393,7 +393,7 @@ const { status, data } = await apiInstance.updateOrganizationIntegrations(
|
|
|
393
393
|
# **updateOrganizationMembership**
|
|
394
394
|
> AddOrganizationUser200Response updateOrganizationMembership(organizationMembershipUpdateInputs)
|
|
395
395
|
|
|
396
|
-
|
|
396
|
+
Updates the module-by-module read/create/update/delete permissions for a user\'s membership in the organization, requires organization read and users update permissions.
|
|
397
397
|
|
|
398
398
|
### Example
|
|
399
399
|
|
|
@@ -448,7 +448,7 @@ const { status, data } = await apiInstance.updateOrganizationMembership(
|
|
|
448
448
|
# **upsertLinkPreview**
|
|
449
449
|
> UpsertLinkPreview200Response upsertLinkPreview()
|
|
450
450
|
|
|
451
|
-
|
|
451
|
+
Fetches (or returns a cached, up to 7 days old) title, description, image, and site metadata for the given URL, storing the result so it can be reused when rendering link previews.
|
|
452
452
|
|
|
453
453
|
### Example
|
|
454
454
|
|
|
@@ -4,18 +4,18 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**createAccountAttribute**](#createaccountattribute) | **POST** /organization/attributes | Create
|
|
8
|
-
|[**deleteAccountAttribute**](#deleteaccountattribute) | **DELETE** /organization/attributes/{attributeId} | Delete
|
|
9
|
-
|[**getDashboardAttributes**](#getdashboardattributes) | **GET** /organization/attributes/dashboard |
|
|
10
|
-
|[**getOrganizationAccountAttribute**](#getorganizationaccountattribute) | **GET** /organization/attributes/{attributeId} | Get
|
|
11
|
-
|[**getOrganizationAccountAttributes**](#getorganizationaccountattributes) | **GET** /organization/attributes |
|
|
12
|
-
|[**getRequiredAttributes**](#getrequiredattributes) | **GET** /organization/attributes/required |
|
|
13
|
-
|[**updateAccountAttribute**](#updateaccountattribute) | **PUT** /organization/attributes/{attributeId} | Update
|
|
7
|
+
|[**createAccountAttribute**](#createaccountattribute) | **POST** /organization/attributes | Create an account attribute|
|
|
8
|
+
|[**deleteAccountAttribute**](#deleteaccountattribute) | **DELETE** /organization/attributes/{attributeId} | Delete an account attribute|
|
|
9
|
+
|[**getDashboardAttributes**](#getdashboardattributes) | **GET** /organization/attributes/dashboard | List account attributes shown on dashboards|
|
|
10
|
+
|[**getOrganizationAccountAttribute**](#getorganizationaccountattribute) | **GET** /organization/attributes/{attributeId} | Get an account attribute definition|
|
|
11
|
+
|[**getOrganizationAccountAttributes**](#getorganizationaccountattributes) | **GET** /organization/attributes | List account attribute definitions|
|
|
12
|
+
|[**getRequiredAttributes**](#getrequiredattributes) | **GET** /organization/attributes/required | List required account attributes|
|
|
13
|
+
|[**updateAccountAttribute**](#updateaccountattribute) | **PUT** /organization/attributes/{attributeId} | Update an account attribute|
|
|
14
14
|
|
|
15
15
|
# **createAccountAttribute**
|
|
16
16
|
> CreateAccountAttribute200Response createAccountAttribute(accountAttributeCreateInputs)
|
|
17
17
|
|
|
18
|
-
|
|
18
|
+
Creates a new custom account attribute definition for the organization, automatically assigning or shifting sortOrder among existing attributes, and requires the \"update\" permission on \"org\".
|
|
19
19
|
|
|
20
20
|
### Example
|
|
21
21
|
|
|
@@ -67,7 +67,7 @@ const { status, data } = await apiInstance.createAccountAttribute(
|
|
|
67
67
|
# **deleteAccountAttribute**
|
|
68
68
|
> CreateAccountInvitations200Response deleteAccountAttribute()
|
|
69
69
|
|
|
70
|
-
|
|
70
|
+
Permanently deletes the specified custom account attribute from the organization and re-sequences the sortOrder of the remaining attributes, requiring the \"update\" permission on \"org\".
|
|
71
71
|
|
|
72
72
|
### Example
|
|
73
73
|
|
|
@@ -118,7 +118,7 @@ const { status, data } = await apiInstance.deleteAccountAttribute(
|
|
|
118
118
|
# **getDashboardAttributes**
|
|
119
119
|
> GetDashboardAttributes200Response getDashboardAttributes()
|
|
120
120
|
|
|
121
|
-
|
|
121
|
+
Returns the account attributes flagged to appear in dashboard widgets that have at least one non-empty value, excluding location-type attributes, optionally filtered by a search term; requires read access to the organization and to dashboards.
|
|
122
122
|
|
|
123
123
|
### Example
|
|
124
124
|
|
|
@@ -162,7 +162,7 @@ This endpoint does not have any parameters.
|
|
|
162
162
|
# **getOrganizationAccountAttribute**
|
|
163
163
|
> CreateAccountAttribute200Response getOrganizationAccountAttribute()
|
|
164
164
|
|
|
165
|
-
|
|
165
|
+
Returns the details of a single custom account attribute definition for the organization, identified by attribute ID; requires read access to the organization.
|
|
166
166
|
|
|
167
167
|
### Example
|
|
168
168
|
|
|
@@ -213,7 +213,7 @@ const { status, data } = await apiInstance.getOrganizationAccountAttribute(
|
|
|
213
213
|
# **getOrganizationAccountAttributes**
|
|
214
214
|
> GetOrganizationAccountAttributes200Response getOrganizationAccountAttributes()
|
|
215
215
|
|
|
216
|
-
|
|
216
|
+
Returns a paginated list of custom account attribute definitions configured for the organization, filterable by search term and sortable via orderBy; requires read access to the organization.
|
|
217
217
|
|
|
218
218
|
### Example
|
|
219
219
|
|
|
@@ -273,7 +273,7 @@ const { status, data } = await apiInstance.getOrganizationAccountAttributes(
|
|
|
273
273
|
# **getRequiredAttributes**
|
|
274
274
|
> GetDashboardAttributes200Response getRequiredAttributes()
|
|
275
275
|
|
|
276
|
-
|
|
276
|
+
Returns the account attributes marked as required that have at least one non-empty value, optionally filtered by a search term; requires read access to the organization and to dashboards.
|
|
277
277
|
|
|
278
278
|
### Example
|
|
279
279
|
|
|
@@ -317,7 +317,7 @@ This endpoint does not have any parameters.
|
|
|
317
317
|
# **updateAccountAttribute**
|
|
318
318
|
> CreateAccountAttribute200Response updateAccountAttribute(accountAttributeUpdateInputs)
|
|
319
319
|
|
|
320
|
-
|
|
320
|
+
Updates the properties of an existing account attribute, such as its label, type, options, or sortOrder (re-sequencing other attributes as needed), and requires the \"update\" permission on \"org\".
|
|
321
321
|
|
|
322
322
|
### Example
|
|
323
323
|
|
|
@@ -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
|
-
|[**deleteOrganizationDomain**](#deleteorganizationdomain) | **DELETE** /organization/domain |
|
|
8
|
-
|[**getOrganizationDomain**](#getorganizationdomain) | **GET** /organization/domain | Get
|
|
9
|
-
|[**updateOrganizationDomain**](#updateorganizationdomain) | **PUT** /organization/domain |
|
|
7
|
+
|[**deleteOrganizationDomain**](#deleteorganizationdomain) | **DELETE** /organization/domain | Remove the organization\'s custom domain|
|
|
8
|
+
|[**getOrganizationDomain**](#getorganizationdomain) | **GET** /organization/domain | Get the organization\'s custom domain|
|
|
9
|
+
|[**updateOrganizationDomain**](#updateorganizationdomain) | **PUT** /organization/domain | Set the organization\'s custom domain|
|
|
10
10
|
|
|
11
11
|
# **deleteOrganizationDomain**
|
|
12
12
|
> CreateAccountInvitations200Response deleteOrganizationDomain()
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
Removes the organization\'s configured custom domain, deleting the associated records (including any www subdomain) from Vercel and clearing the domain on the organization; requires the \"update\" permission on \"org\".
|
|
15
15
|
|
|
16
16
|
### Example
|
|
17
17
|
|
|
@@ -55,7 +55,7 @@ This endpoint does not have any parameters.
|
|
|
55
55
|
# **getOrganizationDomain**
|
|
56
56
|
> GetOrganizationDomain200Response getOrganizationDomain()
|
|
57
57
|
|
|
58
|
-
|
|
58
|
+
Returns the custom domain configured for the organization along with its verification/DNS status from the hosting provider, or null if no domain is configured; requires read access to the organization.
|
|
59
59
|
|
|
60
60
|
### Example
|
|
61
61
|
|
|
@@ -99,7 +99,7 @@ This endpoint does not have any parameters.
|
|
|
99
99
|
# **updateOrganizationDomain**
|
|
100
100
|
> UpdateOrganizationDomain200Response updateOrganizationDomain()
|
|
101
101
|
|
|
102
|
-
|
|
102
|
+
Configures a custom domain for the organization by registering it (and its www subdomain, unless it is itself a subdomain) with Vercel, then saves the domain on the organization record; fails if a domain is already set or the domain is invalid, and requires the \"update\" permission on \"org\".
|
|
103
103
|
|
|
104
104
|
### Example
|
|
105
105
|
|
|
@@ -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
|
-
|[**createIntegration**](#createintegration) | **POST** /organization/integrations | Create
|
|
8
|
-
|[**deleteIntegration**](#deleteintegration) | **DELETE** /organization/integrations/{integrationId} | Delete
|
|
9
|
-
|[**getIntegration**](#getintegration) | **GET** /organization/integrations/{integrationId} | Get
|
|
10
|
-
|[**getIntegrations**](#getintegrations) | **GET** /organization/integrations |
|
|
11
|
-
|[**updateIntegration**](#updateintegration) | **PUT** /organization/integrations/{integrationId} | Update
|
|
7
|
+
|[**createIntegration**](#createintegration) | **POST** /organization/integrations | Create an organization integration|
|
|
8
|
+
|[**deleteIntegration**](#deleteintegration) | **DELETE** /organization/integrations/{integrationId} | Delete an organization integration|
|
|
9
|
+
|[**getIntegration**](#getintegration) | **GET** /organization/integrations/{integrationId} | Get an organization integration|
|
|
10
|
+
|[**getIntegrations**](#getintegrations) | **GET** /organization/integrations | List an organization\'s integrations|
|
|
11
|
+
|[**updateIntegration**](#updateintegration) | **PUT** /organization/integrations/{integrationId} | Update an organization integration|
|
|
12
12
|
|
|
13
13
|
# **createIntegration**
|
|
14
14
|
> CreateIntegration200Response createIntegration(integrationCreateInputs)
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
Creates a new third-party integration (e.g. Snagtag) for the organization, storing any provided secret key securely in AWS Secrets Manager; fails if an integration of that type already exists, and requires the \"update\" permission on \"org\".
|
|
17
17
|
|
|
18
18
|
### Example
|
|
19
19
|
|
|
@@ -65,7 +65,7 @@ const { status, data } = await apiInstance.createIntegration(
|
|
|
65
65
|
# **deleteIntegration**
|
|
66
66
|
> CreateAccountInvitations200Response deleteIntegration()
|
|
67
67
|
|
|
68
|
-
|
|
68
|
+
Deletes the specified integration configured for the organization, also removing its stored secret from AWS Secrets Manager if one exists, and requires the \"update\" permission on \"org\".
|
|
69
69
|
|
|
70
70
|
### Example
|
|
71
71
|
|
|
@@ -116,7 +116,7 @@ const { status, data } = await apiInstance.deleteIntegration(
|
|
|
116
116
|
# **getIntegration**
|
|
117
117
|
> CreateIntegration200Response getIntegration()
|
|
118
118
|
|
|
119
|
-
|
|
119
|
+
Returns the details of a single third-party integration configured for the organization, identified by integration ID, with any stored secret masked; requires read access to the organization.
|
|
120
120
|
|
|
121
121
|
### Example
|
|
122
122
|
|
|
@@ -167,7 +167,7 @@ const { status, data } = await apiInstance.getIntegration(
|
|
|
167
167
|
# **getIntegrations**
|
|
168
168
|
> GetIntegrations200Response getIntegrations()
|
|
169
169
|
|
|
170
|
-
|
|
170
|
+
Returns a paginated list of third-party integrations configured for the organization, with any stored secrets masked, sortable via orderBy; requires read access to the organization.
|
|
171
171
|
|
|
172
172
|
### Example
|
|
173
173
|
|
|
@@ -227,7 +227,7 @@ const { status, data } = await apiInstance.getIntegrations(
|
|
|
227
227
|
# **updateIntegration**
|
|
228
228
|
> CreateIntegration200Response updateIntegration(integrationUpdateInputs)
|
|
229
229
|
|
|
230
|
-
|
|
230
|
+
Updates an existing integration\'s settings, such as enabled state, public URL, public key, or secret key (re-stored in AWS Secrets Manager), and requires the \"update\" permission on \"org\".
|
|
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
|
-
|[**getOrganizationModule**](#getorganizationmodule) | **GET** /organization/modules/{moduleType} | Get
|
|
8
|
-
|[**getOrganizationModules**](#getorganizationmodules) | **GET** /organization/modules |
|
|
9
|
-
|[**updateOrganizationModule**](#updateorganizationmodule) | **PUT** /organization/modules/{moduleType} | Update
|
|
7
|
+
|[**getOrganizationModule**](#getorganizationmodule) | **GET** /organization/modules/{moduleType} | Get an organization module\'s configuration|
|
|
8
|
+
|[**getOrganizationModules**](#getorganizationmodules) | **GET** /organization/modules | List an organization\'s module configurations|
|
|
9
|
+
|[**updateOrganizationModule**](#updateorganizationmodule) | **PUT** /organization/modules/{moduleType} | Update an organization module\'s settings|
|
|
10
10
|
|
|
11
11
|
# **getOrganizationModule**
|
|
12
12
|
> GetOrganizationModule200Response getOrganizationModule()
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
Returns the enablement configuration for a single feature module type on the organization (enabled state, tier restrictions, auth requirement), defaulting to enabled if no record exists yet; requires org read permission.
|
|
15
15
|
|
|
16
16
|
### Example
|
|
17
17
|
|
|
@@ -62,7 +62,7 @@ const { status, data } = await apiInstance.getOrganizationModule(
|
|
|
62
62
|
# **getOrganizationModules**
|
|
63
63
|
> GetOrganizationModules200Response getOrganizationModules()
|
|
64
64
|
|
|
65
|
-
|
|
65
|
+
Returns the enablement configuration for every feature module type on the organization, filling in default values (enabled, no tier restrictions) for module types that have no explicit record yet; requires org read permission.
|
|
66
66
|
|
|
67
67
|
### Example
|
|
68
68
|
|
|
@@ -122,7 +122,7 @@ const { status, data } = await apiInstance.getOrganizationModules(
|
|
|
122
122
|
# **updateOrganizationModule**
|
|
123
123
|
> GetOrganizationModule200Response updateOrganizationModule(organizationModuleUpdateInputs)
|
|
124
124
|
|
|
125
|
-
|
|
125
|
+
Updates the configuration (such as enabled state, requireAuth, or editable tiers) of a given organization module type for the current organization, requiring update permission on the org resource.
|
|
126
126
|
|
|
127
127
|
### Example
|
|
128
128
|
|
|
@@ -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
|
-
|[**createCustomModule**](#createcustommodule) | **POST** /organization/modules/custom | Create
|
|
8
|
-
|[**deleteCustomModule**](#deletecustommodule) | **DELETE** /organization/modules/custom/{moduleId} | Delete
|
|
9
|
-
|[**getCustomModule**](#getcustommodule) | **GET** /organization/modules/custom/{moduleId} | Get
|
|
10
|
-
|[**getCustomModules**](#getcustommodules) | **GET** /organization/modules/custom |
|
|
11
|
-
|[**updateCustomModule**](#updatecustommodule) | **PUT** /organization/modules/custom/{moduleId} | Update
|
|
7
|
+
|[**createCustomModule**](#createcustommodule) | **POST** /organization/modules/custom | Create a custom module|
|
|
8
|
+
|[**deleteCustomModule**](#deletecustommodule) | **DELETE** /organization/modules/custom/{moduleId} | Delete a custom module|
|
|
9
|
+
|[**getCustomModule**](#getcustommodule) | **GET** /organization/modules/custom/{moduleId} | Get a custom module|
|
|
10
|
+
|[**getCustomModules**](#getcustommodules) | **GET** /organization/modules/custom | List an organization\'s custom modules|
|
|
11
|
+
|[**updateCustomModule**](#updatecustommodule) | **PUT** /organization/modules/custom/{moduleId} | Update a custom module|
|
|
12
12
|
|
|
13
13
|
# **createCustomModule**
|
|
14
14
|
> CreateCustomModule200Response createCustomModule(customModuleCreateInputs)
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
Creates a new organization-defined custom module using the provided module fields, requires the update org permission, and invalidates the custom modules list and detail caches on success.
|
|
17
17
|
|
|
18
18
|
### Example
|
|
19
19
|
|
|
@@ -65,7 +65,7 @@ const { status, data } = await apiInstance.createCustomModule(
|
|
|
65
65
|
# **deleteCustomModule**
|
|
66
66
|
> CreateAccountInvitations200Response deleteCustomModule()
|
|
67
67
|
|
|
68
|
-
|
|
68
|
+
Permanently deletes the organization\'s custom module identified by moduleId, requires the update org permission, and removes the module from the custom modules list and detail caches on success.
|
|
69
69
|
|
|
70
70
|
### Example
|
|
71
71
|
|
|
@@ -116,7 +116,7 @@ const { status, data } = await apiInstance.deleteCustomModule(
|
|
|
116
116
|
# **getCustomModule**
|
|
117
117
|
> CreateCustomModule200Response getCustomModule()
|
|
118
118
|
|
|
119
|
-
|
|
119
|
+
Returns the details of a single custom module (name, URL, icon, color, description, position, and enabled state) for the organization; requires org read permission.
|
|
120
120
|
|
|
121
121
|
### Example
|
|
122
122
|
|
|
@@ -167,7 +167,7 @@ const { status, data } = await apiInstance.getCustomModule(
|
|
|
167
167
|
# **getCustomModules**
|
|
168
168
|
> GetCustomModules200Response getCustomModules()
|
|
169
169
|
|
|
170
|
-
|
|
170
|
+
Returns a paginated list of the organization\'s custom modules (custom navigation links/apps with a name, URL, icon, and color), supporting search and ordering by sort order; requires org read permission.
|
|
171
171
|
|
|
172
172
|
### Example
|
|
173
173
|
|
|
@@ -227,7 +227,7 @@ const { status, data } = await apiInstance.getCustomModules(
|
|
|
227
227
|
# **updateCustomModule**
|
|
228
228
|
> CreateCustomModule200Response updateCustomModule(customModuleUpdateInputs)
|
|
229
229
|
|
|
230
|
-
|
|
230
|
+
Updates the fields of the organization\'s custom module identified by moduleId, requires the update org permission, and refreshes the custom modules list and detail caches on success.
|
|
231
231
|
|
|
232
232
|
### Example
|
|
233
233
|
|
|
@@ -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
|
-
|[**deleteCustomModuleTranslation**](#deletecustommoduletranslation) | **DELETE** /organization/modules/custom/{moduleId}/translations/{locale} | Delete
|
|
8
|
-
|[**getCustomModuleTranslation**](#getcustommoduletranslation) | **GET** /organization/modules/custom/{moduleId}/translations/{locale} | Get
|
|
9
|
-
|[**getCustomModuleTranslations**](#getcustommoduletranslations) | **GET** /organization/modules/custom/{moduleId}/translations |
|
|
10
|
-
|[**updateCustomModuleTranslation**](#updatecustommoduletranslation) | **PUT** /organization/modules/custom/{moduleId}/translations/{locale} | Update
|
|
7
|
+
|[**deleteCustomModuleTranslation**](#deletecustommoduletranslation) | **DELETE** /organization/modules/custom/{moduleId}/translations/{locale} | Delete a custom module translation|
|
|
8
|
+
|[**getCustomModuleTranslation**](#getcustommoduletranslation) | **GET** /organization/modules/custom/{moduleId}/translations/{locale} | Get a custom module\'s translation for a locale|
|
|
9
|
+
|[**getCustomModuleTranslations**](#getcustommoduletranslations) | **GET** /organization/modules/custom/{moduleId}/translations | List a custom module\'s translations|
|
|
10
|
+
|[**updateCustomModuleTranslation**](#updatecustommoduletranslation) | **PUT** /organization/modules/custom/{moduleId}/translations/{locale} | Update a custom module translation|
|
|
11
11
|
|
|
12
12
|
# **deleteCustomModuleTranslation**
|
|
13
13
|
> CreateAccountInvitations200Response deleteCustomModuleTranslation()
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
Deletes the translation for the given locale on the specified custom module, and requires the \"update\" permission on \"org\".
|
|
16
16
|
|
|
17
17
|
### Example
|
|
18
18
|
|
|
@@ -66,7 +66,7 @@ const { status, data } = await apiInstance.deleteCustomModuleTranslation(
|
|
|
66
66
|
# **getCustomModuleTranslation**
|
|
67
67
|
> GetCustomModuleTranslation200Response getCustomModuleTranslation()
|
|
68
68
|
|
|
69
|
-
|
|
69
|
+
Returns the translated strings for a custom module in a specific locale, identified by module ID and locale code; requires read access to the organization.
|
|
70
70
|
|
|
71
71
|
### Example
|
|
72
72
|
|
|
@@ -120,7 +120,7 @@ const { status, data } = await apiInstance.getCustomModuleTranslation(
|
|
|
120
120
|
# **getCustomModuleTranslations**
|
|
121
121
|
> GetCustomModuleTranslations200Response getCustomModuleTranslations()
|
|
122
122
|
|
|
123
|
-
|
|
123
|
+
Returns a paginated list of locale translations for the specified custom module, supporting search and ordering; requires org read permission.
|
|
124
124
|
|
|
125
125
|
### Example
|
|
126
126
|
|
|
@@ -183,7 +183,7 @@ const { status, data } = await apiInstance.getCustomModuleTranslations(
|
|
|
183
183
|
# **updateCustomModuleTranslation**
|
|
184
184
|
> GetCustomModuleTranslation200Response updateCustomModuleTranslation(customModuleTranslationUpdateInputs)
|
|
185
185
|
|
|
186
|
-
|
|
186
|
+
Creates or updates the translated content (e.g. name) for a custom module in the given locale, upserting the record if it doesn\'t already exist, and requires the \"update\" permission on \"org\".
|
|
187
187
|
|
|
188
188
|
### Example
|
|
189
189
|
|
|
@@ -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
|
-
|[**getOrganizationModuleSettings**](#getorganizationmodulesettings) | **GET** /organization/module-settings | Get
|
|
8
|
-
|[**updateOrganizationModuleSettings**](#updateorganizationmodulesettings) | **PUT** /organization/module-settings | Update
|
|
7
|
+
|[**getOrganizationModuleSettings**](#getorganizationmodulesettings) | **GET** /organization/module-settings | Get an organization\'s module settings|
|
|
8
|
+
|[**updateOrganizationModuleSettings**](#updateorganizationmodulesettings) | **PUT** /organization/module-settings | Update organization module settings|
|
|
9
9
|
|
|
10
10
|
# **getOrganizationModuleSettings**
|
|
11
11
|
> GetOrganizationModuleSettings200Response getOrganizationModuleSettings()
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
Returns the organization\'s cross-module configuration (e.g. meeting call/webinar/livestream presets and support auto-resolve behavior), creating default settings if none exist yet; requires org read permission.
|
|
14
14
|
|
|
15
15
|
### Example
|
|
16
16
|
|
|
@@ -54,7 +54,7 @@ This endpoint does not have any parameters.
|
|
|
54
54
|
# **updateOrganizationModuleSettings**
|
|
55
55
|
> GetOrganizationModuleSettings200Response updateOrganizationModuleSettings(organizationModuleSettingsUpdateInputs)
|
|
56
56
|
|
|
57
|
-
|
|
57
|
+
Upserts the organization\'s module settings with the provided fields, creating the settings record if it does not yet exist, and requires the update org permission.
|
|
58
58
|
|
|
59
59
|
### Example
|
|
60
60
|
|
|
@@ -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
|
-
|[**deleteOrganizationModuleSettingsTranslation**](#deleteorganizationmodulesettingstranslation) | **DELETE** /organization/module-settings/translations/{locale} | Delete
|
|
8
|
-
|[**getOrganizationModuleSettingsTranslation**](#getorganizationmodulesettingstranslation) | **GET** /organization/module-settings/translations/{locale} | Get
|
|
9
|
-
|[**getOrganizationModuleSettingsTranslations**](#getorganizationmodulesettingstranslations) | **GET** /organization/module-settings/translations |
|
|
10
|
-
|[**updateOrganizationModuleSettingsTranslation**](#updateorganizationmodulesettingstranslation) | **PUT** /organization/module-settings/translations/{locale} |
|
|
7
|
+
|[**deleteOrganizationModuleSettingsTranslation**](#deleteorganizationmodulesettingstranslation) | **DELETE** /organization/module-settings/translations/{locale} | Delete a module settings translation|
|
|
8
|
+
|[**getOrganizationModuleSettingsTranslation**](#getorganizationmodulesettingstranslation) | **GET** /organization/module-settings/translations/{locale} | Get a module settings translation|
|
|
9
|
+
|[**getOrganizationModuleSettingsTranslations**](#getorganizationmodulesettingstranslations) | **GET** /organization/module-settings/translations | List an organization\'s module settings translations|
|
|
10
|
+
|[**updateOrganizationModuleSettingsTranslation**](#updateorganizationmodulesettingstranslation) | **PUT** /organization/module-settings/translations/{locale} | Create or update a module settings translation|
|
|
11
11
|
|
|
12
12
|
# **deleteOrganizationModuleSettingsTranslation**
|
|
13
13
|
> SyncAccounts200Response deleteOrganizationModuleSettingsTranslation()
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
Deletes the organization\'s module settings translation for the given locale, requires the update org permission, and invalidates the translations list and that locale\'s cached entry on success.
|
|
16
16
|
|
|
17
17
|
### Example
|
|
18
18
|
|
|
@@ -63,7 +63,7 @@ const { status, data } = await apiInstance.deleteOrganizationModuleSettingsTrans
|
|
|
63
63
|
# **getOrganizationModuleSettingsTranslation**
|
|
64
64
|
> GetOrganizationModuleSettingsTranslation200Response getOrganizationModuleSettingsTranslation()
|
|
65
65
|
|
|
66
|
-
|
|
66
|
+
Returns the organization\'s module settings translation (e.g. localized support auto-resolve message) for the specified locale; requires org read permission.
|
|
67
67
|
|
|
68
68
|
### Example
|
|
69
69
|
|
|
@@ -114,7 +114,7 @@ const { status, data } = await apiInstance.getOrganizationModuleSettingsTranslat
|
|
|
114
114
|
# **getOrganizationModuleSettingsTranslations**
|
|
115
115
|
> GetOrganizationModuleSettingsTranslations200Response getOrganizationModuleSettingsTranslations()
|
|
116
116
|
|
|
117
|
-
|
|
117
|
+
Returns a paginated list of the organization\'s module settings translations across locales, supporting search and ordering; requires org read permission.
|
|
118
118
|
|
|
119
119
|
### Example
|
|
120
120
|
|
|
@@ -174,7 +174,7 @@ const { status, data } = await apiInstance.getOrganizationModuleSettingsTranslat
|
|
|
174
174
|
# **updateOrganizationModuleSettingsTranslation**
|
|
175
175
|
> SyncAccounts200Response updateOrganizationModuleSettingsTranslation(organizationModuleSettingsTranslationUpdateInputs)
|
|
176
176
|
|
|
177
|
-
|
|
177
|
+
Upserts the organization\'s module settings translation for the given locale with the provided fields, requires the update org permission, and refreshes the translations list and that locale\'s cached entry on success.
|
|
178
178
|
|
|
179
179
|
### Example
|
|
180
180
|
|
|
@@ -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
|
-
|[**addOrganizationModuleEditableTier**](#addorganizationmoduleeditabletier) | **POST** /organization/modules/{moduleType}/editableTiers/{tierId} | Add
|
|
8
|
-
|[**addOrganizationModuleEnabledTier**](#addorganizationmoduleenabledtier) | **POST** /organization/modules/{moduleType}/enabledTiers/{tierId} | Add
|
|
9
|
-
|[**getOrganizationModuleEditableTiers**](#getorganizationmoduleeditabletiers) | **GET** /organization/modules/{moduleType}/editableTiers |
|
|
10
|
-
|[**getOrganizationModuleEnabledTiers**](#getorganizationmoduleenabledtiers) | **GET** /organization/modules/{moduleType}/enabledTiers |
|
|
11
|
-
|[**removeOrganizationModuleEditableTier**](#removeorganizationmoduleeditabletier) | **DELETE** /organization/modules/{moduleType}/editableTiers/{tierId} | Remove
|
|
12
|
-
|[**removeOrganizationModuleEnabledTier**](#removeorganizationmoduleenabledtier) | **DELETE** /organization/modules/{moduleType}/enabledTiers/{tierId} | Remove
|
|
7
|
+
|[**addOrganizationModuleEditableTier**](#addorganizationmoduleeditabletier) | **POST** /organization/modules/{moduleType}/editableTiers/{tierId} | Add an editable tier to a module|
|
|
8
|
+
|[**addOrganizationModuleEnabledTier**](#addorganizationmoduleenabledtier) | **POST** /organization/modules/{moduleType}/enabledTiers/{tierId} | Add an enabled tier to a module|
|
|
9
|
+
|[**getOrganizationModuleEditableTiers**](#getorganizationmoduleeditabletiers) | **GET** /organization/modules/{moduleType}/editableTiers | List a module\'s editable account tiers|
|
|
10
|
+
|[**getOrganizationModuleEnabledTiers**](#getorganizationmoduleenabledtiers) | **GET** /organization/modules/{moduleType}/enabledTiers | List a module\'s enabled account tiers|
|
|
11
|
+
|[**removeOrganizationModuleEditableTier**](#removeorganizationmoduleeditabletier) | **DELETE** /organization/modules/{moduleType}/editableTiers/{tierId} | Remove an editable tier from a module|
|
|
12
|
+
|[**removeOrganizationModuleEnabledTier**](#removeorganizationmoduleenabledtier) | **DELETE** /organization/modules/{moduleType}/enabledTiers/{tierId} | Remove an enabled tier from a module|
|
|
13
13
|
|
|
14
14
|
# **addOrganizationModuleEditableTier**
|
|
15
15
|
> GetOrganizationModule200Response addOrganizationModuleEditableTier()
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
Grants the specified account tier permission to edit the given organization module type, requires the update org permission, and invalidates the modules list and that module\'s cached detail on success.
|
|
18
18
|
|
|
19
19
|
### Example
|
|
20
20
|
|
|
@@ -68,7 +68,7 @@ const { status, data } = await apiInstance.addOrganizationModuleEditableTier(
|
|
|
68
68
|
# **addOrganizationModuleEnabledTier**
|
|
69
69
|
> GetOrganizationModule200Response addOrganizationModuleEnabledTier()
|
|
70
70
|
|
|
71
|
-
|
|
71
|
+
Grants the specified account tier access to use the given organization module type, requires the update org permission, and invalidates the modules list and that module\'s cached detail on success.
|
|
72
72
|
|
|
73
73
|
### Example
|
|
74
74
|
|
|
@@ -122,7 +122,7 @@ const { status, data } = await apiInstance.addOrganizationModuleEnabledTier(
|
|
|
122
122
|
# **getOrganizationModuleEditableTiers**
|
|
123
123
|
> GetAccountTiers200Response getOrganizationModuleEditableTiers()
|
|
124
124
|
|
|
125
|
-
|
|
125
|
+
Returns the account tiers that are allowed to edit content for the specified organization module type; requires org read permission.
|
|
126
126
|
|
|
127
127
|
### Example
|
|
128
128
|
|
|
@@ -185,7 +185,7 @@ const { status, data } = await apiInstance.getOrganizationModuleEditableTiers(
|
|
|
185
185
|
# **getOrganizationModuleEnabledTiers**
|
|
186
186
|
> GetAccountTiers200Response getOrganizationModuleEnabledTiers()
|
|
187
187
|
|
|
188
|
-
|
|
188
|
+
Returns the account tiers for which the specified organization module type is enabled; requires org read permission.
|
|
189
189
|
|
|
190
190
|
### Example
|
|
191
191
|
|
|
@@ -248,7 +248,7 @@ const { status, data } = await apiInstance.getOrganizationModuleEnabledTiers(
|
|
|
248
248
|
# **removeOrganizationModuleEditableTier**
|
|
249
249
|
> GetOrganizationModule200Response removeOrganizationModuleEditableTier()
|
|
250
250
|
|
|
251
|
-
|
|
251
|
+
Revokes the specified account tier\'s permission to edit the given organization module type, requires the update org permission, and invalidates the modules list and that module\'s cached detail on success.
|
|
252
252
|
|
|
253
253
|
### Example
|
|
254
254
|
|
|
@@ -302,7 +302,7 @@ const { status, data } = await apiInstance.removeOrganizationModuleEditableTier(
|
|
|
302
302
|
# **removeOrganizationModuleEnabledTier**
|
|
303
303
|
> GetOrganizationModule200Response removeOrganizationModuleEnabledTier()
|
|
304
304
|
|
|
305
|
-
|
|
305
|
+
Revokes the specified account tier\'s access to use the given organization module type, requires the update org permission, and invalidates the modules list and that module\'s cached detail on success.
|
|
306
306
|
|
|
307
307
|
### Example
|
|
308
308
|
|