@censys/platform-sdk 0.7.0 → 0.9.0

package/README.md

@@ -111,7 +111,19 @@ run();
 <details open>
 <summary>Available methods</summary>
 
-### [collections](docs/sdks/collections/README.md)
+### [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 details
+* [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
+* [getUserCredits](docs/sdks/accountmanagement/README.md#getusercredits) - Get Free user credit details
+
+### [Collections](docs/sdks/collections/README.md)
 
 * [list](docs/sdks/collections/README.md#list) - List collections
 * [create](docs/sdks/collections/README.md#create) - Create a collection
@@ -122,7 +134,7 @@ run();
 * [aggregate](docs/sdks/collections/README.md#aggregate) - Aggregate results for a search query within a collection
 * [search](docs/sdks/collections/README.md#search) - Run a search query within a collection
 
-### [globalData](docs/sdks/globaldata/README.md)
+### [GlobalData](docs/sdks/globaldata/README.md)
 
 * [getCertificates](docs/sdks/globaldata/README.md#getcertificates) - Retrieve multiple certificates
 * [getCertificatesRaw](docs/sdks/globaldata/README.md#getcertificatesraw) - Retrieve multiple certificates in PEM format
@@ -139,11 +151,12 @@ 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)
+### [ThreatHunting](docs/sdks/threathunting/README.md)
 
 * [getHostObservationsWithCertificate](docs/sdks/threathunting/README.md#gethostobservationswithcertificate) - Get host history for a certificate
 * [createTrackedScan](docs/sdks/threathunting/README.md#createtrackedscan) - Live Discovery: Initiate a new scan
 * [getTrackedScanThreatHunting](docs/sdks/threathunting/README.md#gettrackedscanthreathunting) - Get scan status
+* [listThreats](docs/sdks/threathunting/README.md#listthreats) - List active threats
 * [valueCounts](docs/sdks/threathunting/README.md#valuecounts) - CensEye: Retrieve value counts to discover pivots
 
 </details>
@@ -164,6 +177,15 @@ 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 details
+- [`accountManagementGetOrganizationCreditUsage`](docs/sdks/accountmanagement/README.md#getorganizationcreditusage) - Get organization credit usage
+- [`accountManagementGetOrganizationDetails`](docs/sdks/accountmanagement/README.md#getorganizationdetails) - Get organization details
+- [`accountManagementGetUserCredits`](docs/sdks/accountmanagement/README.md#getusercredits) - Get Free user credit 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
@@ -189,6 +211,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`threatHuntingCreateTrackedScan`](docs/sdks/threathunting/README.md#createtrackedscan) - Live Discovery: Initiate a new scan
 - [`threatHuntingGetHostObservationsWithCertificate`](docs/sdks/threathunting/README.md#gethostobservationswithcertificate) - Get host history for a certificate
 - [`threatHuntingGetTrackedScanThreatHunting`](docs/sdks/threathunting/README.md#gettrackedscanthreathunting) - Get scan status
+- [`threatHuntingListThreats`](docs/sdks/threathunting/README.md#listthreats) - List active threats
 - [`threatHuntingValueCounts`](docs/sdks/threathunting/README.md#valuecounts) - CensEye: Retrieve value counts to discover pivots
 
 </details>
@@ -199,7 +222,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
@@ -221,9 +244,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);
@@ -244,14 +266,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",
@@ -287,14 +307,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);
@@ -325,15 +343,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);
@@ -360,8 +376,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): Generic error.
   * [`AuthenticationError`](./src/models/errors/authenticationerror.ts): Request does not contain a valid Authorization token. Status code `401`.
-  * [`ErrorModel`](./src/models/errors/errormodel.ts): User does not have permission to access this data.
 
 <details><summary>Less common errors (6)</summary>
 
@@ -392,14 +408,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);
@@ -476,13 +490,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);