@zavudev/sdk 0.6.0 → 0.8.0

package/src/resources/contacts.ts

@@ -2,6 +2,7 @@
 
 import { APIResource } from '../core/resource';
 import { APIPromise } from '../core/api-promise';
+import { Cursor, type CursorParams, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
@@ -26,8 +27,8 @@ export class Contacts extends APIResource {
   list(
     query: ContactListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<ContactListResponse> {
-    return this._client.get('/v1/contacts', { query, ...options });
+  ): PagePromise<ContactsCursor, Contact> {
+    return this._client.getAPIList('/v1/contacts', Cursor<Contact>, { query, ...options });
   }
 
   /**
@@ -38,6 +39,8 @@ export class Contacts extends APIResource {
   }
 }
 
+export type ContactsCursor = Cursor<Contact>;
+
 export interface Contact {
   id: string;
 
@@ -70,12 +73,6 @@ export interface Contact {
   verified?: boolean;
 }
 
-export interface ContactListResponse {
-  items: Array<Contact>;
-
-  nextCursor?: string | null;
-}
-
 export interface ContactUpdateParams {
   /**
    * Preferred channel for this contact. Set to null to clear.
@@ -85,18 +82,14 @@ export interface ContactUpdateParams {
   metadata?: { [key: string]: string };
 }
 
-export interface ContactListParams {
-  cursor?: string;
-
-  limit?: number;
-
+export interface ContactListParams extends CursorParams {
   phoneNumber?: string;
 }
 
 export declare namespace Contacts {
   export {
     type Contact as Contact,
-    type ContactListResponse as ContactListResponse,
+    type ContactsCursor as ContactsCursor,
     type ContactUpdateParams as ContactUpdateParams,
     type ContactListParams as ContactListParams,
   };

package/src/resources/index.ts

@@ -1,11 +1,33 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
+export {
+  Broadcasts,
+  type Broadcast,
+  type BroadcastChannel,
+  type BroadcastContact,
+  type BroadcastContactStatus,
+  type BroadcastContent,
+  type BroadcastMessageType,
+  type BroadcastProgress,
+  type BroadcastStatus,
+  type BroadcastCreateResponse,
+  type BroadcastRetrieveResponse,
+  type BroadcastUpdateResponse,
+  type BroadcastCancelResponse,
+  type BroadcastSendResponse,
+  type BroadcastCreateParams,
+  type BroadcastUpdateParams,
+  type BroadcastListParams,
+  type BroadcastSendParams,
+  type BroadcastContactsCursor,
+  type BroadcastsCursor,
+} from './broadcasts/broadcasts';
 export {
   Contacts,
   type Contact,
-  type ContactListResponse,
   type ContactUpdateParams,
   type ContactListParams,
+  type ContactsCursor,
 } from './contacts';
 export {
   Introspect,
@@ -21,24 +43,24 @@ export {
   type MessageResponse,
   type MessageStatus,
   type MessageType,
-  type MessageListResponse,
   type MessageListParams,
   type MessageReactParams,
   type MessageSendParams,
+  type MessagesCursor,
 } from './messages';
 export {
   Senders,
   type Sender,
-  type SenderListResponse,
   type SenderCreateParams,
   type SenderUpdateParams,
   type SenderListParams,
+  type SendersCursor,
 } from './senders';
 export {
   Templates,
   type Template,
   type WhatsappCategory,
-  type TemplateListResponse,
   type TemplateCreateParams,
   type TemplateListParams,
+  type TemplatesCursor,
 } from './templates';

package/src/resources/messages.ts

@@ -2,6 +2,7 @@
 
 import { APIResource } from '../core/resource';
 import { APIPromise } from '../core/api-promise';
+import { Cursor, type CursorParams, PagePromise } from '../core/pagination';
 import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
@@ -26,14 +27,17 @@ export class Messages extends APIResource {
    *
    * @example
    * ```ts
-   * const messages = await client.messages.list();
+   * // Automatically fetches more pages as needed.
+   * for await (const message of client.messages.list()) {
+   *   // ...
+   * }
    * ```
    */
   list(
     query: MessageListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<MessageListResponse> {
-    return this._client.get('/v1/messages', { query, ...options });
+  ): PagePromise<MessagesCursor, Message> {
+    return this._client.getAPIList('/v1/messages', Cursor<Message>, { query, ...options });
   }
 
   /**
@@ -99,6 +103,8 @@ export class Messages extends APIResource {
   }
 }
 
+export type MessagesCursor = Cursor<Message>;
+
 /**
  * Delivery channel. Use 'auto' for intelligent routing.
  */
@@ -304,22 +310,12 @@ export type MessageType =
   | 'reaction'
   | 'template';
 
-export interface MessageListResponse {
-  items: Array<Message>;
-
-  nextCursor?: string | null;
-}
-
-export interface MessageListParams {
+export interface MessageListParams extends CursorParams {
   /**
    * Delivery channel. Use 'auto' for intelligent routing.
    */
   channel?: Channel;
 
-  cursor?: string;
-
-  limit?: number;
-
   status?: MessageStatus;
 
   to?: string;
@@ -408,7 +404,7 @@ export declare namespace Messages {
     type MessageResponse as MessageResponse,
     type MessageStatus as MessageStatus,
     type MessageType as MessageType,
-    type MessageListResponse as MessageListResponse,
+    type MessagesCursor as MessagesCursor,
     type MessageListParams as MessageListParams,
     type MessageReactParams as MessageReactParams,
     type MessageSendParams as MessageSendParams,

package/src/resources/senders.ts

@@ -2,6 +2,7 @@
 
 import { APIResource } from '../core/resource';
 import { APIPromise } from '../core/api-promise';
+import { Cursor, type CursorParams, PagePromise } from '../core/pagination';
 import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
@@ -34,8 +35,8 @@ export class Senders extends APIResource {
   list(
     query: SenderListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<SenderListResponse> {
-    return this._client.get('/v1/senders', { query, ...options });
+  ): PagePromise<SendersCursor, Sender> {
+    return this._client.getAPIList('/v1/senders', Cursor<Sender>, { query, ...options });
   }
 
   /**
@@ -49,6 +50,8 @@ export class Senders extends APIResource {
   }
 }
 
+export type SendersCursor = Cursor<Sender>;
+
 export interface Sender {
   id: string;
 
@@ -69,12 +72,6 @@ export interface Sender {
   updatedAt?: string;
 }
 
-export interface SenderListResponse {
-  items: Array<Sender>;
-
-  nextCursor?: string | null;
-}
-
 export interface SenderCreateParams {
   name: string;
 
@@ -89,16 +86,12 @@ export interface SenderUpdateParams {
   setAsDefault?: boolean;
 }
 
-export interface SenderListParams {
-  cursor?: string;
-
-  limit?: number;
-}
+export interface SenderListParams extends CursorParams {}
 
 export declare namespace Senders {
   export {
     type Sender as Sender,
-    type SenderListResponse as SenderListResponse,
+    type SendersCursor as SendersCursor,
     type SenderCreateParams as SenderCreateParams,
     type SenderUpdateParams as SenderUpdateParams,
     type SenderListParams as SenderListParams,

package/src/resources/templates.ts

@@ -2,6 +2,7 @@
 
 import { APIResource } from '../core/resource';
 import { APIPromise } from '../core/api-promise';
+import { Cursor, type CursorParams, PagePromise } from '../core/pagination';
 import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
@@ -45,14 +46,17 @@ export class Templates extends APIResource {
    *
    * @example
    * ```ts
-   * const templates = await client.templates.list();
+   * // Automatically fetches more pages as needed.
+   * for await (const template of client.templates.list()) {
+   *   // ...
+   * }
    * ```
    */
   list(
     query: TemplateListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<TemplateListResponse> {
-    return this._client.get('/v1/templates', { query, ...options });
+  ): PagePromise<TemplatesCursor, Template> {
+    return this._client.getAPIList('/v1/templates', Cursor<Template>, { query, ...options });
   }
 
   /**
@@ -71,6 +75,8 @@ export class Templates extends APIResource {
   }
 }
 
+export type TemplatesCursor = Cursor<Template>;
+
 export interface Template {
   id: string;
 
@@ -168,12 +174,6 @@ export namespace Template {
  */
 export type WhatsappCategory = 'UTILITY' | 'MARKETING' | 'AUTHENTICATION';
 
-export interface TemplateListResponse {
-  items: Array<Template>;
-
-  nextCursor?: string | null;
-}
-
 export interface TemplateCreateParams {
   body: string;
 
@@ -189,17 +189,13 @@ export interface TemplateCreateParams {
   whatsappCategory?: WhatsappCategory;
 }
 
-export interface TemplateListParams {
-  cursor?: string;
-
-  limit?: number;
-}
+export interface TemplateListParams extends CursorParams {}
 
 export declare namespace Templates {
   export {
     type Template as Template,
     type WhatsappCategory as WhatsappCategory,
-    type TemplateListResponse as TemplateListResponse,
+    type TemplatesCursor as TemplatesCursor,
     type TemplateCreateParams as TemplateCreateParams,
     type TemplateListParams as TemplateListParams,
   };

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.6.0'; // x-release-please-version
+export const VERSION = '0.8.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.6.0";
+export declare const VERSION = "0.8.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.6.0";
+export declare const VERSION = "0.8.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.6.0'; // x-release-please-version
+exports.VERSION = '0.8.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.6.0'; // x-release-please-version
+export const VERSION = '0.8.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map