dub 0.45.7 → 0.46.0

package/src/models/operations/listevents.ts

@@ -104,10 +104,6 @@ export type ListEventsRequest = {
    * The IANA time zone code for aligning timeseries granularity (e.g. America/New_York). Defaults to UTC.
    */
   timezone?: string | undefined;
-  /**
-   * The continent to retrieve analytics for.
-   */
-  continent?: components.ContinentCode | undefined;
   /**
    * The country to retrieve analytics for.
    */
@@ -116,6 +112,14 @@ export type ListEventsRequest = {
    * The city to retrieve analytics for.
    */
   city?: string | undefined;
+  /**
+   * The ISO 3166-2 region code to retrieve analytics for.
+   */
+  region?: string | undefined;
+  /**
+   * The continent to retrieve analytics for.
+   */
+  continent?: components.ContinentCode | undefined;
   /**
    * The device to retrieve analytics for.
    */
@@ -339,9 +343,10 @@ export const ListEventsRequest$inboundSchema: z.ZodType<
   start: z.string().optional(),
   end: z.string().optional(),
   timezone: z.string().default("UTC"),
-  continent: components.ContinentCode$inboundSchema.optional(),
   country: components.CountryCode$inboundSchema.optional(),
   city: z.string().optional(),
+  region: z.string().optional(),
+  continent: components.ContinentCode$inboundSchema.optional(),
   device: z.string().optional(),
   browser: z.string().optional(),
   os: z.string().optional(),
@@ -370,9 +375,10 @@ export type ListEventsRequest$Outbound = {
   start?: string | undefined;
   end?: string | undefined;
   timezone: string;
-  continent?: string | undefined;
   country?: string | undefined;
   city?: string | undefined;
+  region?: string | undefined;
+  continent?: string | undefined;
   device?: string | undefined;
   browser?: string | undefined;
   os?: string | undefined;
@@ -405,9 +411,10 @@ export const ListEventsRequest$outboundSchema: z.ZodType<
   start: z.string().optional(),
   end: z.string().optional(),
   timezone: z.string().default("UTC"),
-  continent: components.ContinentCode$outboundSchema.optional(),
   country: components.CountryCode$outboundSchema.optional(),
   city: z.string().optional(),
+  region: z.string().optional(),
+  continent: components.ContinentCode$outboundSchema.optional(),
   device: z.string().optional(),
   browser: z.string().optional(),
   os: z.string().optional(),

package/src/models/operations/retrieveanalytics.ts

@@ -30,6 +30,7 @@ export const QueryParamGroupBy = {
   Count: "count",
   Timeseries: "timeseries",
   Continents: "continents",
+  Regions: "regions",
   Countries: "countries",
   Cities: "cities",
   Devices: "devices",
@@ -123,10 +124,6 @@ export type RetrieveAnalyticsRequest = {
    * The IANA time zone code for aligning timeseries granularity (e.g. America/New_York). Defaults to UTC.
    */
   timezone?: string | undefined;
-  /**
-   * The continent to retrieve analytics for.
-   */
-  continent?: components.ContinentCode | undefined;
   /**
    * The country to retrieve analytics for.
    */
@@ -135,6 +132,14 @@ export type RetrieveAnalyticsRequest = {
    * The city to retrieve analytics for.
    */
   city?: string | undefined;
+  /**
+   * The ISO 3166-2 region code to retrieve analytics for.
+   */
+  region?: string | undefined;
+  /**
+   * The continent to retrieve analytics for.
+   */
+  continent?: components.ContinentCode | undefined;
   /**
    * The device to retrieve analytics for.
    */
@@ -345,9 +350,10 @@ export const RetrieveAnalyticsRequest$inboundSchema: z.ZodType<
   start: z.string().optional(),
   end: z.string().optional(),
   timezone: z.string().default("UTC"),
-  continent: components.ContinentCode$inboundSchema.optional(),
   country: components.CountryCode$inboundSchema.optional(),
   city: z.string().optional(),
+  region: z.string().optional(),
+  continent: components.ContinentCode$inboundSchema.optional(),
   device: z.string().optional(),
   browser: z.string().optional(),
   os: z.string().optional(),
@@ -373,9 +379,10 @@ export type RetrieveAnalyticsRequest$Outbound = {
   start?: string | undefined;
   end?: string | undefined;
   timezone: string;
-  continent?: string | undefined;
   country?: string | undefined;
   city?: string | undefined;
+  region?: string | undefined;
+  continent?: string | undefined;
   device?: string | undefined;
   browser?: string | undefined;
   os?: string | undefined;
@@ -405,9 +412,10 @@ export const RetrieveAnalyticsRequest$outboundSchema: z.ZodType<
   start: z.string().optional(),
   end: z.string().optional(),
   timezone: z.string().default("UTC"),
-  continent: components.ContinentCode$outboundSchema.optional(),
   country: components.CountryCode$outboundSchema.optional(),
   city: z.string().optional(),
+  region: z.string().optional(),
+  continent: components.ContinentCode$outboundSchema.optional(),
   device: z.string().optional(),
   browser: z.string().optional(),
   os: z.string().optional(),

package/src/sdk/domains.ts

@@ -39,7 +39,7 @@ export class Domains extends ClientSDK {
   async list(
     request?: operations.ListDomainsRequest | undefined,
     options?: RequestOptions,
-  ): Promise<PageIterator<operations.ListDomainsResponse>> {
+  ): Promise<PageIterator<operations.ListDomainsResponse, { page: number }>> {
     return unwrapResultIterator(domainsList(
       this,
       request,

package/src/sdk/links.ts

@@ -45,7 +45,7 @@ export class Links extends ClientSDK {
   async list(
     request?: operations.GetLinksRequest | undefined,
     options?: RequestOptions,
-  ): Promise<PageIterator<operations.GetLinksResponse>> {
+  ): Promise<PageIterator<operations.GetLinksResponse, { page: number }>> {
     return unwrapResultIterator(linksList(
       this,
       request,

package/src/types/operations.ts

@@ -6,9 +6,10 @@ import { Result } from "./fp.js";
 
 export type Paginator<V> = () => Promise<V & { next: Paginator<V> }> | null;
 
-export type PageIterator<V> = V & {
+export type PageIterator<V, PageState = unknown> = V & {
   next: Paginator<V>;
   [Symbol.asyncIterator]: () => AsyncIterableIterator<V>;
+  "~next"?: PageState | undefined;
 };
 
 export function createPageIterator<V>(
@@ -40,7 +41,9 @@ export function createPageIterator<V>(
  * terminates. It is useful in paginated SDK functions that have early return
  * paths when things go wrong.
  */
-export function haltIterator<V extends object>(v: V): PageIterator<V> {
+export function haltIterator<V extends object>(
+  v: V,
+): PageIterator<V, undefined> {
   return {
     ...v,
     next: () => null,
@@ -54,9 +57,9 @@ export function haltIterator<V extends object>(v: V): PageIterator<V> {
  * Converts an async iterator of `Result<V, E>` into an async iterator of `V`.
  * When error results occur, the underlying error value is thrown.
  */
-export async function unwrapResultIterator<V>(
-  iteratorPromise: Promise<PageIterator<Result<V, unknown>>>,
-): Promise<PageIterator<V>> {
+export async function unwrapResultIterator<V, PageState>(
+  iteratorPromise: Promise<PageIterator<Result<V, unknown>, PageState>>,
+): Promise<PageIterator<V, PageState>> {
   const resultIter = await iteratorPromise;
 
   if (!resultIter.ok) {
@@ -66,6 +69,7 @@ export async function unwrapResultIterator<V>(
   return {
     ...resultIter.value,
     next: unwrapPaginator(resultIter.next),
+    "~next": resultIter["~next"],
     [Symbol.asyncIterator]: async function* paginator() {
       for await (const page of resultIter) {
         if (!page.ok) {
@@ -97,3 +101,5 @@ function unwrapPaginator<V>(
     });
   };
 }
+
+export const URL_OVERRIDE = Symbol("URL_OVERRIDE");