@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
package/docs/PlanInfo.md ADDED
@@ -0,0 +1,21 @@
1
+
2
+ # PlanInfo
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `displayName` | string
10
+ `features` | [Array<PlanFeature>](PlanFeature.md)
11
+ `maxUsers` | number
12
+ `meters` | [Array<PlanMeter>](PlanMeter.md)
13
+ `modules` | { [key: string]: boolean; }
14
+ `monthlyPricePerUserOre` | number
15
+ `plan` | string
16
+ `salesCommissionPercent` | number
17
+
18
+
19
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
20
+
21
+
package/docs/PlanMeter.md ADDED
@@ -0,0 +1,24 @@
1
+
2
+ # PlanMeter
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `customerVisible` | boolean
10
+ `displayName` | string
11
+ `feePercent` | number
12
+ `includedPerMonth` | number
13
+ `kind` | string
14
+ `listUnitPriceOre` | number
15
+ `maxCount` | number
16
+ `meter` | string
17
+ `modelPriced` | boolean
18
+ `owningModule` | string
19
+ `unitPriceOre` | number
20
+
21
+
22
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
23
+
24
+