@censys/platform-sdk 0.9.0 → 0.10.0

package/src/models/operations/v3accountmanagementusercreditsusage.ts

@@ -0,0 +1,128 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { RFCDate } from "../../types/rfcdate.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Whether to break down credit usage on a daily or monthly basis.
+ */
+export const V3AccountmanagementUserCreditsUsageQueryParamGranularity = {
+  Daily: "daily",
+  Monthly: "monthly",
+} as const;
+/**
+ * Whether to break down credit usage on a daily or monthly basis.
+ */
+export type V3AccountmanagementUserCreditsUsageQueryParamGranularity =
+  ClosedEnum<typeof V3AccountmanagementUserCreditsUsageQueryParamGranularity>;
+
+export type V3AccountmanagementUserCreditsUsageRequest = {
+  /**
+   * The date for the credit usage report in YYYY-MM-DD format (e.g., 2025-11-06). This field is deprecated and will be removed in a future version. Use start_date and end_date instead. The date must be on or after 2025-01-01 (the earliest date available for credit usage reports).
+   */
+  date?: string | undefined;
+  /**
+   * The start date for the credit usage report in YYYY-MM-DD format (e.g., 2025-11-01). Must be on or after 2025-01-01 (the earliest date available for credit usage reports).
+   */
+  startDate?: RFCDate | undefined;
+  /**
+   * The end date for the credit usage report in YYYY-MM-DD format (e.g., 2025-12-01). If omitted, will default to today's date. The date range (end_date - start_date) cannot exceed 365 days (1 year).
+   */
+  endDate?: RFCDate | undefined;
+  /**
+   * Whether to break down credit usage on a daily or monthly basis.
+   */
+  granularity?:
+    | V3AccountmanagementUserCreditsUsageQueryParamGranularity
+    | undefined;
+};
+
+export type V3AccountmanagementUserCreditsUsageResponse = {
+  headers: { [k: string]: Array<string> };
+  result: components.ResponseEnvelopeCreditUsageReport;
+};
+
+/** @internal */
+export const V3AccountmanagementUserCreditsUsageQueryParamGranularity$outboundSchema:
+  z.ZodNativeEnum<
+    typeof V3AccountmanagementUserCreditsUsageQueryParamGranularity
+  > = z.nativeEnum(V3AccountmanagementUserCreditsUsageQueryParamGranularity);
+
+/** @internal */
+export type V3AccountmanagementUserCreditsUsageRequest$Outbound = {
+  date?: string | undefined;
+  start_date?: string | undefined;
+  end_date?: string | undefined;
+  granularity: string;
+};
+
+/** @internal */
+export const V3AccountmanagementUserCreditsUsageRequest$outboundSchema:
+  z.ZodType<
+    V3AccountmanagementUserCreditsUsageRequest$Outbound,
+    z.ZodTypeDef,
+    V3AccountmanagementUserCreditsUsageRequest
+  > = z.object({
+    date: z.string().optional(),
+    startDate: z.instanceof(RFCDate).transform(v => v.toString()).optional(),
+    endDate: z.instanceof(RFCDate).transform(v => v.toString()).optional(),
+    granularity:
+      V3AccountmanagementUserCreditsUsageQueryParamGranularity$outboundSchema
+        .default("daily"),
+  }).transform((v) => {
+    return remap$(v, {
+      startDate: "start_date",
+      endDate: "end_date",
+    });
+  });
+
+export function v3AccountmanagementUserCreditsUsageRequestToJSON(
+  v3AccountmanagementUserCreditsUsageRequest:
+    V3AccountmanagementUserCreditsUsageRequest,
+): string {
+  return JSON.stringify(
+    V3AccountmanagementUserCreditsUsageRequest$outboundSchema.parse(
+      v3AccountmanagementUserCreditsUsageRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const V3AccountmanagementUserCreditsUsageResponse$inboundSchema:
+  z.ZodType<
+    V3AccountmanagementUserCreditsUsageResponse,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    Headers: z.record(z.array(z.string())).default({}),
+    Result: components.ResponseEnvelopeCreditUsageReport$inboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      "Headers": "headers",
+      "Result": "result",
+    });
+  });
+
+export function v3AccountmanagementUserCreditsUsageResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  V3AccountmanagementUserCreditsUsageResponse,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      V3AccountmanagementUserCreditsUsageResponse$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'V3AccountmanagementUserCreditsUsageResponse' from JSON`,
+  );
+}

package/src/sdk/accountmanagement.ts

@@ -7,6 +7,7 @@ import { accountManagementGetOrganizationCredits } from "../funcs/accountManagem
 import { accountManagementGetOrganizationCreditUsage } from "../funcs/accountManagementGetOrganizationCreditUsage.js";
 import { accountManagementGetOrganizationDetails } from "../funcs/accountManagementGetOrganizationDetails.js";
 import { accountManagementGetUserCredits } from "../funcs/accountManagementGetUserCredits.js";
+import { accountManagementGetUserCreditsUsage } from "../funcs/accountManagementGetUserCreditsUsage.js";
 import {
   accountManagementInviteUserToOrganization,
   InviteUserToOrganizationAcceptEnum,
@@ -49,7 +50,7 @@ export class AccountManagement extends ClientSDK {
   }
 
   /**
-   * Get organization credit details
+   * Get organization credit balance
    *
    * @remarks
    * Retrieve credit balance and expiration information for an organization. <br><br>Credits expire 12 months after they are acquired.<br><br>This endpoint does not cost any credits to execute.
@@ -69,7 +70,7 @@ export class AccountManagement extends ClientSDK {
    * Get organization credit usage
    *
    * @remarks
-   * Retrieve credit consumption information for an organization for a specific day.<br><br>Admins can obtain credit usage information for all users in their organization. Members may only retrieve usage information for their own account.<br><br>This endpoint does not cost any credits to execute.
+   * Retrieve credit information for an organization over a specific date range. You must include a start date in your request.<br><br>Admins can obtain credit usage information for all users in their organization. Members may only retrieve usage information for their own account.<br><br>This endpoint does not cost any credits to execute.
    */
   async getOrganizationCreditUsage(
     request: operations.V3AccountmanagementOrgCreditsUsageRequest,
@@ -163,10 +164,10 @@ export class AccountManagement extends ClientSDK {
   }
 
   /**
-   * Get member credit usage
+   * Get organization member credit usage
    *
    * @remarks
-   * Retrieve credit consumption information for an organization member for a specific day.<br><br>This endpoint does not cost any credits to execute.
+   * Retrieve credit consumption information for an organization member over a specific date range. You must include a start date in your request.<br><br>This endpoint does not cost any credits to execute.
    */
   async getMemberCreditUsage(
     request: operations.V3AccountmanagementMemberCreditsUsageRequest,
@@ -180,10 +181,10 @@ export class AccountManagement extends ClientSDK {
   }
 
   /**
-   * Get Free user credit details
+   * Get Free user credit balance
    *
    * @remarks
-   * Retrieve your Free user account credit balance and refresh information. To retrieve the credit balance for a Starter or Enterprise account, use the [get organization credit details endpoint](https://docs.censys.com/reference/v3-accountmanagement-org-credits).<br><br>This endpoint does not cost any credits to execute.
+   * Retrieve your Free user account credit balance and refresh information. To retrieve the credit balance for a Starter or Enterprise account, use the [get organization credit balance endpoint](https://docs.censys.com/reference/v3-accountmanagement-org-credits).<br><br>This endpoint does not cost any credits to execute.
    */
   async getUserCredits(
     options?: RequestOptions,
@@ -193,4 +194,21 @@ export class AccountManagement extends ClientSDK {
       options,
     ));
   }
+
+  /**
+   * Get Free user credit usage
+   *
+   * @remarks
+   * Retrieve your Free user account credit consumption information over a specific date range. You must include a start date in your request.<br><br>This endpoint does not cost any credits to execute.
+   */
+  async getUserCreditsUsage(
+    request: operations.V3AccountmanagementUserCreditsUsageRequest,
+    options?: RequestOptions,
+  ): Promise<operations.V3AccountmanagementUserCreditsUsageResponse> {
+    return unwrapAsync(accountManagementGetUserCreditsUsage(
+      this,
+      request,
+      options,
+    ));
+  }
 }

package/src/sdk/collections.ts

@@ -24,7 +24,7 @@ export class Collections extends ClientSDK {
    * List collections
    *
    * @remarks
-   * List all collections for an organization. Retrieved information includes collection ID, name, query, description, status, and asset count.
+   * List all collections for an organization. Retrieved information includes collection ID, name, query, description, status, and asset count.<br><br>This endpoint does not cost credits to execute.
    */
   async list(
     request: operations.V3CollectionsCrudListRequest,
@@ -41,7 +41,7 @@ export class Collections extends ClientSDK {
    * Create a collection
    *
    * @remarks
-   * Create a new collection.
+   * Create a new collection.<br><br>This endpoint does not cost credits to execute.
    */
   async create(
     request: operations.V3CollectionsCrudCreateRequest,
@@ -58,7 +58,7 @@ export class Collections extends ClientSDK {
    * Delete a collection
    *
    * @remarks
-   * Delete a collection.
+   * Delete a collection.<br><br>This endpoint does not cost credits to execute.
    */
   async delete(
     request: operations.V3CollectionsCrudDeleteRequest,
@@ -75,7 +75,7 @@ export class Collections extends ClientSDK {
    * Get a collection
    *
    * @remarks
-   * Retrieve information about a collection. Retrieved information includes its name, query, description, status, and asset count.
+   * Retrieve information about a collection. Retrieved information includes its name, query, description, status, and asset count.<br><br>This endpoint does not cost credits to execute.
    */
   async get(
     request: operations.V3CollectionsCrudGetRequest,
@@ -92,7 +92,7 @@ export class Collections extends ClientSDK {
    * Update a collection
    *
    * @remarks
-   * Update a collection's name, description, and/or query.
+   * Update a collection's name, description, and/or query.<br><br>This endpoint does not cost credits to execute.
    */
   async update(
     request: operations.V3CollectionsCrudUpdateRequest,
@@ -109,7 +109,7 @@ export class Collections extends ClientSDK {
    * Get a collection's events
    *
    * @remarks
-   * Retrieve the event history for a collection. This includes the addition or removal of assets as well as collection status changes.
+   * Retrieve the event history for a collection. This includes the addition or removal of assets as well as collection status changes.<br><br>This endpoint does not cost credits to execute.
    */
   async listEvents(
     request: operations.V3CollectionsListEventsRequest,

package/src/sdk/threathunting.ts

@@ -70,7 +70,7 @@ export class ThreatHunting extends ClientSDK {
    * List active threats
    *
    * @remarks
-   * Retrieve a list of active threats observed by Censys by aggregating threat IDs across hosts and web properties. Threats are active if their fingerprint has been identified on hosts or web properties by Censys scans. This information is also available on the [Explore Threats page in the Platform web UI](https://platform.censys.io/threats).
+   * Retrieve a list of active threats observed by Censys by aggregating threat IDs across hosts and web properties. Threats are active if their fingerprint has been identified on hosts or web properties by Censys scans. This information is also available on the [Explore Threats page in the Platform web UI](https://platform.censys.io/threats).<br><br>This endpoint is available to organizations that have access to the Threat Hunting module.
    */
   async listThreats(
     request: operations.V3ThreathuntingThreatsListRequest,