@pidgeon-ai/sdk 1.33.0 → 1.34.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.
package/dist/index.d.cts CHANGED
@@ -437,6 +437,10 @@ type Identity = {
437
437
  * The pod this address is in. Every workspace has one to start with and every address is in one, so this is never null.
438
438
  */
439
439
  pod_id: string;
440
+ /**
441
+ * A test address, made by a test key: it counts against no plan, takes only test mail (a test send or `POST /test/inbound`), and is deleted a day after it was made.
442
+ */
443
+ test: boolean;
440
444
  };
441
445
  type Message = {
442
446
  id: string;
@@ -1913,6 +1917,10 @@ type PodCreated = {
1913
1917
  * The pod this address is in. Every workspace has one to start with and every address is in one, so this is never null.
1914
1918
  */
1915
1919
  pod_id: string;
1920
+ /**
1921
+ * A test address, made by a test key: it counts against no plan, takes only test mail (a test send or `POST /test/inbound`), and is deleted a day after it was made.
1922
+ */
1923
+ test: boolean;
1916
1924
  } | null;
1917
1925
  /**
1918
1926
  * A pod key for it, or null when the call asked for none.
@@ -9052,6 +9060,8 @@ declare const identitiesList: <ThrowOnError extends boolean = false>(options?: O
9052
9060
  * Create an address
9053
9061
  *
9054
9062
  * Idempotent with an `Idempotency-Key` header: the same key returns the first result rather than creating a second address.
9063
+ *
9064
+ * Needs a key with admin over the account, or over its pod. A **test key** creates a test address (`test: true`): outside your plan’s counts, at most 100 at once, taking only test mail, and deleted a day after it was made.
9055
9065
  */
9056
9066
  declare const identitiesCreate: <ThrowOnError extends boolean = false>(options: Options<IdentitiesCreateData, ThrowOnError>) => RequestResult<IdentitiesCreateResponses, IdentitiesCreateErrors, ThrowOnError>;
9057
9067
  /**
package/dist/index.d.ts CHANGED
@@ -437,6 +437,10 @@ type Identity = {
437
437
  * The pod this address is in. Every workspace has one to start with and every address is in one, so this is never null.
438
438
  */
439
439
  pod_id: string;
440
+ /**
441
+ * A test address, made by a test key: it counts against no plan, takes only test mail (a test send or `POST /test/inbound`), and is deleted a day after it was made.
442
+ */
443
+ test: boolean;
440
444
  };
441
445
  type Message = {
442
446
  id: string;
@@ -1913,6 +1917,10 @@ type PodCreated = {
1913
1917
  * The pod this address is in. Every workspace has one to start with and every address is in one, so this is never null.
1914
1918
  */
1915
1919
  pod_id: string;
1920
+ /**
1921
+ * A test address, made by a test key: it counts against no plan, takes only test mail (a test send or `POST /test/inbound`), and is deleted a day after it was made.
1922
+ */
1923
+ test: boolean;
1916
1924
  } | null;
1917
1925
  /**
1918
1926
  * A pod key for it, or null when the call asked for none.
@@ -9052,6 +9060,8 @@ declare const identitiesList: <ThrowOnError extends boolean = false>(options?: O
9052
9060
  * Create an address
9053
9061
  *
9054
9062
  * Idempotent with an `Idempotency-Key` header: the same key returns the first result rather than creating a second address.
9063
+ *
9064
+ * Needs a key with admin over the account, or over its pod. A **test key** creates a test address (`test: true`): outside your plan’s counts, at most 100 at once, taking only test mail, and deleted a day after it was made.
9055
9065
  */
9056
9066
  declare const identitiesCreate: <ThrowOnError extends boolean = false>(options: Options<IdentitiesCreateData, ThrowOnError>) => RequestResult<IdentitiesCreateResponses, IdentitiesCreateErrors, ThrowOnError>;
9057
9067
  /**