feat(api): manual updates

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 12
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/sent%2Fsent-dm-a02f66b4c3837ff1b6d38b924856b9afad2b3bfbc3152c1b4dfbe1ee895008a5.yml
 openapi_spec_hash: 30e666a2b17c0768213eaa74e0aec11b
-config_hash: ef54ea47c53cc13e90f7867076693e83
+config_hash: 804a43c36c8e58c8d0ff2e57dd6545ec

README.md

@@ -22,7 +22,10 @@ The full API of this library can be found in [api.md](api.md).
 ```js
 import SentDm from '@sentdm/sentdm';
 
-const client = new SentDm();
+const client = new SentDm({
+  apiKey: process.env['SENT_DM_API_KEY'], // This is the default and can be omitted
+  senderID: process.env['SENT_DM_SENDER_ID'], // This is the default and can be omitted
+});
 
 await client.messages.sendToPhone({
   phoneNumber: '+1234567890',
@@ -39,7 +42,10 @@ This library includes TypeScript definitions for all request params and response
 ```ts
 import SentDm from '@sentdm/sentdm';
 
-const client = new SentDm();
+const client = new SentDm({
+  apiKey: process.env['SENT_DM_API_KEY'], // This is the default and can be omitted
+  senderID: process.env['SENT_DM_SENDER_ID'], // This is the default and can be omitted
+});
 
 const params: SentDm.MessageSendToPhoneParams = {
   phoneNumber: '+1234567890',

api.md

@@ -1,20 +1,3 @@
-# Templates
-
-Types:
-
-- <code><a href="./src/resources/templates.ts">TemplateBodyContent</a></code>
-- <code><a href="./src/resources/templates.ts">TemplateDefinition</a></code>
-- <code><a href="./src/resources/templates.ts">TemplateResponse</a></code>
-- <code><a href="./src/resources/templates.ts">TemplateVariable</a></code>
-- <code><a href="./src/resources/templates.ts">TemplateListResponse</a></code>
-
-Methods:
-
-- <code title="post /v2/templates">client.templates.<a href="./src/resources/templates.ts">create</a>({ ...params }) -> TemplateResponse</code>
-- <code title="get /v2/templates/{id}">client.templates.<a href="./src/resources/templates.ts">retrieve</a>(id) -> TemplateResponse</code>
-- <code title="get /v2/templates">client.templates.<a href="./src/resources/templates.ts">list</a>({ ...params }) -> TemplateListResponse</code>
-- <code title="delete /v2/templates/{id}">client.templates.<a href="./src/resources/templates.ts">delete</a>(id) -> void</code>
-
 # Contacts
 
 Types:
@@ -41,6 +24,23 @@ Methods:
 - <code title="post /v2/messages/contact">client.messages.<a href="./src/resources/messages.ts">sendToContact</a>({ ...params }) -> void</code>
 - <code title="post /v2/messages/phone">client.messages.<a href="./src/resources/messages.ts">sendToPhone</a>({ ...params }) -> void</code>
 
+# Templates
+
+Types:
+
+- <code><a href="./src/resources/templates.ts">TemplateBodyContent</a></code>
+- <code><a href="./src/resources/templates.ts">TemplateDefinition</a></code>
+- <code><a href="./src/resources/templates.ts">TemplateResponseV2</a></code>
+- <code><a href="./src/resources/templates.ts">TemplateVariable</a></code>
+- <code><a href="./src/resources/templates.ts">TemplateListResponse</a></code>
+
+Methods:
+
+- <code title="post /v2/templates">client.templates.<a href="./src/resources/templates.ts">create</a>({ ...params }) -> TemplateResponseV2</code>
+- <code title="get /v2/templates/{id}">client.templates.<a href="./src/resources/templates.ts">retrieve</a>(id) -> TemplateResponseV2</code>
+- <code title="get /v2/templates">client.templates.<a href="./src/resources/templates.ts">list</a>({ ...params }) -> TemplateListResponse</code>
+- <code title="delete /v2/templates/{id}">client.templates.<a href="./src/resources/templates.ts">delete</a>(id) -> void</code>
+
 # NumberLookup
 
 Types:
@@ -50,7 +50,3 @@ Types:
 Methods:
 
 - <code title="get /v2/number-lookup">client.numberLookup.<a href="./src/resources/number-lookup.ts">retrieve</a>({ ...params }) -> NumberLookupRetrieveResponse</code>
-
-# Organizations
-
-## Users

src/client.ts

@@ -42,11 +42,10 @@ import {
   TemplateDefinition,
   TemplateListParams,
   TemplateListResponse,
-  TemplateResponse,
+  TemplateResponseV2,
   TemplateVariable,
   Templates,
 } from './resources/templates';
-import { Organizations } from './resources/organizations/organizations';
 import { type Fetch } from './internal/builtin-types';
 import { HeadersLike, NullableHeaders, buildHeaders } from './internal/headers';
 import { FinalRequestOptions, RequestOptions } from './internal/request-options';
@@ -62,12 +61,12 @@ import { isEmptyObj } from './internal/utils/values';
 
 export interface ClientOptions {
   /**
-   * Customer API key for authentication
+   * Customer API key for authentication. Use `sk_live_*` keys for production and `sk_test_*` keys for sandbox/testing. Pass via the `x-api-key` header.
    */
   apiKey?: string | undefined;
 
   /**
-   * Customer sender ID (GUID) identifying the customer account
+   * Customer sender ID (UUID) identifying the customer account. Obtain this from your account settings. Pass via the `x-sender-id` header.
    */
   senderID?: string | undefined;
 
@@ -775,33 +774,20 @@ export class SentDm {
 
   static toFile = Uploads.toFile;
 
-  templates: API.Templates = new API.Templates(this);
   contacts: API.Contacts = new API.Contacts(this);
   messages: API.Messages = new API.Messages(this);
+  templates: API.Templates = new API.Templates(this);
   numberLookup: API.NumberLookup = new API.NumberLookup(this);
-  organizations: API.Organizations = new API.Organizations(this);
 }
 
-SentDm.Templates = Templates;
 SentDm.Contacts = Contacts;
 SentDm.Messages = Messages;
+SentDm.Templates = Templates;
 SentDm.NumberLookup = NumberLookup;
-SentDm.Organizations = Organizations;
 
 export declare namespace SentDm {
   export type RequestOptions = Opts.RequestOptions;
 
-  export {
-    Templates as Templates,
-    type TemplateBodyContent as TemplateBodyContent,
-    type TemplateDefinition as TemplateDefinition,
-    type TemplateResponse as TemplateResponse,
-    type TemplateVariable as TemplateVariable,
-    type TemplateListResponse as TemplateListResponse,
-    type TemplateCreateParams as TemplateCreateParams,
-    type TemplateListParams as TemplateListParams,
-  };
-
   export {
     Contacts as Contacts,
     type ContactListItem as ContactListItem,
@@ -819,11 +805,20 @@ export declare namespace SentDm {
     type MessageSendToPhoneParams as MessageSendToPhoneParams,
   };
 
+  export {
+    Templates as Templates,
+    type TemplateBodyContent as TemplateBodyContent,
+    type TemplateDefinition as TemplateDefinition,
+    type TemplateResponseV2 as TemplateResponseV2,
+    type TemplateVariable as TemplateVariable,
+    type TemplateListResponse as TemplateListResponse,
+    type TemplateCreateParams as TemplateCreateParams,
+    type TemplateListParams as TemplateListParams,
+  };
+
   export {
     NumberLookup as NumberLookup,
     type NumberLookupRetrieveResponse as NumberLookupRetrieveResponse,
     type NumberLookupRetrieveParams as NumberLookupRetrieveParams,
   };
-
-  export { Organizations as Organizations };
 }

src/resources/index.ts

@@ -20,12 +20,11 @@ export {
   type NumberLookupRetrieveResponse,
   type NumberLookupRetrieveParams,
 } from './number-lookup';
-export { Organizations } from './organizations/organizations';
 export {
   Templates,
   type TemplateBodyContent,
   type TemplateDefinition,
-  type TemplateResponse,
+  type TemplateResponseV2,
   type TemplateVariable,
   type TemplateListResponse,
   type TemplateCreateParams,

src/resources/organizations.ts

@@ -17,12 +17,12 @@ export class Templates extends APIResource {
    *
    * @example
    * ```ts
-   * const templateResponse = await client.templates.create({
+   * const templateResponseV2 = await client.templates.create({
    *   definition: { body: {} },
    * });
    * ```
    */
-  create(body: TemplateCreateParams, options?: RequestOptions): APIPromise<TemplateResponse> {
+  create(body: TemplateCreateParams, options?: RequestOptions): APIPromise<TemplateResponseV2> {
     return this._client.post('/v2/templates', { body, ...options });
   }
 
@@ -34,12 +34,12 @@ export class Templates extends APIResource {
    *
    * @example
    * ```ts
-   * const templateResponse = await client.templates.retrieve(
+   * const templateResponseV2 = await client.templates.retrieve(
    *   '7ba7b820-9dad-11d1-80b4-00c04fd430c8',
    * );
    * ```
    */
-  retrieve(id: string, options?: RequestOptions): APIPromise<TemplateResponse> {
+  retrieve(id: string, options?: RequestOptions): APIPromise<TemplateResponseV2> {
     return this._client.get(path`/v2/templates/${id}`, options);
   }
 
@@ -269,7 +269,7 @@ export namespace TemplateDefinition {
  * Represents a message template with comprehensive metadata including definition
  * structure
  */
-export interface TemplateResponse {
+export interface TemplateResponseV2 {
   /**
    * The unique identifier of the template
    */
@@ -353,7 +353,7 @@ export namespace TemplateVariable {
 }
 
 export interface TemplateListResponse {
-  items?: Array<TemplateResponse>;
+  items?: Array<TemplateResponseV2>;
 
   page?: number;
 
@@ -421,7 +421,7 @@ export declare namespace Templates {
   export {
     type TemplateBodyContent as TemplateBodyContent,
     type TemplateDefinition as TemplateDefinition,
-    type TemplateResponse as TemplateResponse,
+    type TemplateResponseV2 as TemplateResponseV2,
     type TemplateVariable as TemplateVariable,
     type TemplateListResponse as TemplateListResponse,
     type TemplateCreateParams as TemplateCreateParams,