@spaceinvoices/js-sdk 11.1.1 → 12.0.0

package/dist/generated/activities/activities.d.cts

@@ -7,7 +7,7 @@
  */
 import type { Error, GetActivities200, GetActivitiesParams } from '../model/index.cjs';
 /**
- * Retrieve a paginated list of activities for the entity. Supports filtering by resource_type, resource_id, and action. Set include_related_payments=true with resource_id to include historical Payment events linked through invoice_id, credit_note_id, or advance_invoice_id. Other filters still apply. Omitted, null, or false retains exact resource filtering; without resource_id the flag has no effect. Activities are ordered by ID descending by default.
+ * Retrieve a paginated list of activities for the entity. Supports filtering by resource_type, resource_id, and action. Set include_related_payments=true with resource_id to include historical payment events linked through invoice_id, credit_note_id, or advance_invoice_id. Other filters still apply. Omitted, null, or false retains exact resource filtering; without resource_id the flag has no effect. Activities are ordered by ID descending by default.
  * @summary List activities
  */
 export type getActivitiesResponse200 = {

package/dist/generated/activities/activities.d.ts

@@ -7,7 +7,7 @@
  */
 import type { Error, GetActivities200, GetActivitiesParams } from '../model/index.js';
 /**
- * Retrieve a paginated list of activities for the entity. Supports filtering by resource_type, resource_id, and action. Set include_related_payments=true with resource_id to include historical Payment events linked through invoice_id, credit_note_id, or advance_invoice_id. Other filters still apply. Omitted, null, or false retains exact resource filtering; without resource_id the flag has no effect. Activities are ordered by ID descending by default.
+ * Retrieve a paginated list of activities for the entity. Supports filtering by resource_type, resource_id, and action. Set include_related_payments=true with resource_id to include historical payment events linked through invoice_id, credit_note_id, or advance_invoice_id. Other filters still apply. Omitted, null, or false retains exact resource filtering; without resource_id the flag has no effect. Activities are ordered by ID descending by default.
  * @summary List activities
  */
 export type getActivitiesResponse200 = {

package/dist/generated/entity-api-keys/entity-api-keys.d.cts

@@ -5,7 +5,7 @@
  * REST API for invoice management, customer management, and accounting operations. Features include cursor-based pagination for efficient data navigation, flexible JSON querying with MongoDB-style operators, full-text search across multiple fields, and comprehensive metadata support for custom tracking.
  * OpenAPI spec version: 1.0.0
  */
-import type { CreateEntityApiKeyBody, DeleteEntityApiKey200, EntityApiKey, EntityApiKeysList, Error, ValidationError } from '../model/index.cjs';
+import type { CreateEntityApiKeyBody, CreateEntityApiKeyResponse, DeleteEntityApiKey200, EntityApiKeysList, Error, ValidationError } from '../model/index.cjs';
 /**
  * Retrieve all API keys for the current entity. Keys are masked for security.
  * @summary List entity API keys
@@ -48,7 +48,7 @@ export declare const listEntityApiKeys: (options?: RequestInit) => Promise<listE
  * @summary Create entity API key
  */
 export type createEntityApiKeyResponse201 = {
-    data: EntityApiKey;
+    data: CreateEntityApiKeyResponse;
     status: 201;
 };
 export type createEntityApiKeyResponse400 = {

package/dist/generated/entity-api-keys/entity-api-keys.d.ts

@@ -5,7 +5,7 @@
  * REST API for invoice management, customer management, and accounting operations. Features include cursor-based pagination for efficient data navigation, flexible JSON querying with MongoDB-style operators, full-text search across multiple fields, and comprehensive metadata support for custom tracking.
  * OpenAPI spec version: 1.0.0
  */
-import type { CreateEntityApiKeyBody, DeleteEntityApiKey200, EntityApiKey, EntityApiKeysList, Error, ValidationError } from '../model/index.js';
+import type { CreateEntityApiKeyBody, CreateEntityApiKeyResponse, DeleteEntityApiKey200, EntityApiKeysList, Error, ValidationError } from '../model/index.js';
 /**
  * Retrieve all API keys for the current entity. Keys are masked for security.
  * @summary List entity API keys
@@ -48,7 +48,7 @@ export declare const listEntityApiKeys: (options?: RequestInit) => Promise<listE
  * @summary Create entity API key
  */
 export type createEntityApiKeyResponse201 = {
-    data: EntityApiKey;
+    data: CreateEntityApiKeyResponse;
     status: 201;
 };
 export type createEntityApiKeyResponse400 = {

package/dist/generated/model/createEntityApiKeyResponse.d.cts

@@ -0,0 +1,12 @@
+/**
+ * Generated by orval v8.5.3 🍺
+ * Do not edit manually.
+ * Space Invoices API
+ * REST API for invoice management, customer management, and accounting operations. Features include cursor-based pagination for efficient data navigation, flexible JSON querying with MongoDB-style operators, full-text search across multiple fields, and comprehensive metadata support for custom tracking.
+ * OpenAPI spec version: 1.0.0
+ */
+import type { EntityApiKey } from './entityApiKey.cjs';
+export type CreateEntityApiKeyResponse = EntityApiKey & {
+    /** The full bearer secret (ek_* prefix). Returned ONLY here, once, at creation time. It is never shown again - store it now. Use `id` (the handle) for all later GET/DELETE calls. */
+    key: string;
+};

package/dist/generated/model/createEntityApiKeyResponse.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Generated by orval v8.5.3 🍺
+ * Do not edit manually.
+ * Space Invoices API
+ * REST API for invoice management, customer management, and accounting operations. Features include cursor-based pagination for efficient data navigation, flexible JSON querying with MongoDB-style operators, full-text search across multiple fields, and comprehensive metadata support for custom tracking.
+ * OpenAPI spec version: 1.0.0
+ */
+import type { EntityApiKey } from './entityApiKey.js';
+export type CreateEntityApiKeyResponse = EntityApiKey & {
+    /** The full bearer secret (ek_* prefix). Returned ONLY here, once, at creation time. It is never shown again - store it now. Use `id` (the handle) for all later GET/DELETE calls. */
+    key: string;
+};

package/dist/generated/model/entityApiKey.d.cts

@@ -7,7 +7,7 @@
  */
 import type { EntityApiKeyEnvironment } from './entityApiKeyEnvironment.cjs';
 export interface EntityApiKey {
-    /** API key (ek_* prefix for entity-scoped keys) */
+    /** Stable, non-secret handle for this key (akh_* prefix). Use this to address the key in GET/DELETE calls. It is NOT the bearer credential and cannot be used to authenticate. */
     id: string;
     /** Entity ID this key is scoped to */
     entity_id: string;
@@ -18,6 +18,8 @@ export interface EntityApiKey {
     name: string | null;
     /** Environment the key is valid for */
     environment: EntityApiKeyEnvironment;
+    /** Masked version of the key for display */
+    prefix_hint: string;
     /** When the key was created */
     created_at: string;
     /**

package/dist/generated/model/entityApiKey.d.ts

@@ -7,7 +7,7 @@
  */
 import type { EntityApiKeyEnvironment } from './entityApiKeyEnvironment.js';
 export interface EntityApiKey {
-    /** API key (ek_* prefix for entity-scoped keys) */
+    /** Stable, non-secret handle for this key (akh_* prefix). Use this to address the key in GET/DELETE calls. It is NOT the bearer credential and cannot be used to authenticate. */
     id: string;
     /** Entity ID this key is scoped to */
     entity_id: string;
@@ -18,6 +18,8 @@ export interface EntityApiKey {
     name: string | null;
     /** Environment the key is valid for */
     environment: EntityApiKeyEnvironment;
+    /** Masked version of the key for display */
+    prefix_hint: string;
     /** When the key was created */
     created_at: string;
     /**

package/dist/generated/model/entityApiKeyListItem.d.cts

@@ -5,8 +5,26 @@
  * REST API for invoice management, customer management, and accounting operations. Features include cursor-based pagination for efficient data navigation, flexible JSON querying with MongoDB-style operators, full-text search across multiple fields, and comprehensive metadata support for custom tracking.
  * OpenAPI spec version: 1.0.0
  */
-import type { EntityApiKey } from './entityApiKey.cjs';
-export type EntityApiKeyListItem = EntityApiKey & {
+import type { EntityApiKeyListItemEnvironment } from './entityApiKeyListItemEnvironment.cjs';
+export interface EntityApiKeyListItem {
+    /** Stable, non-secret handle for this key (akh_* prefix). Use this to address the key in GET/DELETE calls. It is NOT the bearer credential and cannot be used to authenticate. */
+    id: string;
+    /** Entity ID this key is scoped to */
+    entity_id: string;
+    /**
+     * Friendly name for the API key
+     * @nullable
+     */
+    name: string | null;
+    /** Environment the key is valid for */
+    environment: EntityApiKeyListItemEnvironment;
     /** Masked version of the key for display */
     prefix_hint: string;
-};
+    /** When the key was created */
+    created_at: string;
+    /**
+     * When the key expires, or null if it never expires
+     * @nullable
+     */
+    expires_at: string | null;
+}

package/dist/generated/model/entityApiKeyListItem.d.ts

@@ -5,8 +5,26 @@
  * REST API for invoice management, customer management, and accounting operations. Features include cursor-based pagination for efficient data navigation, flexible JSON querying with MongoDB-style operators, full-text search across multiple fields, and comprehensive metadata support for custom tracking.
  * OpenAPI spec version: 1.0.0
  */
-import type { EntityApiKey } from './entityApiKey.js';
-export type EntityApiKeyListItem = EntityApiKey & {
+import type { EntityApiKeyListItemEnvironment } from './entityApiKeyListItemEnvironment.js';
+export interface EntityApiKeyListItem {
+    /** Stable, non-secret handle for this key (akh_* prefix). Use this to address the key in GET/DELETE calls. It is NOT the bearer credential and cannot be used to authenticate. */
+    id: string;
+    /** Entity ID this key is scoped to */
+    entity_id: string;
+    /**
+     * Friendly name for the API key
+     * @nullable
+     */
+    name: string | null;
+    /** Environment the key is valid for */
+    environment: EntityApiKeyListItemEnvironment;
     /** Masked version of the key for display */
     prefix_hint: string;
-};
+    /** When the key was created */
+    created_at: string;
+    /**
+     * When the key expires, or null if it never expires
+     * @nullable
+     */
+    expires_at: string | null;
+}

package/dist/generated/model/entityApiKeyListItemEnvironment.d.cts

@@ -0,0 +1,15 @@
+/**
+ * Generated by orval v8.5.3 🍺
+ * Do not edit manually.
+ * Space Invoices API
+ * REST API for invoice management, customer management, and accounting operations. Features include cursor-based pagination for efficient data navigation, flexible JSON querying with MongoDB-style operators, full-text search across multiple fields, and comprehensive metadata support for custom tracking.
+ * OpenAPI spec version: 1.0.0
+ */
+/**
+ * Environment the key is valid for
+ */
+export type EntityApiKeyListItemEnvironment = typeof EntityApiKeyListItemEnvironment[keyof typeof EntityApiKeyListItemEnvironment];
+export declare const EntityApiKeyListItemEnvironment: {
+    readonly live: "live";
+    readonly sandbox: "sandbox";
+};

package/dist/generated/model/entityApiKeyListItemEnvironment.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Generated by orval v8.5.3 🍺
+ * Do not edit manually.
+ * Space Invoices API
+ * REST API for invoice management, customer management, and accounting operations. Features include cursor-based pagination for efficient data navigation, flexible JSON querying with MongoDB-style operators, full-text search across multiple fields, and comprehensive metadata support for custom tracking.
+ * OpenAPI spec version: 1.0.0
+ */
+/**
+ * Environment the key is valid for
+ */
+export type EntityApiKeyListItemEnvironment = typeof EntityApiKeyListItemEnvironment[keyof typeof EntityApiKeyListItemEnvironment];
+export declare const EntityApiKeyListItemEnvironment: {
+    readonly live: "live";
+    readonly sandbox: "sandbox";
+};

package/dist/generated/model/getActivities200DataItem.d.cts

@@ -12,7 +12,7 @@ export type GetActivities200DataItem = {
     id: string;
     /** Entity that owns this activity */
     entity_id: string;
-    /** Type of resource (e.g., Invoice, Customer, Payment) */
+    /** Type of resource (e.g., invoice, customer, payment) */
     resource_type: string;
     /** ID of the resource */
     resource_id: string;

package/dist/generated/model/getActivities200DataItem.d.ts

@@ -12,7 +12,7 @@ export type GetActivities200DataItem = {
     id: string;
     /** Entity that owns this activity */
     entity_id: string;
-    /** Type of resource (e.g., Invoice, Customer, Payment) */
+    /** Type of resource (e.g., invoice, customer, payment) */
     resource_type: string;
     /** ID of the resource */
     resource_id: string;

package/dist/generated/model/getActivitiesParams.d.cts

@@ -57,7 +57,7 @@ export type GetActivitiesParams = {
      */
     query?: string;
     /**
-     * Filter by resource type (e.g., Invoice, Customer, Payment)
+     * Filter by resource type (e.g., invoice, customer, payment). During the transition to the current naming, legacy historical values (e.g. Invoice, Payment) are also accepted and return the same results as the current value.
      */
     resource_type?: string;
     /**
@@ -65,7 +65,7 @@ export type GetActivitiesParams = {
      */
     resource_id?: string;
     /**
-     * Include Payment activities linked to resource_id within the current entity. Other filters still apply. Defaults to false; has no effect without resource_id.
+     * Include payment activities linked to resource_id within the current entity. Other filters still apply. Defaults to false; has no effect without resource_id.
      */
     include_related_payments?: boolean;
     /**

package/dist/generated/model/getActivitiesParams.d.ts

@@ -57,7 +57,7 @@ export type GetActivitiesParams = {
      */
     query?: string;
     /**
-     * Filter by resource type (e.g., Invoice, Customer, Payment)
+     * Filter by resource type (e.g., invoice, customer, payment). During the transition to the current naming, legacy historical values (e.g. Invoice, Payment) are also accepted and return the same results as the current value.
      */
     resource_type?: string;
     /**
@@ -65,7 +65,7 @@ export type GetActivitiesParams = {
      */
     resource_id?: string;
     /**
-     * Include Payment activities linked to resource_id within the current entity. Other filters still apply. Defaults to false; has no effect without resource_id.
+     * Include payment activities linked to resource_id within the current entity. Other filters still apply. Defaults to false; has no effect without resource_id.
      */
     include_related_payments?: boolean;
     /**

package/dist/generated/model/index.d.cts

@@ -147,6 +147,7 @@ export * from './createdUserMetadata.cjs';
 export * from './createdUserSettings.cjs';
 export * from './createEInvoicingEnrollmentAuthorizationRequest.cjs';
 export * from './createEntityApiKeyBody.cjs';
+export * from './createEntityApiKeyResponse.cjs';
 export * from './createEntityBody.cjs';
 export * from './createEntityBodyEnvironment.cjs';
 export * from './createEntityBodyMetadata.cjs';
@@ -421,6 +422,7 @@ export * from './entity.cjs';
 export * from './entityApiKey.cjs';
 export * from './entityApiKeyEnvironment.cjs';
 export * from './entityApiKeyListItem.cjs';
+export * from './entityApiKeyListItemEnvironment.cjs';
 export * from './entityApiKeysList.cjs';
 export * from './entityBankAccount.cjs';
 export * from './entityBankAccountType.cjs';

package/dist/generated/model/index.d.ts

@@ -147,6 +147,7 @@ export * from './createdUserMetadata.js';
 export * from './createdUserSettings.js';
 export * from './createEInvoicingEnrollmentAuthorizationRequest.js';
 export * from './createEntityApiKeyBody.js';
+export * from './createEntityApiKeyResponse.js';
 export * from './createEntityBody.js';
 export * from './createEntityBodyEnvironment.js';
 export * from './createEntityBodyMetadata.js';
@@ -421,6 +422,7 @@ export * from './entity.js';
 export * from './entityApiKey.js';
 export * from './entityApiKeyEnvironment.js';
 export * from './entityApiKeyListItem.js';
+export * from './entityApiKeyListItemEnvironment.js';
 export * from './entityApiKeysList.js';
 export * from './entityBankAccount.js';
 export * from './entityBankAccountType.js';

package/dist/generated-zod/activities/activities.d.cts

@@ -7,7 +7,7 @@
  */
 import * as zod from "zod";
 /**
- * Retrieve a paginated list of activities for the entity. Supports filtering by resource_type, resource_id, and action. Set include_related_payments=true with resource_id to include historical Payment events linked through invoice_id, credit_note_id, or advance_invoice_id. Other filters still apply. Omitted, null, or false retains exact resource filtering; without resource_id the flag has no effect. Activities are ordered by ID descending by default.
+ * Retrieve a paginated list of activities for the entity. Supports filtering by resource_type, resource_id, and action. Set include_related_payments=true with resource_id to include historical payment events linked through invoice_id, credit_note_id, or advance_invoice_id. Other filters still apply. Omitted, null, or false retains exact resource filtering; without resource_id the flag has no effect. Activities are ordered by ID descending by default.
  * @summary List activities
  */
 export declare const getActivitiesQueryLimitDefault = 10;

package/dist/generated-zod/activities/activities.d.ts

@@ -7,7 +7,7 @@
  */
 import * as zod from "zod";
 /**
- * Retrieve a paginated list of activities for the entity. Supports filtering by resource_type, resource_id, and action. Set include_related_payments=true with resource_id to include historical Payment events linked through invoice_id, credit_note_id, or advance_invoice_id. Other filters still apply. Omitted, null, or false retains exact resource filtering; without resource_id the flag has no effect. Activities are ordered by ID descending by default.
+ * Retrieve a paginated list of activities for the entity. Supports filtering by resource_type, resource_id, and action. Set include_related_payments=true with resource_id to include historical payment events linked through invoice_id, credit_note_id, or advance_invoice_id. Other filters still apply. Omitted, null, or false retains exact resource filtering; without resource_id the flag has no effect. Activities are ordered by ID descending by default.
  * @summary List activities
  */
 export declare const getActivitiesQueryLimitDefault = 10;

package/dist/generated-zod/entity-api-keys/entity-api-keys.d.cts

@@ -14,7 +14,7 @@ export declare const ListEntityApiKeysHeader: zod.ZodObject<{
     "x-entity-id": zod.ZodOptional<zod.ZodString>;
 }, zod.z.core.$strip>;
 export declare const ListEntityApiKeysResponse: zod.ZodObject<{
-    data: zod.ZodArray<zod.ZodIntersection<zod.ZodObject<{
+    data: zod.ZodArray<zod.ZodObject<{
         id: zod.ZodString;
         entity_id: zod.ZodString;
         name: zod.ZodNullable<zod.ZodString>;
@@ -22,11 +22,10 @@ export declare const ListEntityApiKeysResponse: zod.ZodObject<{
             live: "live";
             sandbox: "sandbox";
         }>;
+        prefix_hint: zod.ZodString;
         created_at: zod.z.ZodISODateTime;
         expires_at: zod.ZodNullable<zod.z.ZodISODateTime>;
-    }, zod.z.core.$strip>, zod.ZodObject<{
-        prefix_hint: zod.ZodString;
-    }, zod.z.core.$strip>>>;
+    }, zod.z.core.$strip>>;
 }, zod.z.core.$strip>;
 /**
  * Create a new entity-scoped API key (ek_* prefix). This key can only access this specific entity.

package/dist/generated-zod/entity-api-keys/entity-api-keys.d.ts

@@ -14,7 +14,7 @@ export declare const ListEntityApiKeysHeader: zod.ZodObject<{
     "x-entity-id": zod.ZodOptional<zod.ZodString>;
 }, zod.z.core.$strip>;
 export declare const ListEntityApiKeysResponse: zod.ZodObject<{
-    data: zod.ZodArray<zod.ZodIntersection<zod.ZodObject<{
+    data: zod.ZodArray<zod.ZodObject<{
         id: zod.ZodString;
         entity_id: zod.ZodString;
         name: zod.ZodNullable<zod.ZodString>;
@@ -22,11 +22,10 @@ export declare const ListEntityApiKeysResponse: zod.ZodObject<{
             live: "live";
             sandbox: "sandbox";
         }>;
+        prefix_hint: zod.ZodString;
         created_at: zod.z.ZodISODateTime;
         expires_at: zod.ZodNullable<zod.z.ZodISODateTime>;
-    }, zod.z.core.$strip>, zod.ZodObject<{
-        prefix_hint: zod.ZodString;
-    }, zod.z.core.$strip>>>;
+    }, zod.z.core.$strip>>;
 }, zod.z.core.$strip>;
 /**
  * Create a new entity-scoped API key (ek_* prefix). This key can only access this specific entity.