@augno/sdk 0.10.0 → 0.12.0

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

@@ -65,6 +65,26 @@ export class EmailDomains extends APIResource {
   retrieve(id: string, options?: RequestOptions): APIPromise<EmailDomain> {
     return this._client.get(path`/v1/messaging/email-domains/${id}`, options);
   }
+
+  /**
+   * Deregisters a customer-owned domain from the email bridge.
+   *
+   * The domain's SES identity is removed. The domain must have no inboxes bound to
+   * it.
+   *
+   * This endpoint requires the permission: `messaging:delete`.
+   *
+   * @example
+   * ```ts
+   * const emailDomain =
+   *   await client.messaging.emailDomains.delete(
+   *     'emdom_018e88072d1320808dc9aaa01',
+   *   );
+   * ```
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<EmailDomainDeleteResponse> {
+    return this._client.delete(path`/v1/messaging/email-domains/${id}`, options);
+  }
 }
 
 /**
@@ -149,6 +169,8 @@ export interface ListEmailDomain {
   page_info: APIKeysAPI.PageInfo;
 }
 
+export interface EmailDomainDeleteResponse {}
+
 export interface EmailDomainCreateParams {
   /**
    * The fully-qualified domain name to register (e.g. `support.acme.com`).
@@ -163,6 +185,7 @@ export declare namespace EmailDomains {
     type CreateEmailDomainRequest as CreateEmailDomainRequest,
     type EmailDomain as EmailDomain,
     type ListEmailDomain as ListEmailDomain,
+    type EmailDomainDeleteResponse as EmailDomainDeleteResponse,
     type EmailDomainCreateParams as EmailDomainCreateParams,
   };
 

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

@@ -6,5 +6,6 @@ export {
   type CreateEmailDomainRequest,
   type EmailDomain,
   type ListEmailDomain,
+  type EmailDomainDeleteResponse,
   type EmailDomainCreateParams,
 } from './email-domains';

package/src/resources/messaging/index.ts

@@ -67,6 +67,7 @@ export {
   type CreateEmailDomainRequest,
   type EmailDomain,
   type ListEmailDomain,
+  type EmailDomainDeleteResponse,
   type EmailDomainCreateParams,
 } from './email-domains/index';
 export {

package/src/resources/messaging/messaging.ts

@@ -94,6 +94,7 @@ import {
   CreateEmailDomainRequest,
   EmailDomain,
   EmailDomainCreateParams,
+  EmailDomainDeleteResponse,
   EmailDomains,
   ListEmailDomain,
 } from './email-domains/email-domains';
@@ -335,6 +336,7 @@ export declare namespace Messaging {
     type CreateEmailDomainRequest as CreateEmailDomainRequest,
     type EmailDomain as EmailDomain,
     type ListEmailDomain as ListEmailDomain,
+    type EmailDomainDeleteResponse as EmailDomainDeleteResponse,
     type EmailDomainCreateParams as EmailDomainCreateParams,
   };
 

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

@@ -533,6 +533,8 @@ export interface SendNotificationRequest {
     | 'email_log'
     | 'email_domain'
     | 'email_inbox'
+    | 'portal_domain'
+    | 'dns_record'
     | 'inventory_change_log'
     | 'invoice'
     | 'invoice_summary'
@@ -827,6 +829,8 @@ export interface NotificationCreateParams {
     | 'email_log'
     | 'email_domain'
     | 'email_inbox'
+    | 'portal_domain'
+    | 'dns_record'
     | 'inventory_change_log'
     | 'invoice'
     | 'invoice_summary'

package/src/resources/settings/index.ts

@@ -10,4 +10,14 @@ export {
   type IntegrationCreateParams,
   type IntegrationUpdateParams,
 } from './integrations';
+export {
+  PortalDomains,
+  type CreatePortalDomainRequest,
+  type DNSRecord,
+  type ListDNSRecord,
+  type ListPortalDomain,
+  type PortalDomain,
+  type PortalDomainDeleteResponse,
+  type PortalDomainCreateParams,
+} from './portal-domains/index';
 export { Settings } from './settings';

package/src/resources/settings/portal-domains/actions.ts

@@ -0,0 +1,33 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as PortalDomainsAPI from './portal-domains';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+/**
+ * Connect a custom domain to the account's customer portal, verify its DNS, and resolve custom hosts to portal accounts.
+ */
+export class Actions extends APIResource {
+  /**
+   * Re-checks the domain's DNS configuration and flips it to `verified` once the
+   * published records are confirmed.
+   *
+   * Returns the updated domain (still `pending` if DNS has not propagated yet) along
+   * with the currently required DNS records.
+   *
+   * This endpoint requires the permission: `self:update`.
+   *
+   * @example
+   * ```ts
+   * const portalDomain =
+   *   await client.settings.portalDomains.actions.verify(
+   *     'podn_018e88072d1320808dc9aab42',
+   *   );
+   * ```
+   */
+  verify(id: string, options?: RequestOptions): APIPromise<PortalDomainsAPI.PortalDomain> {
+    return this._client.post(path`/v1/settings/portal-domains/${id}/actions/verify`, options);
+  }
+}

package/src/resources/settings/portal-domains/index.ts

@@ -0,0 +1,13 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Actions } from './actions';
+export {
+  PortalDomains,
+  type CreatePortalDomainRequest,
+  type DNSRecord,
+  type ListDNSRecord,
+  type ListPortalDomain,
+  type PortalDomain,
+  type PortalDomainDeleteResponse,
+  type PortalDomainCreateParams,
+} from './portal-domains';

package/src/resources/settings/portal-domains/portal-domains.ts

@@ -0,0 +1,256 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as APIKeysAPI from '../../auth/api-keys/api-keys';
+import * as ActionsAPI from './actions';
+import { Actions } from './actions';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+/**
+ * Connect a custom domain to the account's customer portal, verify its DNS, and resolve custom hosts to portal accounts.
+ */
+export class PortalDomains extends APIResource {
+  actions: ActionsAPI.Actions = new ActionsAPI.Actions(this._client);
+
+  /**
+   * Connects a custom domain to the account's customer portal and returns the DNS
+   * records to publish.
+   *
+   * Each account can have one custom domain. The domain starts in `pending` until
+   * its DNS is verified.
+   *
+   * This endpoint requires the permission: `self:update`.
+   *
+   * @example
+   * ```ts
+   * const portalDomain =
+   *   await client.settings.portalDomains.create({
+   *     domain: 'shop.acme.com',
+   *   });
+   * ```
+   */
+  create(body: PortalDomainCreateParams, options?: RequestOptions): APIPromise<PortalDomain> {
+    return this._client.post('/v1/settings/portal-domains', { body, ...options });
+  }
+
+  /**
+   * Lists the account's portal domains.
+   *
+   * Accounts currently have at most one custom portal domain.
+   *
+   * This endpoint requires the permission: `self:read`.
+   *
+   * @example
+   * ```ts
+   * const listPortalDomain =
+   *   await client.settings.portalDomains.list();
+   * ```
+   */
+  list(options?: RequestOptions): APIPromise<ListPortalDomain> {
+    return this._client.get('/v1/settings/portal-domains', options);
+  }
+
+  /**
+   * Returns a single portal domain, including the DNS records the customer must
+   * publish.
+   *
+   * This endpoint requires the permission: `self:read`.
+   *
+   * @example
+   * ```ts
+   * const portalDomain =
+   *   await client.settings.portalDomains.retrieve(
+   *     'podn_018e88072d1320808dc9aab42',
+   *   );
+   * ```
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<PortalDomain> {
+    return this._client.get(path`/v1/settings/portal-domains/${id}`, options);
+  }
+
+  /**
+   * Disconnects the custom domain from the account's customer portal.
+   *
+   * The domain is detached from the serving infrastructure and immediately stops
+   * serving the portal.
+   *
+   * This endpoint requires the permission: `self:update`.
+   *
+   * @example
+   * ```ts
+   * const portalDomain =
+   *   await client.settings.portalDomains.delete(
+   *     'podn_018e88072d1320808dc9aab42',
+   *   );
+   * ```
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<PortalDomainDeleteResponse> {
+    return this._client.delete(path`/v1/settings/portal-domains/${id}`, options);
+  }
+}
+
+/**
+ * Request to connect a custom domain to the account's customer portal.
+ */
+export interface CreatePortalDomainRequest {
+  /**
+   * The fully-qualified domain name to connect (e.g. `shop.acme.com`). Subdomains
+   * are recommended; apex domains are supported via an A record.
+   */
+  domain: string;
+}
+
+/**
+ * A DNS record the customer must publish for their portal domain.
+ */
+export interface DNSRecord {
+  /**
+   * Record name (host) to publish.
+   */
+  name: string;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'dns_record';
+
+  /**
+   * Why the record is needed.
+   *
+   * Routing records point traffic at the portal's serving infrastructure; ownership
+   * records prove control of a domain that is claimed elsewhere.
+   */
+  reason: 'routing' | 'ownership';
+
+  /**
+   * Record type.
+   */
+  type: 'CNAME' | 'A' | 'TXT';
+
+  /**
+   * Record value to publish.
+   */
+  value: string;
+}
+
+/**
+ * List represents a paginated list of resources.
+ */
+export interface ListDNSRecord {
+  /**
+   * Resources in this page.
+   */
+  data: Array<DNSRecord>;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'list';
+
+  /**
+   * PageInfo contains URL-based pagination metadata.
+   */
+  page_info: APIKeysAPI.PageInfo;
+}
+
+/**
+ * List represents a paginated list of resources.
+ */
+export interface ListPortalDomain {
+  /**
+   * Resources in this page.
+   */
+  data: Array<PortalDomain>;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'list';
+
+  /**
+   * PageInfo contains URL-based pagination metadata.
+   */
+  page_info: APIKeysAPI.PageInfo;
+}
+
+/**
+ * A custom domain that serves the account's customer portal (e.g.
+ * `shop.acme.com`).
+ *
+ * After creation the domain starts in `pending`; publish the returned DNS records,
+ * then poll the verify action until it flips to `verified`. Once verified, the
+ * customer portal is served on the domain with TLS provisioned automatically.
+ */
+export interface PortalDomain {
+  /**
+   * Portal domain ID.
+   */
+  id: string;
+
+  /**
+   * Creation timestamp.
+   */
+  created_at: string;
+
+  /**
+   * List represents a paginated list of resources.
+   */
+  dns_records: ListDNSRecord | null;
+
+  /**
+   * The fully-qualified domain name (e.g. `shop.acme.com`).
+   */
+  domain: string;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'portal_domain';
+
+  /**
+   * Verification status.
+   *
+   * - pending domains await DNS configuration
+   * - verified domains serve the portal
+   * - failed domains were rejected and cannot be used
+   */
+  status: 'pending' | 'verified' | 'failed';
+
+  /**
+   * Last updated timestamp.
+   */
+  updated_at: string;
+
+  /**
+   * When the domain's DNS configuration was confirmed.
+   */
+  verified_at: string | null;
+}
+
+export interface PortalDomainDeleteResponse {}
+
+export interface PortalDomainCreateParams {
+  /**
+   * The fully-qualified domain name to connect (e.g. `shop.acme.com`). Subdomains
+   * are recommended; apex domains are supported via an A record.
+   */
+  domain: string;
+}
+
+PortalDomains.Actions = Actions;
+
+export declare namespace PortalDomains {
+  export {
+    type CreatePortalDomainRequest as CreatePortalDomainRequest,
+    type DNSRecord as DNSRecord,
+    type ListDNSRecord as ListDNSRecord,
+    type ListPortalDomain as ListPortalDomain,
+    type PortalDomain as PortalDomain,
+    type PortalDomainDeleteResponse as PortalDomainDeleteResponse,
+    type PortalDomainCreateParams as PortalDomainCreateParams,
+  };
+
+  export { Actions as Actions };
+}

package/src/resources/settings/portal-domains.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './portal-domains/index';

package/src/resources/settings/settings.ts

@@ -12,14 +12,38 @@ import {
   ListAccountIntegration,
   UpdateAccountIntegrationRequest,
 } from './integrations';
+import * as PortalDomainsAPI from './portal-domains/portal-domains';
+import {
+  CreatePortalDomainRequest,
+  DNSRecord,
+  ListDNSRecord,
+  ListPortalDomain,
+  PortalDomain,
+  PortalDomainCreateParams,
+  PortalDomainDeleteResponse,
+  PortalDomains,
+} from './portal-domains/portal-domains';
 
 export class Settings extends APIResource {
+  portalDomains: PortalDomainsAPI.PortalDomains = new PortalDomainsAPI.PortalDomains(this._client);
   integrations: IntegrationsAPI.Integrations = new IntegrationsAPI.Integrations(this._client);
 }
 
+Settings.PortalDomains = PortalDomains;
 Settings.Integrations = Integrations;
 
 export declare namespace Settings {
+  export {
+    PortalDomains as PortalDomains,
+    type CreatePortalDomainRequest as CreatePortalDomainRequest,
+    type DNSRecord as DNSRecord,
+    type ListDNSRecord as ListDNSRecord,
+    type ListPortalDomain as ListPortalDomain,
+    type PortalDomain as PortalDomain,
+    type PortalDomainDeleteResponse as PortalDomainDeleteResponse,
+    type PortalDomainCreateParams as PortalDomainCreateParams,
+  };
+
   export {
     Integrations as Integrations,
     type AccountIntegration as AccountIntegration,

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.10.0'; // x-release-please-version
+export const VERSION = '0.12.0'; // x-release-please-version

package/version.d.mts

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

package/version.d.ts

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

package/version.mjs

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