@censys/platform-sdk 0.6.0 → 0.8.0

package/README.md

@@ -63,10 +63,7 @@ bun add @censys/platform-sdk
 ### Yarn
 
 ```bash
-yarn add @censys/platform-sdk zod
-
-# Note that Yarn does not install peer dependencies automatically. You will need
-# to install zod as shown above.
+yarn add @censys/platform-sdk
 ```
 <!-- End SDK Installation [installation] -->
 
@@ -114,6 +111,17 @@ run();
 <details open>
 <summary>Available methods</summary>
 
+### [accountManagement](docs/sdks/accountmanagement/README.md)
+
+* [getOrganizationDetails](docs/sdks/accountmanagement/README.md#getorganizationdetails) - Get organization details
+* [getOrganizationCredits](docs/sdks/accountmanagement/README.md#getorganizationcredits) - Get organization credit statistics
+* [getOrganizationCreditUsage](docs/sdks/accountmanagement/README.md#getorganizationcreditusage) - Get organization credit usage
+* [inviteUserToOrganization](docs/sdks/accountmanagement/README.md#inviteusertoorganization) - Invite user to organization
+* [listOrganizationMembers](docs/sdks/accountmanagement/README.md#listorganizationmembers) - List organization members
+* [removeOrganizationMember](docs/sdks/accountmanagement/README.md#removeorganizationmember) - Remove member from organization
+* [updateOrganizationMember](docs/sdks/accountmanagement/README.md#updateorganizationmember) - Update a member's roles in an organization
+* [getMemberCreditUsage](docs/sdks/accountmanagement/README.md#getmembercreditusage) - Get member credit usage
+
 ### [collections](docs/sdks/collections/README.md)
 
 * [list](docs/sdks/collections/README.md#list) - List collections
@@ -127,14 +135,14 @@ run();
 
 ### [globalData](docs/sdks/globaldata/README.md)
 
-* [getCertificates](docs/sdks/globaldata/README.md#getcertificates) - Get multiple certificates
-* [getCertificatesRaw](docs/sdks/globaldata/README.md#getcertificatesraw) - Get multiple certificates in PEM format
+* [getCertificates](docs/sdks/globaldata/README.md#getcertificates) - Retrieve multiple certificates
+* [getCertificatesRaw](docs/sdks/globaldata/README.md#getcertificatesraw) - Retrieve multiple certificates in PEM format
 * [getCertificate](docs/sdks/globaldata/README.md#getcertificate) - Get a certificate
 * [getCertificateRaw](docs/sdks/globaldata/README.md#getcertificateraw) - Get a certificate in PEM format
-* [getHosts](docs/sdks/globaldata/README.md#gethosts) - Get multiple hosts
+* [getHosts](docs/sdks/globaldata/README.md#gethosts) - Retrieve multiple hosts
 * [getHost](docs/sdks/globaldata/README.md#gethost) - Get a host
 * [getHostTimeline](docs/sdks/globaldata/README.md#gethosttimeline) - Get host event history
-* [getWebProperties](docs/sdks/globaldata/README.md#getwebproperties) - Get multiple web properties
+* [getWebProperties](docs/sdks/globaldata/README.md#getwebproperties) - Retrieve multiple web properties
 * [getWebProperty](docs/sdks/globaldata/README.md#getwebproperty) - Get a web property
 * [createTrackedScan](docs/sdks/globaldata/README.md#createtrackedscan) - Live Rescan: Initiate a new rescan
 * [getTrackedScan](docs/sdks/globaldata/README.md#gettrackedscan) - Get scan status
@@ -142,7 +150,6 @@ run();
 * [convertLegacySearchQueries](docs/sdks/globaldata/README.md#convertlegacysearchqueries) - Convert Legacy Search queries to Platform queries
 * [search](docs/sdks/globaldata/README.md#search) - Run a search query
 
-
 ### [threatHunting](docs/sdks/threathunting/README.md)
 
 * [getHostObservationsWithCertificate](docs/sdks/threathunting/README.md#gethostobservationswithcertificate) - Get host history for a certificate
@@ -168,6 +175,14 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 
 <summary>Available standalone functions</summary>
 
+- [`accountManagementGetMemberCreditUsage`](docs/sdks/accountmanagement/README.md#getmembercreditusage) - Get member credit usage
+- [`accountManagementGetOrganizationCredits`](docs/sdks/accountmanagement/README.md#getorganizationcredits) - Get organization credit statistics
+- [`accountManagementGetOrganizationCreditUsage`](docs/sdks/accountmanagement/README.md#getorganizationcreditusage) - Get organization credit usage
+- [`accountManagementGetOrganizationDetails`](docs/sdks/accountmanagement/README.md#getorganizationdetails) - Get organization details
+- [`accountManagementInviteUserToOrganization`](docs/sdks/accountmanagement/README.md#inviteusertoorganization) - Invite user to organization
+- [`accountManagementListOrganizationMembers`](docs/sdks/accountmanagement/README.md#listorganizationmembers) - List organization members
+- [`accountManagementRemoveOrganizationMember`](docs/sdks/accountmanagement/README.md#removeorganizationmember) - Remove member from organization
+- [`accountManagementUpdateOrganizationMember`](docs/sdks/accountmanagement/README.md#updateorganizationmember) - Update a member's roles in an organization
 - [`collectionsAggregate`](docs/sdks/collections/README.md#aggregate) - Aggregate results for a search query within a collection
 - [`collectionsCreate`](docs/sdks/collections/README.md#create) - Create a collection
 - [`collectionsDelete`](docs/sdks/collections/README.md#delete) - Delete a collection
@@ -181,13 +196,13 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`globalDataCreateTrackedScan`](docs/sdks/globaldata/README.md#createtrackedscan) - Live Rescan: Initiate a new rescan
 - [`globalDataGetCertificate`](docs/sdks/globaldata/README.md#getcertificate) - Get a certificate
 - [`globalDataGetCertificateRaw`](docs/sdks/globaldata/README.md#getcertificateraw) - Get a certificate in PEM format
-- [`globalDataGetCertificates`](docs/sdks/globaldata/README.md#getcertificates) - Get multiple certificates
-- [`globalDataGetCertificatesRaw`](docs/sdks/globaldata/README.md#getcertificatesraw) - Get multiple certificates in PEM format
+- [`globalDataGetCertificates`](docs/sdks/globaldata/README.md#getcertificates) - Retrieve multiple certificates
+- [`globalDataGetCertificatesRaw`](docs/sdks/globaldata/README.md#getcertificatesraw) - Retrieve multiple certificates in PEM format
 - [`globalDataGetHost`](docs/sdks/globaldata/README.md#gethost) - Get a host
-- [`globalDataGetHosts`](docs/sdks/globaldata/README.md#gethosts) - Get multiple hosts
+- [`globalDataGetHosts`](docs/sdks/globaldata/README.md#gethosts) - Retrieve multiple hosts
 - [`globalDataGetHostTimeline`](docs/sdks/globaldata/README.md#gethosttimeline) - Get host event history
 - [`globalDataGetTrackedScan`](docs/sdks/globaldata/README.md#gettrackedscan) - Get scan status
-- [`globalDataGetWebProperties`](docs/sdks/globaldata/README.md#getwebproperties) - Get multiple web properties
+- [`globalDataGetWebProperties`](docs/sdks/globaldata/README.md#getwebproperties) - Retrieve multiple web properties
 - [`globalDataGetWebProperty`](docs/sdks/globaldata/README.md#getwebproperty) - Get a web property
 - [`globalDataSearch`](docs/sdks/globaldata/README.md#search) - Run a search query
 - [`threatHuntingCreateTrackedScan`](docs/sdks/threathunting/README.md#createtrackedscan) - Live Discovery: Initiate a new scan
@@ -203,7 +218,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 
 A parameter is configured globally. This parameter may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed.
 
-For example, you can set `organization_id` to `` at SDK initialization and then you do not have to pass the same value on calls to operations like `list`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.
+For example, you can set `organization_id` to `` at SDK initialization and then you do not have to pass the same value on calls to operations like `getOrganizationDetails`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.
 
 
 ### Available Globals
@@ -225,9 +240,8 @@ const sdk = new SDK({
 });
 
 async function run() {
-  const result = await sdk.collections.list({
-    pageToken: "<next_page_token>",
-    pageSize: 1,
+  const result = await sdk.accountManagement.getOrganizationDetails({
+    organizationId: "11111111-2222-3333-4444-555555555555",
   });
 
   console.log(result);
@@ -248,14 +262,12 @@ To change the default retry strategy for a single API call, simply provide a ret
 import { SDK } from "@censys/platform-sdk";
 
 const sdk = new SDK({
-  organizationId: "11111111-2222-3333-4444-555555555555",
   personalAccessToken: "<YOUR_BEARER_TOKEN_HERE>",
 });
 
 async function run() {
-  const result = await sdk.collections.list({
-    pageToken: "<next_page_token>",
-    pageSize: 1,
+  const result = await sdk.accountManagement.getOrganizationDetails({
+    organizationId: "11111111-2222-3333-4444-555555555555",
   }, {
     retries: {
       strategy: "backoff",
@@ -291,14 +303,12 @@ const sdk = new SDK({
     },
     retryConnectionErrors: false,
   },
-  organizationId: "11111111-2222-3333-4444-555555555555",
   personalAccessToken: "<YOUR_BEARER_TOKEN_HERE>",
 });
 
 async function run() {
-  const result = await sdk.collections.list({
-    pageToken: "<next_page_token>",
-    pageSize: 1,
+  const result = await sdk.accountManagement.getOrganizationDetails({
+    organizationId: "11111111-2222-3333-4444-555555555555",
   });
 
   console.log(result);
@@ -329,15 +339,13 @@ import { SDK } from "@censys/platform-sdk";
 import * as errors from "@censys/platform-sdk/models/errors";
 
 const sdk = new SDK({
-  organizationId: "11111111-2222-3333-4444-555555555555",
   personalAccessToken: "<YOUR_BEARER_TOKEN_HERE>",
 });
 
 async function run() {
   try {
-    const result = await sdk.collections.list({
-      pageToken: "<next_page_token>",
-      pageSize: 1,
+    const result = await sdk.accountManagement.getOrganizationDetails({
+      organizationId: "11111111-2222-3333-4444-555555555555",
     });
 
     console.log(result);
@@ -350,12 +358,8 @@ async function run() {
       console.log(error.headers);
 
       // Depending on the method different errors may be thrown
-      if (error instanceof errors.ErrorModel) {
-        console.log(error.data$.detail); // string
-        console.log(error.data$.errors); // ErrorDetail[]
-        console.log(error.data$.instance); // string
-        console.log(error.data$.status); // number
-        console.log(error.data$.title); // string
+      if (error instanceof errors.AuthenticationError) {
+        console.log(error.data$.error); // components.AuthenticationErrorDetail
       }
     }
   }
@@ -368,7 +372,8 @@ run();
 ### Error Classes
 **Primary errors:**
 * [`SDKBaseError`](./src/models/errors/sdkbaseerror.ts): The base class for HTTP error responses.
-  * [`ErrorModel`](./src/models/errors/errormodel.ts): Request does not contain a valid Authorization token.
+  * [`ErrorModel`](./src/models/errors/errormodel.ts): Generic error.
+  * [`AuthenticationError`](./src/models/errors/authenticationerror.ts): Request does not contain a valid Authorization token. Status code `401`.
 
 <details><summary>Less common errors (6)</summary>
 
@@ -399,14 +404,12 @@ import { SDK } from "@censys/platform-sdk";
 
 const sdk = new SDK({
   serverURL: "https://api.platform.censys.io",
-  organizationId: "11111111-2222-3333-4444-555555555555",
   personalAccessToken: "<YOUR_BEARER_TOKEN_HERE>",
 });
 
 async function run() {
-  const result = await sdk.collections.list({
-    pageToken: "<next_page_token>",
-    pageSize: 1,
+  const result = await sdk.accountManagement.getOrganizationDetails({
+    organizationId: "11111111-2222-3333-4444-555555555555",
   });
 
   console.log(result);
@@ -462,7 +465,7 @@ httpClient.addHook("requestError", (error, request) => {
   console.groupEnd();
 });
 
-const sdk = new SDK({ httpClient });
+const sdk = new SDK({ httpClient: httpClient });
 ```
 <!-- End Custom HTTP Client [http-client] -->
 
@@ -483,13 +486,11 @@ import { SDK } from "@censys/platform-sdk";
 
 const sdk = new SDK({
   personalAccessToken: "<YOUR_BEARER_TOKEN_HERE>",
-  organizationId: "11111111-2222-3333-4444-555555555555",
 });
 
 async function run() {
-  const result = await sdk.collections.list({
-    pageToken: "<next_page_token>",
-    pageSize: 1,
+  const result = await sdk.accountManagement.getOrganizationDetails({
+    organizationId: "11111111-2222-3333-4444-555555555555",
   });
 
   console.log(result);

package/RUNTIMES.md

@@ -2,9 +2,9 @@
 
 This SDK is intended to be used in JavaScript runtimes that support ECMAScript 2020 or newer. The SDK uses the following features:
 
-* [Web Fetch API][web-fetch]
-* [Web Streams API][web-streams] and in particular `ReadableStream`
-* [Async iterables][async-iter] using `Symbol.asyncIterator`
+- [Web Fetch API][web-fetch]
+- [Web Streams API][web-streams] and in particular `ReadableStream`
+- [Async iterables][async-iter] using `Symbol.asyncIterator`
 
 [web-fetch]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API
 [web-streams]: https://developer.mozilla.org/en-US/docs/Web/API/Streams_API
@@ -25,7 +25,7 @@ Runtime environments that are explicitly supported are:
 
 The following `tsconfig.json` options are recommended for projects using this
 SDK in order to get static type support for features like async iterables,
-streams and `fetch`-related APIs ([`for await...of`][for-await-of], 
+streams and `fetch`-related APIs ([`for await...of`][for-await-of],
 [`AbortSignal`][abort-signal], [`Request`][request], [`Response`][response] and
 so on):
 
@@ -38,11 +38,11 @@ so on):
 {
   "compilerOptions": {
     "target": "es2020", // or higher
-    "lib": ["es2020", "dom", "dom.iterable"],
+    "lib": ["es2020", "dom", "dom.iterable"]
   }
 }
 ```
 
 While `target` can be set to older ECMAScript versions, it may result in extra,
 unnecessary compatibility code being generated if you are not targeting old
-runtimes.
+runtimes.