@snokam/platform-client 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (200) hide show
  1. package/.openapi-generator-ignore +23 -0
  2. package/README.md +423 -0
  3. package/dist/apis/PlatformClient.d.ts +2194 -0
  4. package/dist/apis/PlatformClient.js +5902 -0
  5. package/dist/apis/index.d.ts +1 -0
  6. package/dist/apis/index.js +19 -0
  7. package/dist/esm/apis/PlatformClient.d.ts +2194 -0
  8. package/dist/esm/apis/PlatformClient.js +5898 -0
  9. package/dist/esm/apis/index.d.ts +1 -0
  10. package/dist/esm/apis/index.js +3 -0
  11. package/dist/esm/index.d.ts +3 -0
  12. package/dist/esm/index.js +5 -0
  13. package/dist/esm/models/index.d.ts +6691 -0
  14. package/dist/esm/models/index.js +336 -0
  15. package/dist/esm/runtime.d.ts +181 -0
  16. package/dist/esm/runtime.js +342 -0
  17. package/dist/index.d.ts +3 -0
  18. package/dist/index.js +21 -0
  19. package/dist/models/index.d.ts +6691 -0
  20. package/dist/models/index.js +339 -0
  21. package/dist/runtime.d.ts +181 -0
  22. package/dist/runtime.js +357 -0
  23. package/docs/AccessSubject.md +17 -0
  24. package/docs/ActivateRequest.md +15 -0
  25. package/docs/ActivateResult.md +16 -0
  26. package/docs/AddCustomDomainRequest.md +16 -0
  27. package/docs/ApiTokenSummary.md +20 -0
  28. package/docs/ApiTokenVerifyResult.md +16 -0
  29. package/docs/AppCatalogEntry.md +18 -0
  30. package/docs/AppModule.md +20 -0
  31. package/docs/ApproveDeviceRequest.md +15 -0
  32. package/docs/BillingPaymentMethod.md +16 -0
  33. package/docs/BillingSessionRequest.md +14 -0
  34. package/docs/BillingSessionResponse.md +14 -0
  35. package/docs/BridgeWebhookResult.md +18 -0
  36. package/docs/Business.md +65 -0
  37. package/docs/BusinessAccess.md +15 -0
  38. package/docs/BusinessConfig.md +18 -0
  39. package/docs/BusinessHealth.md +17 -0
  40. package/docs/BusinessMeterUsage.md +18 -0
  41. package/docs/BusinessOwner.md +16 -0
  42. package/docs/BusinessUsageRollup.md +23 -0
  43. package/docs/Capability.md +17 -0
  44. package/docs/CommissionTierReference.md +16 -0
  45. package/docs/ComponentBlocksInnerOneOfChildrenInner.md +17 -0
  46. package/docs/ComponentBlocksInnerOneOfMarkDefsInner.md +16 -0
  47. package/docs/CreateApiTokenRequest.md +15 -0
  48. package/docs/CreateUserRequest.md +20 -0
  49. package/docs/CreatedApiToken.md +21 -0
  50. package/docs/CredentialSummary.md +21 -0
  51. package/docs/CustomDomain.md +18 -0
  52. package/docs/CustomDomainProvisioning.md +15 -0
  53. package/docs/DevicePairRequestBody.md +14 -0
  54. package/docs/DevicePairing.md +17 -0
  55. package/docs/DevicePairingStatus.md +17 -0
  56. package/docs/DevicePollRequestBody.md +15 -0
  57. package/docs/DeviceScreen.md +20 -0
  58. package/docs/DirectoryAppRoleItem.md +15 -0
  59. package/docs/DirectoryGroupItem.md +15 -0
  60. package/docs/DirectoryGroupsResponse.md +14 -0
  61. package/docs/DirectoryLicenseItem.md +16 -0
  62. package/docs/DirectoryLicensesResponse.md +14 -0
  63. package/docs/DirectoryMailbox.md +15 -0
  64. package/docs/DirectoryServicePrincipalItem.md +16 -0
  65. package/docs/DirectoryServicePrincipalsResponse.md +14 -0
  66. package/docs/DnsRecord.md +16 -0
  67. package/docs/EmployeeReference.md +16 -0
  68. package/docs/EmployeeSettings.md +14 -0
  69. package/docs/EmployeeSystemAccess.md +24 -0
  70. package/docs/EmployeeSystemConfig.md +18 -0
  71. package/docs/Entitlements.md +23 -0
  72. package/docs/FacebookAccount.md +17 -0
  73. package/docs/GitHubRepo.md +18 -0
  74. package/docs/GoogleAnalyticsProperty.md +16 -0
  75. package/docs/GoogleAnalyticsSelection.md +14 -0
  76. package/docs/ImpersonationHistoryEntry.md +25 -0
  77. package/docs/IntegrationCheckResult.md +18 -0
  78. package/docs/IntegrationHealthStatus.md +16 -0
  79. package/docs/IntegrationSecret.md +16 -0
  80. package/docs/IntegrationSetting.md +17 -0
  81. package/docs/IntegrationSummary.md +29 -0
  82. package/docs/InviteCredentialRequest.md +15 -0
  83. package/docs/InvoiceBasis.md +20 -0
  84. package/docs/InvoiceBasisLine.md +18 -0
  85. package/docs/LoginConfig.md +21 -0
  86. package/docs/MeApp.md +15 -0
  87. package/docs/MeterEnforcementDecision.md +19 -0
  88. package/docs/MeterEntitlement.md +22 -0
  89. package/docs/ModelReconciliation.md +24 -0
  90. package/docs/OAuthAccessTokenResponse.md +16 -0
  91. package/docs/OAuthStartResponse.md +14 -0
  92. package/docs/OlafApiKeyResponse.md +14 -0
  93. package/docs/OlafTeamsSettings.md +14 -0
  94. package/docs/OnboardBusinessRequest.md +27 -0
  95. package/docs/OnboardingConfig.md +18 -0
  96. package/docs/OnboardingStatus.md +19 -0
  97. package/docs/OnboardingStep.md +15 -0
  98. package/docs/PageEmployeeOrderInner.md +17 -0
  99. package/docs/PageEquipmentInner.md +17 -0
  100. package/docs/PasswordLoginRequest.md +17 -0
  101. package/docs/PasswordLoginResult.md +20 -0
  102. package/docs/PatchBusinessRequest.md +26 -0
  103. package/docs/PatchEmployee.md +58 -0
  104. package/docs/PendingDevicePreview.md +17 -0
  105. package/docs/PickSanityPatchEmployeeExcludeKeyofSanityPatchEmployeeScopeGrantsSalaryConfig.md +14 -0
  106. package/docs/PickSanityPatchEmployeeExcludeKeyofSanityPatchEmployeeScopeGrantsSettings.md +14 -0
  107. package/docs/PlanFeature.md +16 -0
  108. package/docs/PlanInfo.md +21 -0
  109. package/docs/PlanMeter.md +24 -0
  110. package/docs/PlatformClient.md +9321 -0
  111. package/docs/PlatformIntegration.md +21 -0
  112. package/docs/PlatformSanityConfig.md +17 -0
  113. package/docs/PlatformSecretField.md +16 -0
  114. package/docs/PlatformSecretStatus.md +16 -0
  115. package/docs/PowerOfficeConnectResponse.md +14 -0
  116. package/docs/PowerOfficeProduct.md +15 -0
  117. package/docs/PowerOfficeProductsResponse.md +15 -0
  118. package/docs/PowerOfficeProject.md +15 -0
  119. package/docs/PowerOfficeProjectsResponse.md +15 -0
  120. package/docs/ProtectedEmployee.md +63 -0
  121. package/docs/ProvisioningEvent.md +17 -0
  122. package/docs/RecordImpersonationActivityRequest.md +18 -0
  123. package/docs/RenameDeviceRequest.md +14 -0
  124. package/docs/ResetConfirmRequest.md +16 -0
  125. package/docs/ResetRequest.md +15 -0
  126. package/docs/RevokeRequest.md +14 -0
  127. package/docs/RollupMeterTotal.md +18 -0
  128. package/docs/SanityCreateEmployeeCliftonStrengthsInner.md +17 -0
  129. package/docs/SanityCreateEmployeeGroupsInner.md +17 -0
  130. package/docs/SanityCreateEmployeeTagsInner.md +17 -0
  131. package/docs/SanityCreateEmployeeTechnologiesInner.md +17 -0
  132. package/docs/SanityEmployeeCliftonStrengthsInner.md +20 -0
  133. package/docs/SanityEmployeeCommissionTier.md +20 -0
  134. package/docs/SanityEmployeeEquipmentInner.md +19 -0
  135. package/docs/SanityEmployeeGroupsInner.md +24 -0
  136. package/docs/SanityEmployeeManager.md +23 -0
  137. package/docs/SanityEmployeeNextOfKinInner.md +17 -0
  138. package/docs/SanityEmployeeSalaryConfig.md +14 -0
  139. package/docs/SanityEmployeeSettings.md +14 -0
  140. package/docs/SanityImageAssetReference.md +16 -0
  141. package/docs/SanityImageCrop.md +18 -0
  142. package/docs/SanityImageHotspot.md +18 -0
  143. package/docs/SanityPatchPageMetaImage.md +18 -0
  144. package/docs/SanitySystemsInnerDescriptionInner.md +20 -0
  145. package/docs/SanityTechnologyWithRelationsArticlesInnerMediaOneOf.md +15 -0
  146. package/docs/SanityTechnologyWithRelationsEmployeesInnerTagsInner.md +17 -0
  147. package/docs/SanityTechnologyWithRelationsProjectsInnerTechnologiesInner.md +18 -0
  148. package/docs/SanityTvCategoryDashboardsInnerBackgroundImage.md +15 -0
  149. package/docs/SanityTvCategoryDashboardsInnerBackgroundImageAsset.md +18 -0
  150. package/docs/ScopeDefinition.md +17 -0
  151. package/docs/SessionBootstrapRequest.md +14 -0
  152. package/docs/SetActiveProviderRequest.md +15 -0
  153. package/docs/SetFacebookAccountRequest.md +17 -0
  154. package/docs/SetGoogleAnalyticsPropertyRequest.md +14 -0
  155. package/docs/SetPlatformSecretRequest.md +14 -0
  156. package/docs/SetScopeGrantsRequest.md +14 -0
  157. package/docs/SetWorkReposRequest.md +14 -0
  158. package/docs/SetWorkspaceRepoRequest.md +14 -0
  159. package/docs/SignupConfig.md +14 -0
  160. package/docs/SignupRequest.md +25 -0
  161. package/docs/SignupResult.md +15 -0
  162. package/docs/Slug.md +16 -0
  163. package/docs/SsoExchangeRequest.md +14 -0
  164. package/docs/StartImpersonationRequest.md +16 -0
  165. package/docs/StartImpersonationResult.md +20 -0
  166. package/docs/StudioSanityConfig.md +16 -0
  167. package/docs/SystemRoleOption.md +15 -0
  168. package/docs/TeamsAcsTokenResponse.md +16 -0
  169. package/docs/TeamsAuthStateResponse.md +14 -0
  170. package/docs/TenantDomain.md +17 -0
  171. package/docs/TenantInfo.md +32 -0
  172. package/docs/TenantSanityCredentials.md +16 -0
  173. package/docs/TokenExchangeRequest.md +14 -0
  174. package/docs/TokenExchangeResult.md +15 -0
  175. package/docs/TokenReconciliationReport.md +16 -0
  176. package/docs/TokenReconciliationSnapshot.md +27 -0
  177. package/docs/TotpEnrollRequest.md +15 -0
  178. package/docs/TotpEnrollResult.md +16 -0
  179. package/docs/UpdateAppsRequest.md +14 -0
  180. package/docs/UpdateSecretsRequest.md +14 -0
  181. package/docs/UsageDailySeries.md +16 -0
  182. package/docs/UsageDayPoint.md +15 -0
  183. package/docs/UsageEvent.md +18 -0
  184. package/docs/UsageEventsRequest.md +15 -0
  185. package/docs/UsageMeterDailySeries.md +17 -0
  186. package/docs/UsageMeterSummary.md +31 -0
  187. package/docs/UsageRollup.md +16 -0
  188. package/docs/UsageRollupTotals.md +18 -0
  189. package/docs/UsageSummary.md +23 -0
  190. package/docs/VerifyApiTokenRequest.md +14 -0
  191. package/docs/WorkReposSelection.md +14 -0
  192. package/docs/WorkspaceRepoSelection.md +14 -0
  193. package/package.json +20 -0
  194. package/src/apis/PlatformClient.ts +7514 -0
  195. package/src/apis/index.ts +3 -0
  196. package/src/index.ts +5 -0
  197. package/src/models/index.ts +6789 -0
  198. package/src/runtime.ts +442 -0
  199. package/tsconfig.esm.json +7 -0
  200. package/tsconfig.json +16 -0
@@ -0,0 +1,23 @@
1
+ # OpenAPI Generator Ignore
2
+ # Generated by openapi-generator https://github.com/openapitools/openapi-generator
3
+
4
+ # Use this file to prevent files from being overwritten by the generator.
5
+ # The patterns follow closely to .gitignore or .dockerignore.
6
+
7
+ # As an example, the C# client generator defines ApiClient.cs.
8
+ # You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
9
+ #ApiClient.cs
10
+
11
+ # You can match any string of characters against a directory, file or extension with a single asterisk (*):
12
+ #foo/*/qux
13
+ # The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
14
+
15
+ # You can recursively match patterns against a directory, file or extension with a double asterisk (**):
16
+ #foo/**/qux
17
+ # This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
18
+
19
+ # You can also negate patterns with an exclamation (!).
20
+ # For example, you can ignore all files in a docs folder with the file extension .md:
21
+ #docs/*.md
22
+ # Then explicitly reverse the ignore rule for a single file:
23
+ #!docs/README.md
package/README.md ADDED
@@ -0,0 +1,423 @@
1
+ # @snokam/platform-client@1.0.0
2
+
3
+ A TypeScript SDK client for the snokam.snosky.no API.
4
+
5
+ ## Usage
6
+
7
+ First, install the SDK from npm.
8
+
9
+ ```bash
10
+ npm install @snokam/platform-client --save
11
+ ```
12
+
13
+ Next, try it out.
14
+
15
+
16
+ ```ts
17
+ import {
18
+ Configuration,
19
+ PlatformClient,
20
+ } from '@snokam/platform-client';
21
+ import type { AddCustomDomainOperationRequest } from '@snokam/platform-client';
22
+
23
+ async function example() {
24
+ console.log("🚀 Testing @snokam/platform-client SDK...");
25
+ const config = new Configuration({
26
+ // To configure OAuth2 access token for authorization: Implicit implicit
27
+ accessToken: "YOUR ACCESS TOKEN",
28
+ });
29
+ const api = new PlatformClient(config);
30
+
31
+ const body = {
32
+ // string | The ID of the business
33
+ id: id_example,
34
+ // AddCustomDomainRequest | Domain to add
35
+ addCustomDomainRequest: ...,
36
+ } satisfies AddCustomDomainOperationRequest;
37
+
38
+ try {
39
+ const data = await api.addCustomDomain(body);
40
+ console.log(data);
41
+ } catch (error) {
42
+ console.error(error);
43
+ }
44
+ }
45
+
46
+ // Run the test
47
+ example().catch(console.error);
48
+ ```
49
+
50
+
51
+ ## Documentation
52
+
53
+ ### API Endpoints
54
+
55
+ All URIs are relative to *https://snokam.snosky.no/api/platform*
56
+
57
+ | Class | Method | HTTP request | Description
58
+ | ----- | ------ | ------------ | -------------
59
+ *PlatformClient* | [**addCustomDomain**](docs/PlatformClient.md#addcustomdomainoperation) | **POST** /v1.0/protected/businesses/{id}/custom-domains | Add a custom domain
60
+ *PlatformClient* | [**approveDevice**](docs/PlatformClient.md#approvedeviceoperation) | **POST** /v1.0/protected/businesses/{id}/devices | Approve a screen into this business
61
+ *PlatformClient* | [**assignBusinessEmployeeSystem**](docs/PlatformClient.md#assignbusinessemployeesystem) | **POST** /v1.0/protected/businesses/{id}/employees/{upn}/systems/{systemKey} | Grant an employee a seat in a third-party system
62
+ *PlatformClient* | [**backfillBridgeWebhook**](docs/PlatformClient.md#backfillbridgewebhook) | **POST** /v1.0/protected/businesses/{id}/bridge-webhook | Re-create a business\'s Sanity bridge webhook with a managed API key
63
+ *PlatformClient* | [**checkIntegration**](docs/PlatformClient.md#checkintegration) | **POST** /v1.0/protected/businesses/{id}/integrations/{key}/check | Run a live integration connectivity check
64
+ *PlatformClient* | [**checkPlatformIntegration**](docs/PlatformClient.md#checkplatformintegration) | **POST** /v1.0/protected/platform/integrations/{key}/check | Live-probe a platform integration
65
+ *PlatformClient* | [**connectTenant**](docs/PlatformClient.md#connecttenant) | **POST** /v1.0/protected/businesses/{id}/connect | Connect the caller\'s tenant to a business
66
+ *PlatformClient* | [**createApiToken**](docs/PlatformClient.md#createapitokenoperation) | **POST** /v1.0/protected/businesses/{id}/tokens | Create an API token
67
+ *PlatformClient* | [**createBillingCheckout**](docs/PlatformClient.md#createbillingcheckout) | **POST** /v1.0/protected/businesses/{id}/billing/checkout | Start a subscription checkout
68
+ *PlatformClient* | [**createBillingPortal**](docs/PlatformClient.md#createbillingportal) | **POST** /v1.0/protected/businesses/{id}/billing/portal | Open the Stripe billing portal
69
+ *PlatformClient* | [**createBusiness**](docs/PlatformClient.md#createbusiness) | **POST** /v1.0/protected/businesses | Onboard a business
70
+ *PlatformClient* | [**createUser**](docs/PlatformClient.md#createuseroperation) | **POST** /v1.0/protected/businesses/{id}/users | Add a teammate to the tenant
71
+ *PlatformClient* | [**deleteBusiness**](docs/PlatformClient.md#deletebusiness) | **DELETE** /v1.0/protected/businesses/{id} | Delete a business
72
+ *PlatformClient* | [**deleteCustomDomain**](docs/PlatformClient.md#deletecustomdomain) | **DELETE** /v1.0/protected/businesses/{id}/custom-domains/{host} | Remove a custom domain
73
+ *PlatformClient* | [**devicePairPoll**](docs/PlatformClient.md#devicepairpoll) | **POST** /v1.0/public/devices/poll | Ask whether the code was approved
74
+ *PlatformClient* | [**devicePairRequest**](docs/PlatformClient.md#devicepairrequest) | **POST** /v1.0/public/devices/pair | Ask for a pairing code
75
+ *PlatformClient* | [**disableCredential**](docs/PlatformClient.md#disablecredential) | **DELETE** /v1.0/protected/businesses/{id}/credentials/{credentialId} | Disable a password credential
76
+ *PlatformClient* | [**endImpersonation**](docs/PlatformClient.md#endimpersonation) | **POST** /v1.0/protected/impersonate/{tokenId}/end | End a view-as-employee session
77
+ *PlatformClient* | [**exportBusinessData**](docs/PlatformClient.md#exportbusinessdata) | **POST** /v1.0/protected/businesses/{id}/export | Export a business\'s data (GDPR)
78
+ *PlatformClient* | [**getApiScopes**](docs/PlatformClient.md#getapiscopes) | **GET** /v1.0/protected/scopes | List grantable API scopes
79
+ *PlatformClient* | [**getBillingPaymentMethod**](docs/PlatformClient.md#getbillingpaymentmethod) | **GET** /v1.0/protected/businesses/{id}/billing/payment-method | Payment method on file
80
+ *PlatformClient* | [**getBusiness**](docs/PlatformClient.md#getbusiness) | **GET** /v1.0/protected/businesses/{id} | Get a business
81
+ *PlatformClient* | [**getBusinessAccess**](docs/PlatformClient.md#getbusinessaccess) | **GET** /v1.0/protected/businesses/{id}/access | List a business\'s scope-grant assignments
82
+ *PlatformClient* | [**getBusinessEmployeeSystemsConfig**](docs/PlatformClient.md#getbusinessemployeesystemsconfig) | **GET** /v1.0/protected/businesses/{id}/employees/systems-config | List the tenant\'s system registry with configuration
83
+ *PlatformClient* | [**getBusinesses**](docs/PlatformClient.md#getbusinesses) | **GET** /v1.0/protected/businesses | List all businesses
84
+ *PlatformClient* | [**getCustomDomains**](docs/PlatformClient.md#getcustomdomains) | **GET** /v1.0/protected/businesses/{id}/custom-domains | List custom domains
85
+ *PlatformClient* | [**getDirectoryGroups**](docs/PlatformClient.md#getdirectorygroups) | **GET** /v1.0/protected/businesses/{id}/directory/groups | List Entra groups for a business
86
+ *PlatformClient* | [**getDirectoryLicenses**](docs/PlatformClient.md#getdirectorylicenses) | **GET** /v1.0/protected/businesses/{id}/directory/licenses | List Microsoft 365 licenses for a business
87
+ *PlatformClient* | [**getDirectoryServicePrincipals**](docs/PlatformClient.md#getdirectoryserviceprincipals) | **GET** /v1.0/protected/businesses/{id}/directory/service-principals | List enterprise apps with assignable app roles
88
+ *PlatformClient* | [**getFacebookSelectedAccount**](docs/PlatformClient.md#getfacebookselectedaccount) | **GET** /v1.0/protected/businesses/{id}/oauth/facebook/account | Get the selected Facebook/Instagram posting account
89
+ *PlatformClient* | [**getFleetHealth**](docs/PlatformClient.md#getfleethealth) | **GET** /v1.0/protected/fleet/health | Get fleet-wide tenant health
90
+ *PlatformClient* | [**getGoogleAnalyticsSelectedProperty**](docs/PlatformClient.md#getgoogleanalyticsselectedproperty) | **GET** /v1.0/protected/platform/oauth/google/property | Get the selected Google Analytics property
91
+ *PlatformClient* | [**getImpersonationHistory**](docs/PlatformClient.md#getimpersonationhistory) | **GET** /v1.0/protected/impersonate/history | Operator review of the impersonation audit log
92
+ *PlatformClient* | [**getMeApps**](docs/PlatformClient.md#getmeapps) | **GET** /v1.0/protected/me/apps | List apps for the signed-in employee
93
+ *PlatformClient* | [**getMeSettings**](docs/PlatformClient.md#getmesettings) | **GET** /v1.0/protected/me/settings | Read the signed-in employee\'s settings
94
+ *PlatformClient* | [**getModules**](docs/PlatformClient.md#getmodules) | **GET** /v1.0/protected/modules | List available modules
95
+ *PlatformClient* | [**getMyBusinesses**](docs/PlatformClient.md#getmybusinesses) | **GET** /v1.0/protected/my/businesses | List my businesses
96
+ *PlatformClient* | [**getOAuthAccessToken**](docs/PlatformClient.md#getoauthaccesstoken) | **GET** /v1.0/protected/businesses/{id}/oauth/{provider}/access-token | Mint a fresh OAuth access token
97
+ *PlatformClient* | [**getOlafApiKey**](docs/PlatformClient.md#getolafapikey) | **GET** /v1.0/protected/businesses/{id}/tokens/olaf | The business\'s Olaf API key
98
+ *PlatformClient* | [**getOlafTeamsSettings**](docs/PlatformClient.md#getolafteamssettings) | **GET** /v1.0/protected/businesses/{id}/olaf/teams-settings | Get the business\'s Olaf meeting-assistant settings
99
+ *PlatformClient* | [**getOnboardingConfig**](docs/PlatformClient.md#getonboardingconfig) | **GET** /v1.0/protected/businesses/{id}/onboarding/config | Get the saved onboarding directory selections for a business
100
+ *PlatformClient* | [**getOnboardingStatus**](docs/PlatformClient.md#getonboardingstatus) | **GET** /v1.0/protected/businesses/{id}/onboarding | Get the onboarding checklist for a business
101
+ *PlatformClient* | [**getPlatformIntegrations**](docs/PlatformClient.md#getplatformintegrations) | **GET** /v1.0/protected/platform/integrations | List platform-shared integrations
102
+ *PlatformClient* | [**getPlatformOAuthAccessToken**](docs/PlatformClient.md#getplatformoauthaccesstoken) | **GET** /v1.0/protected/platform/oauth/{provider}/access-token | Mint a fresh platform OAuth access token
103
+ *PlatformClient* | [**getPlatformSecrets**](docs/PlatformClient.md#getplatformsecrets) | **GET** /v1.0/protected/platform/secrets | List shared platform secrets
104
+ *PlatformClient* | [**getProvisioningStatus**](docs/PlatformClient.md#getprovisioningstatus) | **GET** /v1.0/protected/businesses/{id}/status | Get provisioning status
105
+ *PlatformClient* | [**getTeamsAuthState**](docs/PlatformClient.md#getteamsauthstate) | **GET** /v1.0/protected/businesses/{id}/teams/auth-state | Read the business\'s stored Teams authenticated join session
106
+ *PlatformClient* | [**getTeamsUserAcsToken**](docs/PlatformClient.md#getteamsuseracstoken) | **GET** /v1.0/protected/businesses/{id}/teams/acs-token | Mint an ACS access token for the connected M365 user as a Teams user
107
+ *PlatformClient* | [**getTokenReconciliation**](docs/PlatformClient.md#gettokenreconciliation) | **GET** /v1.0/protected/usage/reconciliation | Reconcile registered AI tokens against Azure\'s reported tokens
108
+ *PlatformClient* | [**getUsageDaily**](docs/PlatformClient.md#getusagedaily) | **GET** /v1.0/protected/usage/{businessId}/daily | Get a month\'s usage as a daily series
109
+ *PlatformClient* | [**getUsageMeterDecision**](docs/PlatformClient.md#getusagemeterdecision) | **GET** /v1.0/protected/usage/{businessId}/meters/{meter}/decision | Request-time enforcement decision for one meter
110
+ *PlatformClient* | [**getUsageRollup**](docs/PlatformClient.md#getusagerollup) | **GET** /v1.0/protected/usage/rollup | Get a month\'s usage rollup across all businesses
111
+ *PlatformClient* | [**getUsageSummary**](docs/PlatformClient.md#getusagesummary) | **GET** /v1.0/protected/usage/{businessId}/summary | Get a month\'s usage summary
112
+ *PlatformClient* | [**getWorkRepos**](docs/PlatformClient.md#getworkrepos) | **GET** /v1.0/protected/businesses/{id}/oauth/github/work-repos | Get the repos Olaf works on
113
+ *PlatformClient* | [**getWorkspaceRepo**](docs/PlatformClient.md#getworkspacerepo) | **GET** /v1.0/protected/businesses/{id}/oauth/github/workspace-repo | Get the selected workspace repository
114
+ *PlatformClient* | [**ingestUsageEvents**](docs/PlatformClient.md#ingestusageevents) | **POST** /v1.0/protected/usage/events | Ingest usage events
115
+ *PlatformClient* | [**inviteCredential**](docs/PlatformClient.md#invitecredentialoperation) | **POST** /v1.0/protected/businesses/{id}/credentials/invite | Invite a user to password login
116
+ *PlatformClient* | [**listAccountingProducts**](docs/PlatformClient.md#listaccountingproducts) | **GET** /v1.0/protected/businesses/{id}/accounting/products | List accounting products
117
+ *PlatformClient* | [**listAccountingProjects**](docs/PlatformClient.md#listaccountingprojects) | **GET** /v1.0/protected/businesses/{id}/accounting/projects | List accounting projects
118
+ *PlatformClient* | [**listApiTokens**](docs/PlatformClient.md#listapitokens) | **GET** /v1.0/protected/businesses/{id}/tokens | List API tokens
119
+ *PlatformClient* | [**listApps**](docs/PlatformClient.md#listapps) | **GET** /v1.0/public/apps | List the product app catalog
120
+ *PlatformClient* | [**listBusinessEmployeeSystems**](docs/PlatformClient.md#listbusinessemployeesystems) | **GET** /v1.0/protected/businesses/{id}/employees/{upn}/systems | List an employee\'s third-party system access
121
+ *PlatformClient* | [**listBusinessEmployees**](docs/PlatformClient.md#listbusinessemployees) | **GET** /v1.0/protected/businesses/{id}/employees | List a business\'s employees
122
+ *PlatformClient* | [**listCredentials**](docs/PlatformClient.md#listcredentials) | **GET** /v1.0/protected/businesses/{id}/credentials | List password credentials
123
+ *PlatformClient* | [**listDevices**](docs/PlatformClient.md#listdevices) | **GET** /v1.0/protected/businesses/{id}/devices | Screens paired to this business
124
+ *PlatformClient* | [**listFacebookAccounts**](docs/PlatformClient.md#listfacebookaccounts) | **GET** /v1.0/protected/businesses/{id}/oauth/facebook/accounts | List connectable Facebook Pages and Instagram accounts
125
+ *PlatformClient* | [**listGitHubRepos**](docs/PlatformClient.md#listgithubrepos) | **GET** /v1.0/protected/businesses/{id}/oauth/github/repos | List the business\'s GitHub repositories
126
+ *PlatformClient* | [**listGoogleAnalyticsProperties**](docs/PlatformClient.md#listgoogleanalyticsproperties) | **GET** /v1.0/protected/platform/oauth/google/properties | List connectable Google Analytics properties
127
+ *PlatformClient* | [**listIntegrations**](docs/PlatformClient.md#listintegrations) | **GET** /v1.0/protected/businesses/{id}/integrations | List integrations and config status
128
+ *PlatformClient* | [**listMailboxes**](docs/PlatformClient.md#listmailboxes) | **GET** /v1.0/protected/businesses/{id}/mailboxes | List the business\'s mailboxes
129
+ *PlatformClient* | [**oAuthCallback**](docs/PlatformClient.md#oauthcallback) | **GET** /v1.0/oauth/{provider}/callback | OAuth provider redirect callback
130
+ *PlatformClient* | [**passwordActivate**](docs/PlatformClient.md#passwordactivate) | **POST** /v1.0/public/auth/password/activate | Activate an invited credential
131
+ *PlatformClient* | [**passwordAuthJwks**](docs/PlatformClient.md#passwordauthjwks) | **GET** /v1.0/public/auth/.well-known/jwks.json | JWKS for the platform issuer
132
+ *PlatformClient* | [**passwordAuthLoginConfig**](docs/PlatformClient.md#passwordauthloginconfig) | **GET** /v1.0/public/auth/login-config | Login methods for a tenant host
133
+ *PlatformClient* | [**passwordAuthOpenIdConfiguration**](docs/PlatformClient.md#passwordauthopenidconfiguration) | **GET** /v1.0/public/auth/.well-known/openid-configuration | OIDC discovery for the platform issuer
134
+ *PlatformClient* | [**passwordAuthSignupConfig**](docs/PlatformClient.md#passwordauthsignupconfig) | **GET** /v1.0/public/auth/signup-config | Whether password-first signup is enabled
135
+ *PlatformClient* | [**passwordEnrollTotp**](docs/PlatformClient.md#passwordenrolltotp) | **POST** /v1.0/public/auth/password/totp/enroll | Confirm TOTP enrolment
136
+ *PlatformClient* | [**passwordLogin**](docs/PlatformClient.md#passwordloginoperation) | **POST** /v1.0/public/auth/password/login | Log in with email, password and TOTP code
137
+ *PlatformClient* | [**passwordResetConfirm**](docs/PlatformClient.md#passwordresetconfirm) | **POST** /v1.0/public/auth/password/reset/confirm | Set a new password with a reset token
138
+ *PlatformClient* | [**passwordResetRequest**](docs/PlatformClient.md#passwordresetrequest) | **POST** /v1.0/public/auth/password/reset/request | Request a password-reset e-mail
139
+ *PlatformClient* | [**passwordSessionBootstrap**](docs/PlatformClient.md#passwordsessionbootstrap) | **POST** /v1.0/public/auth/password/session | Redeem an enrolment bootstrap token
140
+ *PlatformClient* | [**passwordTokenExchange**](docs/PlatformClient.md#passwordtokenexchange) | **POST** /v1.0/public/auth/password/token | Exchange a refresh token for an access token
141
+ *PlatformClient* | [**passwordTokenRevoke**](docs/PlatformClient.md#passwordtokenrevoke) | **POST** /v1.0/public/auth/password/revoke | Revoke a refresh token
142
+ *PlatformClient* | [**patchBusiness**](docs/PlatformClient.md#patchbusinessoperation) | **PATCH** /v1.0/protected/businesses/{id} | Update a business
143
+ *PlatformClient* | [**patchBusinessEmployee**](docs/PlatformClient.md#patchbusinessemployee) | **PATCH** /v1.0/protected/businesses/{id}/employees/{employeeId} | Update an employee\'s status or group membership
144
+ *PlatformClient* | [**powerOfficeOnboardingCallback**](docs/PlatformClient.md#powerofficeonboardingcallback) | **POST** /v1.0/connect/poweroffice/callback/{reference} | PowerOffice onboarding callback
145
+ *PlatformClient* | [**powerOfficeOnboardingReturn**](docs/PlatformClient.md#powerofficeonboardingreturn) | **GET** /v1.0/connect/poweroffice/return/{reference} | PowerOffice onboarding return
146
+ *PlatformClient* | [**previewBillingInvoice**](docs/PlatformClient.md#previewbillinginvoice) | **POST** /v1.0/protected/businesses/{id}/billing/invoice-preview | Preview a month\'s invoice basis
147
+ *PlatformClient* | [**previewDevice**](docs/PlatformClient.md#previewdevice) | **GET** /v1.0/protected/businesses/{id}/devices/preview | Look up a pairing code before approving
148
+ *PlatformClient* | [**provisionBusiness**](docs/PlatformClient.md#provisionbusiness) | **POST** /v1.0/protected/businesses/{id}/provision | Provision a business
149
+ *PlatformClient* | [**publicCapabilities**](docs/PlatformClient.md#publiccapabilities) | **GET** /v1.0/public/capabilities | Get capabilities
150
+ *PlatformClient* | [**publicModules**](docs/PlatformClient.md#publicmodules) | **GET** /v1.0/public/modules | Get available modules
151
+ *PlatformClient* | [**publicPlans**](docs/PlatformClient.md#publicplans) | **GET** /v1.0/public/plans | Get available plans
152
+ *PlatformClient* | [**publicSignup**](docs/PlatformClient.md#publicsignup) | **POST** /v1.0/public/signup | Submit business signup
153
+ *PlatformClient* | [**recordImpersonationActivity**](docs/PlatformClient.md#recordimpersonationactivityoperation) | **POST** /v1.0/protected/impersonate/activity | Record one action performed in a view-as-employee session
154
+ *PlatformClient* | [**renameDevice**](docs/PlatformClient.md#renamedeviceoperation) | **PATCH** /v1.0/protected/businesses/{id}/devices/{deviceId} | Rename a screen
155
+ *PlatformClient* | [**requestUpgrade**](docs/PlatformClient.md#requestupgrade) | **POST** /v1.0/protected/businesses/{id}/request-upgrade | Request an Enterprise upgrade
156
+ *PlatformClient* | [**resetCredential**](docs/PlatformClient.md#resetcredential) | **POST** /v1.0/protected/businesses/{id}/credentials/{credentialId}/reset | Admin-initiated password reset
157
+ *PlatformClient* | [**resolvePlatformSanityConfig**](docs/PlatformClient.md#resolveplatformsanityconfig) | **GET** /v1.0/protected/sanity/platform | Resolve the platform Sanity read config
158
+ *PlatformClient* | [**resolveStudioSanityConfig**](docs/PlatformClient.md#resolvestudiosanityconfig) | **GET** /v1.0/public/sanity-config | Resolve the Sanity Studio project/dataset for a host
159
+ *PlatformClient* | [**resolveTenant**](docs/PlatformClient.md#resolvetenant) | **GET** /v1.0/protected/tenant | Resolve a tenant
160
+ *PlatformClient* | [**resolveTenantSanityCredentials**](docs/PlatformClient.md#resolvetenantsanitycredentials) | **GET** /v1.0/protected/businesses/by-host/{host}/sanity | Resolve a tenant\'s Sanity read credentials by host
161
+ *PlatformClient* | [**revokeApiToken**](docs/PlatformClient.md#revokeapitoken) | **DELETE** /v1.0/protected/businesses/{id}/tokens/{fingerprint} | Revoke an API token
162
+ *PlatformClient* | [**revokeBusinessEmployeeSystem**](docs/PlatformClient.md#revokebusinessemployeesystem) | **DELETE** /v1.0/protected/businesses/{id}/employees/{upn}/systems/{systemKey} | Revoke an employee\'s seat in a third-party system
163
+ *PlatformClient* | [**revokeDevice**](docs/PlatformClient.md#revokedevice) | **DELETE** /v1.0/protected/businesses/{id}/devices/{deviceId} | Revoke a screen
164
+ *PlatformClient* | [**setAccountingGadgetsProject**](docs/PlatformClient.md#setaccountinggadgetsproject) | **POST** /v1.0/protected/businesses/{id}/accounting/gadgets-project | Set the gadgets project code
165
+ *PlatformClient* | [**setAccountingReinvoiceProduct**](docs/PlatformClient.md#setaccountingreinvoiceproduct) | **POST** /v1.0/protected/businesses/{id}/accounting/reinvoice-product | Set the re-invoice product code
166
+ *PlatformClient* | [**setActiveProvider**](docs/PlatformClient.md#setactiveprovideroperation) | **PUT** /v1.0/protected/businesses/{id}/integrations/active | Choose the active provider for a capability
167
+ *PlatformClient* | [**setBusinessEmployeePhoto**](docs/PlatformClient.md#setbusinessemployeephoto) | **POST** /v1.0/protected/businesses/{id}/employees/{employeeId}/photo | Upload an employee\'s profile photo
168
+ *PlatformClient* | [**setEmployeeScopeGrants**](docs/PlatformClient.md#setemployeescopegrants) | **PUT** /v1.0/protected/businesses/{id}/access/employees/{employeeId} | Set the scopes granted directly to an employee
169
+ *PlatformClient* | [**setFacebookSelectedAccount**](docs/PlatformClient.md#setfacebookselectedaccount) | **PUT** /v1.0/protected/businesses/{id}/oauth/facebook/account | Set the selected Facebook/Instagram posting account
170
+ *PlatformClient* | [**setGoogleAnalyticsSelectedProperty**](docs/PlatformClient.md#setgoogleanalyticsselectedproperty) | **PUT** /v1.0/protected/platform/oauth/google/property | Set the selected Google Analytics property
171
+ *PlatformClient* | [**setGroupScopeGrants**](docs/PlatformClient.md#setgroupscopegrants) | **PUT** /v1.0/protected/businesses/{id}/access/groups/{groupId} | Set the scopes a group grants
172
+ *PlatformClient* | [**setMeSettings**](docs/PlatformClient.md#setmesettings) | **PATCH** /v1.0/protected/me/settings | Update the signed-in employee\'s settings
173
+ *PlatformClient* | [**setOlafTeamsSettings**](docs/PlatformClient.md#setolafteamssettings) | **PUT** /v1.0/protected/businesses/{id}/olaf/teams-settings | Update the business\'s Olaf meeting-assistant settings
174
+ *PlatformClient* | [**setPlatformSecret**](docs/PlatformClient.md#setplatformsecretoperation) | **PUT** /v1.0/protected/platform/secrets/{key} | Set a shared platform secret
175
+ *PlatformClient* | [**setTeamsAuthState**](docs/PlatformClient.md#setteamsauthstate) | **PUT** /v1.0/protected/businesses/{id}/teams/auth-state | Store the business\'s Teams authenticated join session
176
+ *PlatformClient* | [**setWorkRepos**](docs/PlatformClient.md#setworkreposoperation) | **PUT** /v1.0/protected/businesses/{id}/oauth/github/work-repos | Set the repos Olaf works on
177
+ *PlatformClient* | [**setWorkspaceRepo**](docs/PlatformClient.md#setworkspacerepooperation) | **PUT** /v1.0/protected/businesses/{id}/oauth/github/workspace-repo | Set the workspace repository
178
+ *PlatformClient* | [**ssoTokenExchange**](docs/PlatformClient.md#ssotokenexchange) | **POST** /v1.0/public/auth/sso/exchange | Exchange an SSO token for a platform token
179
+ *PlatformClient* | [**startImpersonation**](docs/PlatformClient.md#startimpersonationoperation) | **POST** /v1.0/protected/impersonate | Start a read-only view-as-employee session
180
+ *PlatformClient* | [**startOAuthConnect**](docs/PlatformClient.md#startoauthconnect) | **POST** /v1.0/protected/businesses/{id}/oauth/{provider}/start | Begin an OAuth connect flow
181
+ *PlatformClient* | [**startPlatformOAuthConnect**](docs/PlatformClient.md#startplatformoauthconnect) | **POST** /v1.0/protected/platform/oauth/{provider}/start | Begin a platform-level OAuth connect flow
182
+ *PlatformClient* | [**startPowerOfficeConnect**](docs/PlatformClient.md#startpowerofficeconnect) | **POST** /v1.0/protected/businesses/{id}/connect/poweroffice | Begin PowerOffice onboarding
183
+ *PlatformClient* | [**stripeWebhookReceiver**](docs/PlatformClient.md#stripewebhookreceiver) | **POST** /v1.0/public/billing/stripe-webhook | Receive Stripe webhook events
184
+ *PlatformClient* | [**updateApps**](docs/PlatformClient.md#updateappsoperation) | **PATCH** /v1.0/protected/businesses/{id}/apps | Update enabled modules/apps
185
+ *PlatformClient* | [**updateSecrets**](docs/PlatformClient.md#updatesecretsoperation) | **PATCH** /v1.0/protected/businesses/{id}/secrets | Update business secrets
186
+ *PlatformClient* | [**verifyApiToken**](docs/PlatformClient.md#verifyapitokenoperation) | **POST** /v1.0/protected/tokens/verify | Verify a customer API token
187
+ *PlatformClient* | [**viewAsBusiness**](docs/PlatformClient.md#viewasbusiness) | **POST** /v1.0/protected/businesses/{id}/view-as | Enter view-as mode for a business
188
+
189
+
190
+ ### Models
191
+
192
+ - [AccessSubject](docs/AccessSubject.md)
193
+ - [ActivateRequest](docs/ActivateRequest.md)
194
+ - [ActivateResult](docs/ActivateResult.md)
195
+ - [AddCustomDomainRequest](docs/AddCustomDomainRequest.md)
196
+ - [ApiTokenSummary](docs/ApiTokenSummary.md)
197
+ - [ApiTokenVerifyResult](docs/ApiTokenVerifyResult.md)
198
+ - [AppCatalogEntry](docs/AppCatalogEntry.md)
199
+ - [AppModule](docs/AppModule.md)
200
+ - [ApproveDeviceRequest](docs/ApproveDeviceRequest.md)
201
+ - [BillingPaymentMethod](docs/BillingPaymentMethod.md)
202
+ - [BillingSessionRequest](docs/BillingSessionRequest.md)
203
+ - [BillingSessionResponse](docs/BillingSessionResponse.md)
204
+ - [BridgeWebhookResult](docs/BridgeWebhookResult.md)
205
+ - [Business](docs/Business.md)
206
+ - [BusinessAccess](docs/BusinessAccess.md)
207
+ - [BusinessConfig](docs/BusinessConfig.md)
208
+ - [BusinessHealth](docs/BusinessHealth.md)
209
+ - [BusinessMeterUsage](docs/BusinessMeterUsage.md)
210
+ - [BusinessOwner](docs/BusinessOwner.md)
211
+ - [BusinessUsageRollup](docs/BusinessUsageRollup.md)
212
+ - [Capability](docs/Capability.md)
213
+ - [CommissionTierReference](docs/CommissionTierReference.md)
214
+ - [ComponentBlocksInnerOneOfChildrenInner](docs/ComponentBlocksInnerOneOfChildrenInner.md)
215
+ - [ComponentBlocksInnerOneOfMarkDefsInner](docs/ComponentBlocksInnerOneOfMarkDefsInner.md)
216
+ - [CreateApiTokenRequest](docs/CreateApiTokenRequest.md)
217
+ - [CreateUserRequest](docs/CreateUserRequest.md)
218
+ - [CreatedApiToken](docs/CreatedApiToken.md)
219
+ - [CredentialSummary](docs/CredentialSummary.md)
220
+ - [CustomDomain](docs/CustomDomain.md)
221
+ - [CustomDomainProvisioning](docs/CustomDomainProvisioning.md)
222
+ - [DevicePairRequestBody](docs/DevicePairRequestBody.md)
223
+ - [DevicePairing](docs/DevicePairing.md)
224
+ - [DevicePairingStatus](docs/DevicePairingStatus.md)
225
+ - [DevicePollRequestBody](docs/DevicePollRequestBody.md)
226
+ - [DeviceScreen](docs/DeviceScreen.md)
227
+ - [DirectoryAppRoleItem](docs/DirectoryAppRoleItem.md)
228
+ - [DirectoryGroupItem](docs/DirectoryGroupItem.md)
229
+ - [DirectoryGroupsResponse](docs/DirectoryGroupsResponse.md)
230
+ - [DirectoryLicenseItem](docs/DirectoryLicenseItem.md)
231
+ - [DirectoryLicensesResponse](docs/DirectoryLicensesResponse.md)
232
+ - [DirectoryMailbox](docs/DirectoryMailbox.md)
233
+ - [DirectoryServicePrincipalItem](docs/DirectoryServicePrincipalItem.md)
234
+ - [DirectoryServicePrincipalsResponse](docs/DirectoryServicePrincipalsResponse.md)
235
+ - [DnsRecord](docs/DnsRecord.md)
236
+ - [EmployeeReference](docs/EmployeeReference.md)
237
+ - [EmployeeSettings](docs/EmployeeSettings.md)
238
+ - [EmployeeSystemAccess](docs/EmployeeSystemAccess.md)
239
+ - [EmployeeSystemConfig](docs/EmployeeSystemConfig.md)
240
+ - [Entitlements](docs/Entitlements.md)
241
+ - [FacebookAccount](docs/FacebookAccount.md)
242
+ - [GitHubRepo](docs/GitHubRepo.md)
243
+ - [GoogleAnalyticsProperty](docs/GoogleAnalyticsProperty.md)
244
+ - [GoogleAnalyticsSelection](docs/GoogleAnalyticsSelection.md)
245
+ - [ImpersonationHistoryEntry](docs/ImpersonationHistoryEntry.md)
246
+ - [IntegrationCheckResult](docs/IntegrationCheckResult.md)
247
+ - [IntegrationHealthStatus](docs/IntegrationHealthStatus.md)
248
+ - [IntegrationSecret](docs/IntegrationSecret.md)
249
+ - [IntegrationSetting](docs/IntegrationSetting.md)
250
+ - [IntegrationSummary](docs/IntegrationSummary.md)
251
+ - [InviteCredentialRequest](docs/InviteCredentialRequest.md)
252
+ - [InvoiceBasis](docs/InvoiceBasis.md)
253
+ - [InvoiceBasisLine](docs/InvoiceBasisLine.md)
254
+ - [LoginConfig](docs/LoginConfig.md)
255
+ - [MeApp](docs/MeApp.md)
256
+ - [MeterEnforcementDecision](docs/MeterEnforcementDecision.md)
257
+ - [MeterEntitlement](docs/MeterEntitlement.md)
258
+ - [ModelReconciliation](docs/ModelReconciliation.md)
259
+ - [OAuthAccessTokenResponse](docs/OAuthAccessTokenResponse.md)
260
+ - [OAuthStartResponse](docs/OAuthStartResponse.md)
261
+ - [OlafApiKeyResponse](docs/OlafApiKeyResponse.md)
262
+ - [OlafTeamsSettings](docs/OlafTeamsSettings.md)
263
+ - [OnboardBusinessRequest](docs/OnboardBusinessRequest.md)
264
+ - [OnboardingConfig](docs/OnboardingConfig.md)
265
+ - [OnboardingStatus](docs/OnboardingStatus.md)
266
+ - [OnboardingStep](docs/OnboardingStep.md)
267
+ - [PageEmployeeOrderInner](docs/PageEmployeeOrderInner.md)
268
+ - [PageEquipmentInner](docs/PageEquipmentInner.md)
269
+ - [PasswordLoginRequest](docs/PasswordLoginRequest.md)
270
+ - [PasswordLoginResult](docs/PasswordLoginResult.md)
271
+ - [PatchBusinessRequest](docs/PatchBusinessRequest.md)
272
+ - [PatchEmployee](docs/PatchEmployee.md)
273
+ - [PendingDevicePreview](docs/PendingDevicePreview.md)
274
+ - [PickSanityPatchEmployeeExcludeKeyofSanityPatchEmployeeScopeGrantsSalaryConfig](docs/PickSanityPatchEmployeeExcludeKeyofSanityPatchEmployeeScopeGrantsSalaryConfig.md)
275
+ - [PickSanityPatchEmployeeExcludeKeyofSanityPatchEmployeeScopeGrantsSettings](docs/PickSanityPatchEmployeeExcludeKeyofSanityPatchEmployeeScopeGrantsSettings.md)
276
+ - [PlanFeature](docs/PlanFeature.md)
277
+ - [PlanInfo](docs/PlanInfo.md)
278
+ - [PlanMeter](docs/PlanMeter.md)
279
+ - [PlatformIntegration](docs/PlatformIntegration.md)
280
+ - [PlatformSanityConfig](docs/PlatformSanityConfig.md)
281
+ - [PlatformSecretField](docs/PlatformSecretField.md)
282
+ - [PlatformSecretStatus](docs/PlatformSecretStatus.md)
283
+ - [PowerOfficeConnectResponse](docs/PowerOfficeConnectResponse.md)
284
+ - [PowerOfficeProduct](docs/PowerOfficeProduct.md)
285
+ - [PowerOfficeProductsResponse](docs/PowerOfficeProductsResponse.md)
286
+ - [PowerOfficeProject](docs/PowerOfficeProject.md)
287
+ - [PowerOfficeProjectsResponse](docs/PowerOfficeProjectsResponse.md)
288
+ - [ProtectedEmployee](docs/ProtectedEmployee.md)
289
+ - [ProvisioningEvent](docs/ProvisioningEvent.md)
290
+ - [RecordImpersonationActivityRequest](docs/RecordImpersonationActivityRequest.md)
291
+ - [RenameDeviceRequest](docs/RenameDeviceRequest.md)
292
+ - [ResetConfirmRequest](docs/ResetConfirmRequest.md)
293
+ - [ResetRequest](docs/ResetRequest.md)
294
+ - [RevokeRequest](docs/RevokeRequest.md)
295
+ - [RollupMeterTotal](docs/RollupMeterTotal.md)
296
+ - [SanityCreateEmployeeCliftonStrengthsInner](docs/SanityCreateEmployeeCliftonStrengthsInner.md)
297
+ - [SanityCreateEmployeeGroupsInner](docs/SanityCreateEmployeeGroupsInner.md)
298
+ - [SanityCreateEmployeeTagsInner](docs/SanityCreateEmployeeTagsInner.md)
299
+ - [SanityCreateEmployeeTechnologiesInner](docs/SanityCreateEmployeeTechnologiesInner.md)
300
+ - [SanityEmployeeCliftonStrengthsInner](docs/SanityEmployeeCliftonStrengthsInner.md)
301
+ - [SanityEmployeeCommissionTier](docs/SanityEmployeeCommissionTier.md)
302
+ - [SanityEmployeeEquipmentInner](docs/SanityEmployeeEquipmentInner.md)
303
+ - [SanityEmployeeGroupsInner](docs/SanityEmployeeGroupsInner.md)
304
+ - [SanityEmployeeManager](docs/SanityEmployeeManager.md)
305
+ - [SanityEmployeeNextOfKinInner](docs/SanityEmployeeNextOfKinInner.md)
306
+ - [SanityEmployeeSalaryConfig](docs/SanityEmployeeSalaryConfig.md)
307
+ - [SanityEmployeeSettings](docs/SanityEmployeeSettings.md)
308
+ - [SanityImageAssetReference](docs/SanityImageAssetReference.md)
309
+ - [SanityImageCrop](docs/SanityImageCrop.md)
310
+ - [SanityImageHotspot](docs/SanityImageHotspot.md)
311
+ - [SanityPatchPageMetaImage](docs/SanityPatchPageMetaImage.md)
312
+ - [SanitySystemsInnerDescriptionInner](docs/SanitySystemsInnerDescriptionInner.md)
313
+ - [SanityTechnologyWithRelationsArticlesInnerMediaOneOf](docs/SanityTechnologyWithRelationsArticlesInnerMediaOneOf.md)
314
+ - [SanityTechnologyWithRelationsEmployeesInnerTagsInner](docs/SanityTechnologyWithRelationsEmployeesInnerTagsInner.md)
315
+ - [SanityTechnologyWithRelationsProjectsInnerTechnologiesInner](docs/SanityTechnologyWithRelationsProjectsInnerTechnologiesInner.md)
316
+ - [SanityTvCategoryDashboardsInnerBackgroundImage](docs/SanityTvCategoryDashboardsInnerBackgroundImage.md)
317
+ - [SanityTvCategoryDashboardsInnerBackgroundImageAsset](docs/SanityTvCategoryDashboardsInnerBackgroundImageAsset.md)
318
+ - [ScopeDefinition](docs/ScopeDefinition.md)
319
+ - [SessionBootstrapRequest](docs/SessionBootstrapRequest.md)
320
+ - [SetActiveProviderRequest](docs/SetActiveProviderRequest.md)
321
+ - [SetFacebookAccountRequest](docs/SetFacebookAccountRequest.md)
322
+ - [SetGoogleAnalyticsPropertyRequest](docs/SetGoogleAnalyticsPropertyRequest.md)
323
+ - [SetPlatformSecretRequest](docs/SetPlatformSecretRequest.md)
324
+ - [SetScopeGrantsRequest](docs/SetScopeGrantsRequest.md)
325
+ - [SetWorkReposRequest](docs/SetWorkReposRequest.md)
326
+ - [SetWorkspaceRepoRequest](docs/SetWorkspaceRepoRequest.md)
327
+ - [SignupConfig](docs/SignupConfig.md)
328
+ - [SignupRequest](docs/SignupRequest.md)
329
+ - [SignupResult](docs/SignupResult.md)
330
+ - [Slug](docs/Slug.md)
331
+ - [SsoExchangeRequest](docs/SsoExchangeRequest.md)
332
+ - [StartImpersonationRequest](docs/StartImpersonationRequest.md)
333
+ - [StartImpersonationResult](docs/StartImpersonationResult.md)
334
+ - [StudioSanityConfig](docs/StudioSanityConfig.md)
335
+ - [SystemRoleOption](docs/SystemRoleOption.md)
336
+ - [TeamsAcsTokenResponse](docs/TeamsAcsTokenResponse.md)
337
+ - [TeamsAuthStateResponse](docs/TeamsAuthStateResponse.md)
338
+ - [TenantDomain](docs/TenantDomain.md)
339
+ - [TenantInfo](docs/TenantInfo.md)
340
+ - [TenantSanityCredentials](docs/TenantSanityCredentials.md)
341
+ - [TokenExchangeRequest](docs/TokenExchangeRequest.md)
342
+ - [TokenExchangeResult](docs/TokenExchangeResult.md)
343
+ - [TokenReconciliationReport](docs/TokenReconciliationReport.md)
344
+ - [TokenReconciliationSnapshot](docs/TokenReconciliationSnapshot.md)
345
+ - [TotpEnrollRequest](docs/TotpEnrollRequest.md)
346
+ - [TotpEnrollResult](docs/TotpEnrollResult.md)
347
+ - [UpdateAppsRequest](docs/UpdateAppsRequest.md)
348
+ - [UpdateSecretsRequest](docs/UpdateSecretsRequest.md)
349
+ - [UsageDailySeries](docs/UsageDailySeries.md)
350
+ - [UsageDayPoint](docs/UsageDayPoint.md)
351
+ - [UsageEvent](docs/UsageEvent.md)
352
+ - [UsageEventsRequest](docs/UsageEventsRequest.md)
353
+ - [UsageMeterDailySeries](docs/UsageMeterDailySeries.md)
354
+ - [UsageMeterSummary](docs/UsageMeterSummary.md)
355
+ - [UsageRollup](docs/UsageRollup.md)
356
+ - [UsageRollupTotals](docs/UsageRollupTotals.md)
357
+ - [UsageSummary](docs/UsageSummary.md)
358
+ - [VerifyApiTokenRequest](docs/VerifyApiTokenRequest.md)
359
+ - [WorkReposSelection](docs/WorkReposSelection.md)
360
+ - [WorkspaceRepoSelection](docs/WorkspaceRepoSelection.md)
361
+
362
+ ### Authorization
363
+
364
+
365
+ Authentication schemes defined for the API:
366
+ <a id="Implicit-implicit"></a>
367
+ #### Implicit implicit
368
+
369
+
370
+ - **Type**: OAuth
371
+ - **Flow**: implicit
372
+ - **Authorization URL**: https://login.microsoftonline.com/81a4f38d-6712-4b65-868b-c3771f9ba91e/oauth2/v2.0/authorize
373
+ - **Scopes**:
374
+ - `api://c03a7c58-49d5-4f50-aa43-ad00b22c6943/user_impersonation`: Default function scope
375
+
376
+ ## About
377
+
378
+ This TypeScript SDK client supports the [Fetch API](https://fetch.spec.whatwg.org/)
379
+ and is automatically generated by the
380
+ [OpenAPI Generator](https://openapi-generator.tech) project:
381
+
382
+ - API version: `v1.0.0`
383
+ - Package version: `1.0.0`
384
+ - Generator version: `7.23.0`
385
+ - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
386
+
387
+ The generated npm module supports the following:
388
+
389
+ - Environments
390
+ * Node.js
391
+ * Webpack
392
+ * Browserify
393
+ - Language levels
394
+ * ES5 - you must have a Promises/A+ library installed
395
+ * ES6
396
+ - Module systems
397
+ * CommonJS
398
+ * ES6 module system
399
+
400
+
401
+ ## Development
402
+
403
+ ### Building
404
+
405
+ To build the TypeScript source code, you need to have Node.js and npm installed.
406
+ After cloning the repository, navigate to the project directory and run:
407
+
408
+ ```bash
409
+ npm install
410
+ npm run build
411
+ ```
412
+
413
+ ### Publishing
414
+
415
+ Once you've built the package, you can publish it to npm:
416
+
417
+ ```bash
418
+ npm publish
419
+ ```
420
+
421
+ ## License
422
+
423
+ []()