@openmrp/sdk 0.23.0 → 0.24.0

package/src/resources/core/audit-events.ts

@@ -326,6 +326,7 @@ export interface AuditEvent {
     | 'email_log'
     | 'email_domain'
     | 'email_inbox'
+    | 'email_sender'
     | 'portal_domain'
     | 'dns_record'
     | 'inventory_change_log'
@@ -741,6 +742,7 @@ export interface ListObjectType {
     | 'email_log'
     | 'email_domain'
     | 'email_inbox'
+    | 'email_sender'
     | 'portal_domain'
     | 'dns_record'
     | 'inventory_change_log'
@@ -1144,6 +1146,7 @@ export interface AuditEventListParams {
     | 'email_log'
     | 'email_domain'
     | 'email_inbox'
+    | 'email_sender'
     | 'portal_domain'
     | 'dns_record'
     | 'inventory_change_log'
@@ -1470,6 +1473,7 @@ export interface AuditEventListParams {
     | 'email_log'
     | 'email_domain'
     | 'email_inbox'
+    | 'email_sender'
     | 'portal_domain'
     | 'dns_record'
     | 'inventory_change_log'

package/src/resources/core/core.ts

@@ -319,6 +319,7 @@ export interface Entity {
     | 'email_log'
     | 'email_domain'
     | 'email_inbox'
+    | 'email_sender'
     | 'portal_domain'
     | 'dns_record'
     | 'inventory_change_log'
@@ -700,6 +701,7 @@ export interface CoreRetrieveSearchParams {
     | 'email_log'
     | 'email_domain'
     | 'email_inbox'
+    | 'email_sender'
     | 'portal_domain'
     | 'dns_record'
     | 'inventory_change_log'

package/src/resources/core/jobs.ts

@@ -268,6 +268,7 @@ export interface Job {
     | 'email_log'
     | 'email_domain'
     | 'email_inbox'
+    | 'email_sender'
     | 'portal_domain'
     | 'dns_record'
     | 'inventory_change_log'

package/src/resources/messaging/conversations/conversations.ts

@@ -611,6 +611,7 @@ export interface CreateConversationRequest {
     | 'email_log'
     | 'email_domain'
     | 'email_inbox'
+    | 'email_sender'
     | 'portal_domain'
     | 'dns_record'
     | 'inventory_change_log'
@@ -1507,6 +1508,7 @@ export interface ConversationCreateParams {
     | 'email_log'
     | 'email_domain'
     | 'email_inbox'
+    | 'email_sender'
     | 'portal_domain'
     | 'dns_record'
     | 'inventory_change_log'
@@ -1898,6 +1900,7 @@ export interface ConversationListParams {
     | 'email_log'
     | 'email_domain'
     | 'email_inbox'
+    | 'email_sender'
     | 'portal_domain'
     | 'dns_record'
     | 'inventory_change_log'

package/src/resources/messaging/conversations/links.ts

@@ -245,6 +245,7 @@ export interface AddConversationLinkRequest {
     | 'email_log'
     | 'email_domain'
     | 'email_inbox'
+    | 'email_sender'
     | 'portal_domain'
     | 'dns_record'
     | 'inventory_change_log'
@@ -630,6 +631,7 @@ export interface LinkCreateParams {
     | 'email_log'
     | 'email_domain'
     | 'email_inbox'
+    | 'email_sender'
     | 'portal_domain'
     | 'dns_record'
     | 'inventory_change_log'

package/src/resources/messaging/conversations/messages.ts

@@ -396,6 +396,7 @@ export interface SendMessageRequest {
     | 'email_log'
     | 'email_domain'
     | 'email_inbox'
+    | 'email_sender'
     | 'portal_domain'
     | 'dns_record'
     | 'inventory_change_log'
@@ -844,6 +845,7 @@ export interface MessageCreateParams {
     | 'email_log'
     | 'email_domain'
     | 'email_inbox'
+    | 'email_sender'
     | 'portal_domain'
     | 'dns_record'
     | 'inventory_change_log'

package/src/resources/messaging/email-domains/email-domains.ts

@@ -139,6 +139,26 @@ export interface EmailDomain {
    */
   domain: string;
 
+  /**
+   * The subdomain used as the envelope return path for mail sent from this domain.
+   *
+   * Publishing the two records below makes the return path match the sender address.
+   * Until you do, mail clients show your mail as coming from your address "via
+   * amazonses.com".
+   */
+  mail_from_domain: string | null;
+
+  /**
+   * The MX record to publish on `mail_from_domain`, for delivery of bounces and
+   * complaints.
+   */
+  mail_from_mx_record: string | null;
+
+  /**
+   * The SPF record to publish as a TXT record on `mail_from_domain`.
+   */
+  mail_from_spf_record: string | null;
+
   /**
    * Resource type identifier.
    */

package/src/resources/messaging/email-sender.ts

@@ -0,0 +1,200 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+
+/**
+ * Choose the address your order, invoice, and statement emails are sent from, on a domain you have verified.
+ */
+export class EmailSenderResource extends APIResource {
+  /**
+   * Returns the address your order, invoice, and statement emails are sent from, or
+   * 404 when none is configured and that mail sends from the platform address.
+   *
+   * This endpoint requires the permission: `messaging:read`.
+   *
+   * @example
+   * ```ts
+   * const emailSender =
+   *   await client.messaging.emailSender.list();
+   * ```
+   */
+  list(options?: RequestOptions): APIPromise<EmailSender> {
+    return this._client.get('/v1/messaging/email-sender', options);
+  }
+
+  /**
+   * Sets the address your order, invoice, and statement emails are sent from,
+   * replacing any address already configured.
+   *
+   * The domain must be verified first. Emails about someone's OpenMRP account —
+   * password resets, verification, plan changes — continue to send from the platform
+   * address.
+   *
+   * This endpoint requires the permission: `messaging:update`.
+   *
+   * @example
+   * ```ts
+   * const emailSender =
+   *   await client.messaging.emailSender.update({
+   *     email_domain_id: 'emdom_2rk3omr8vshb',
+   *     local_part: 'orders',
+   *     from_name: 'Acme Inc.',
+   *   });
+   * ```
+   */
+  update(body: EmailSenderUpdateParams, options?: RequestOptions): APIPromise<EmailSender> {
+    return this._client.put('/v1/messaging/email-sender', { body, ...options });
+  }
+
+  /**
+   * Clears the configured sending address, returning your customer-facing email to
+   * the platform address.
+   *
+   * This endpoint requires the permission: `messaging:delete`.
+   *
+   * @example
+   * ```ts
+   * const emailSender =
+   *   await client.messaging.emailSender.delete();
+   * ```
+   */
+  delete(options?: RequestOptions): APIPromise<EmailSenderDeleteResponse> {
+    return this._client.delete('/v1/messaging/email-sender', options);
+  }
+}
+
+/**
+ * The address your order, invoice, and statement emails are sent from.
+ *
+ * Configure one on a verified email domain and your customers see mail from your
+ * own address instead of the platform's. Emails about someone's OpenMRP account —
+ * password resets, verification, plan changes — always send from the platform
+ * address regardless of this setting.
+ *
+ * Mail only sends from this address while the underlying domain stays verified; if
+ * verification lapses it falls back to the platform address rather than failing to
+ * send.
+ */
+export interface EmailSender {
+  /**
+   * Email sender ID.
+   */
+  id: string;
+
+  /**
+   * The full sending address.
+   */
+  address: string;
+
+  /**
+   * Creation timestamp.
+   */
+  created_at: string;
+
+  /**
+   * The domain name the address sends from.
+   */
+  domain: string;
+
+  /**
+   * Verification status of the underlying domain.
+   */
+  domain_status: 'pending' | 'verified' | 'failed';
+
+  /**
+   * The verified email domain this address belongs to.
+   */
+  email_domain_id: string;
+
+  /**
+   * The name shown in a mail client's sender column. When unset, mail shows the bare
+   * address.
+   */
+  from_name: string | null;
+
+  /**
+   * The mailbox name before the `@`.
+   */
+  local_part: string;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'email_sender';
+
+  /**
+   * Where customer replies are delivered. When unset, replies go to the sending
+   * address.
+   */
+  reply_to: string | null;
+
+  /**
+   * Last updated timestamp.
+   */
+  updated_at: string;
+}
+
+/**
+ * Request to configure the address the account's customer-facing email is sent
+ * from.
+ */
+export interface SetEmailSenderRequest {
+  /**
+   * The verified email domain to send from.
+   */
+  email_domain_id: string;
+
+  /**
+   * The mailbox name before the `@`, for example `orders`.
+   */
+  local_part: string;
+
+  /**
+   * The name shown in a mail client's sender column. When unset, mail shows the bare
+   * address.
+   */
+  from_name?: string;
+
+  /**
+   * Where customer replies are delivered. When unset, replies go to the sending
+   * address.
+   */
+  reply_to?: string;
+}
+
+export interface EmailSenderDeleteResponse {}
+
+export interface EmailSenderUpdateParams {
+  /**
+   * The verified email domain to send from.
+   */
+  email_domain_id: string;
+
+  /**
+   * The mailbox name before the `@`, for example `orders`.
+   */
+  local_part: string;
+
+  /**
+   * The name shown in a mail client's sender column. When unset, mail shows the bare
+   * address.
+   */
+  from_name?: string;
+
+  /**
+   * Where customer replies are delivered. When unset, replies go to the sending
+   * address.
+   */
+  reply_to?: string;
+}
+
+export declare namespace EmailSenderResource {
+  export {
+    type EmailSender as EmailSender,
+    type SetEmailSenderRequest as SetEmailSenderRequest,
+    type EmailSenderDeleteResponse as EmailSenderDeleteResponse,
+    type EmailSenderUpdateParams as EmailSenderUpdateParams,
+  };
+}

package/src/resources/messaging/index.ts

@@ -71,6 +71,13 @@ export {
   type EmailInboxRetrieveParams,
   type EmailInboxUpdateParams,
 } from './email-inboxes';
+export {
+  EmailSenderResource,
+  type EmailSender,
+  type SetEmailSenderRequest,
+  type EmailSenderDeleteResponse,
+  type EmailSenderUpdateParams,
+} from './email-sender';
 export {
   Groups,
   type CreateMessagingGroupRequest,

package/src/resources/messaging/messaging.ts

@@ -40,6 +40,14 @@ import {
   ListEmailInbox,
   UpdateEmailInboxRequest,
 } from './email-inboxes';
+import * as EmailSenderAPI from './email-sender';
+import {
+  EmailSender,
+  EmailSenderDeleteResponse,
+  EmailSenderResource,
+  EmailSenderUpdateParams,
+  SetEmailSenderRequest,
+} from './email-sender';
 import * as PreferencesAPI from './preferences';
 import {
   ListNotificationPreference,
@@ -131,6 +139,7 @@ export class Messaging extends APIResource {
   preferences: PreferencesAPI.Preferences = new PreferencesAPI.Preferences(this._client);
   emailDomains: EmailDomainsAPI.EmailDomains = new EmailDomainsAPI.EmailDomains(this._client);
   emailInboxes: EmailInboxesAPI.EmailInboxes = new EmailInboxesAPI.EmailInboxes(this._client);
+  emailSender: EmailSenderAPI.EmailSenderResource = new EmailSenderAPI.EmailSenderResource(this._client);
 
   /**
    * Lists the people the caller can start a conversation with.
@@ -228,6 +237,7 @@ Messaging.Blocks = Blocks;
 Messaging.Preferences = Preferences;
 Messaging.EmailDomains = EmailDomains;
 Messaging.EmailInboxes = EmailInboxes;
+Messaging.EmailSenderResource = EmailSenderResource;
 
 export declare namespace Messaging {
   export {
@@ -350,4 +360,12 @@ export declare namespace Messaging {
     type EmailInboxRetrieveParams as EmailInboxRetrieveParams,
     type EmailInboxUpdateParams as EmailInboxUpdateParams,
   };
+
+  export {
+    EmailSenderResource as EmailSenderResource,
+    type EmailSender as EmailSender,
+    type SetEmailSenderRequest as SetEmailSenderRequest,
+    type EmailSenderDeleteResponse as EmailSenderDeleteResponse,
+    type EmailSenderUpdateParams as EmailSenderUpdateParams,
+  };
 }

package/src/resources/messaging/notifications/notifications.ts

@@ -626,6 +626,7 @@ export interface SendNotificationRequest {
     | 'email_log'
     | 'email_domain'
     | 'email_inbox'
+    | 'email_sender'
     | 'portal_domain'
     | 'dns_record'
     | 'inventory_change_log'
@@ -987,6 +988,7 @@ export interface NotificationCreateParams {
     | 'email_log'
     | 'email_domain'
     | 'email_inbox'
+    | 'email_sender'
     | 'portal_domain'
     | 'dns_record'
     | 'inventory_change_log'

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.23.0'; // x-release-please-version
+export const VERSION = '0.24.0'; // x-release-please-version

package/version.d.mts

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

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.23.0";
+export declare const VERSION = "0.24.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.23.0'; // x-release-please-version
+exports.VERSION = '0.24.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

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