modern-treasury 2.2.0 → 2.3.0

package/src/resources/invoices/invoices.ts

@@ -15,7 +15,7 @@ export class Invoices extends APIResource {
   /**
    * create invoice
    */
-  create(params: InvoiceCreateParams, options?: Core.RequestOptions): Promise<Core.APIResponse<Invoice>> {
+  create(params: InvoiceCreateParams, options?: Core.RequestOptions): Core.APIPromise<Invoice> {
     const { 'Idempotency-Key': idempotencyKey, ...body } = params;
     return this.post('/api/invoices', {
       body,
@@ -27,24 +27,20 @@ export class Invoices extends APIResource {
   /**
    * get invoice
    */
-  retrieve(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<Invoice>> {
+  retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<Invoice> {
     return this.get(`/api/invoices/${id}`, options);
   }
 
   /**
    * update invoice
    */
-  update(
-    id: string,
-    body?: InvoiceUpdateParams,
-    options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<Invoice>>;
-  update(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<Invoice>>;
+  update(id: string, body?: InvoiceUpdateParams, options?: Core.RequestOptions): Core.APIPromise<Invoice>;
+  update(id: string, options?: Core.RequestOptions): Core.APIPromise<Invoice>;
   update(
     id: string,
     body: InvoiceUpdateParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<Invoice>> {
+  ): Core.APIPromise<Invoice> {
     if (isRequestOptions(body)) {
       return this.update(id, {}, body);
     }
@@ -54,12 +50,12 @@ export class Invoices extends APIResource {
   /**
    * list invoices
    */
-  list(query?: InvoiceListParams, options?: Core.RequestOptions): Core.PagePromise<InvoicesPage>;
-  list(options?: Core.RequestOptions): Core.PagePromise<InvoicesPage>;
+  list(query?: InvoiceListParams, options?: Core.RequestOptions): Core.PagePromise<InvoicesPage, Invoice>;
+  list(options?: Core.RequestOptions): Core.PagePromise<InvoicesPage, Invoice>;
   list(
     query: InvoiceListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<InvoicesPage> {
+  ): Core.PagePromise<InvoicesPage, Invoice> {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
@@ -127,6 +123,19 @@ export interface Invoice {
    */
   live_mode: boolean;
 
+  /**
+   * Emails in addition to the counterparty email to send invoice status
+   * notifications to. At least one email is required if notifications are enabled
+   * and the counterparty doesn't have an email.
+   */
+  notification_email_addresses: Array<string> | null;
+
+  /**
+   * If true, the invoice will send email notifications to the invoice recipients
+   * about invoice status changes.
+   */
+  notifications_enabled: boolean;
+
   /**
    * A unique record number assigned to each invoice that is issued.
    */
@@ -159,7 +168,7 @@ export interface Invoice {
   payment_orders: Array<PaymentOrders.PaymentOrder>;
 
   /**
-   * One of `ach` or `eft`
+   * One of `ach` or `eft`.
    */
   payment_type: 'eft' | 'ach' | null;
 
@@ -184,6 +193,11 @@ export interface Invoice {
    */
   total_amount: number;
 
+  /**
+   * IDs of transaction line items associated with an invoice.
+   */
+  transaction_line_item_ids: Array<string>;
+
   updated_at: string;
 }
 
@@ -346,6 +360,19 @@ export interface InvoiceCreateParams {
    */
   invoicer_address?: InvoiceCreateParams.InvoicerAddress | null;
 
+  /**
+   * Body param: Emails in addition to the counterparty email to send invoice status
+   * notifications to. At least one email is required if notifications are enabled
+   * and the counterparty doesn't have an email.
+   */
+  notification_email_addresses?: Array<string> | null;
+
+  /**
+   * Body param: If true, the invoice will send email notifications to the invoice
+   * recipients about invoice status changes.
+   */
+  notifications_enabled?: boolean;
+
   /**
    * Body param: Date transactions are to be posted to the participants' account.
    * Defaults to the current business day or the next business day if the current day
@@ -551,6 +578,19 @@ export interface InvoiceUpdateParams {
    */
   invoicer_address?: InvoiceUpdateParams.InvoicerAddress | null;
 
+  /**
+   * Emails in addition to the counterparty email to send invoice status
+   * notifications to. At least one email is required if notifications are enabled
+   * and the counterparty doesn't have an email.
+   */
+  notification_email_addresses?: Array<string> | null;
+
+  /**
+   * If true, the invoice will send email notifications to the invoice recipients
+   * about invoice status changes.
+   */
+  notifications_enabled?: boolean;
+
   /**
    * The ID of the internal account the invoice should be paid to.
    */
@@ -603,8 +643,8 @@ export interface InvoiceUpdateParams {
 
   /**
    * Invoice status must be updated in a `PATCH` request that does not modify any
-   * other invoice attributes. Valid state transitions are `draft` to `unpaid` and
-   * `draft` or `unpaid` to `voided`.
+   * other invoice attributes. Valid state transitions are `draft` to `unpaid`,
+   * `draft` or `unpaid` to `voided`, and `draft` or `unpaid` to `paid`.
    */
   status?: string;
 }

package/src/resources/invoices/line-items.ts

@@ -3,7 +3,6 @@
 import * as Core from '../../core';
 import { APIResource } from '../../resource';
 import { isRequestOptions } from '../../core';
-import * as Shared from '../shared';
 import * as API from './index';
 import { Page, PageParams } from '../../pagination';
 
@@ -15,7 +14,7 @@ export class LineItems extends APIResource {
     invoiceId: string,
     params: LineItemCreateParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<InvoiceLineItem>> {
+  ): Core.APIPromise<InvoiceLineItem> {
     const { 'Idempotency-Key': idempotencyKey, ...body } = params;
     return this.post(`/api/invoices/${invoiceId}/invoice_line_items`, {
       body,
@@ -27,11 +26,7 @@ export class LineItems extends APIResource {
   /**
    * get invoice_line_item
    */
-  retrieve(
-    invoiceId: string,
-    id: string,
-    options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<InvoiceLineItem>> {
+  retrieve(invoiceId: string, id: string, options?: Core.RequestOptions): Core.APIPromise<InvoiceLineItem> {
     return this.get(`/api/invoices/${invoiceId}/invoice_line_items/${id}`, options);
   }
 
@@ -43,18 +38,14 @@ export class LineItems extends APIResource {
     id: string,
     body?: LineItemUpdateParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<InvoiceLineItem>>;
-  update(
-    invoiceId: string,
-    id: string,
-    options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<InvoiceLineItem>>;
+  ): Core.APIPromise<InvoiceLineItem>;
+  update(invoiceId: string, id: string, options?: Core.RequestOptions): Core.APIPromise<InvoiceLineItem>;
   update(
     invoiceId: string,
     id: string,
     body: LineItemUpdateParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<InvoiceLineItem>> {
+  ): Core.APIPromise<InvoiceLineItem> {
     if (isRequestOptions(body)) {
       return this.update(invoiceId, id, {}, body);
     }
@@ -68,13 +59,16 @@ export class LineItems extends APIResource {
     invoiceId: string,
     query?: LineItemListParams,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<InvoiceLineItemsPage>;
-  list(invoiceId: string, options?: Core.RequestOptions): Core.PagePromise<InvoiceLineItemsPage>;
+  ): Core.PagePromise<InvoiceLineItemsPage, InvoiceLineItem>;
+  list(
+    invoiceId: string,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<InvoiceLineItemsPage, InvoiceLineItem>;
   list(
     invoiceId: string,
     query: LineItemListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<InvoiceLineItemsPage> {
+  ): Core.PagePromise<InvoiceLineItemsPage, InvoiceLineItem> {
     if (isRequestOptions(query)) {
       return this.list(invoiceId, {}, query);
     }
@@ -87,11 +81,7 @@ export class LineItems extends APIResource {
   /**
    * delete invoice_line_item
    */
-  del(
-    invoiceId: string,
-    id: string,
-    options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<InvoiceLineItem>> {
+  del(invoiceId: string, id: string, options?: Core.RequestOptions): Core.APIPromise<InvoiceLineItem> {
     return this.delete(`/api/invoices/${invoiceId}/invoice_line_items/${id}`, options);
   }
 }
@@ -190,205 +180,33 @@ export interface LineItemCreateParams {
 
 export interface LineItemUpdateParams {
   /**
-   * The invoicer's contact details displayed at the top of the invoice.
-   */
-  contact_details?: Array<LineItemUpdateParams.ContactDetail>;
-
-  /**
-   * The counterparty's billing address.
-   */
-  counterparty_billing_address?: LineItemUpdateParams.CounterpartyBillingAddress | null;
-
-  /**
-   * The ID of the counterparty receiving the invoice.
-   */
-  counterparty_id?: string;
-
-  /**
-   * The counterparty's shipping address where physical goods should be delivered.
-   */
-  counterparty_shipping_address?: LineItemUpdateParams.CounterpartyShippingAddress | null;
-
-  /**
-   * Currency that the invoice is denominated in. Defaults to `USD` if not provided.
-   */
-  currency?: Shared.Currency | null;
-
-  /**
-   * A free-form description of the invoice.
+   * An optional free-form description of the line item.
    */
   description?: string;
 
   /**
-   * A future date by when the invoice needs to be paid.
-   */
-  due_date?: string;
-
-  /**
-   * The invoice issuer's business address.
-   */
-  invoicer_address?: LineItemUpdateParams.InvoicerAddress | null;
-
-  /**
-   * The ID of the internal account the invoice should be paid to.
-   */
-  originating_account_id?: string;
-
-  /**
-   * Date transactions are to be posted to the participants' account. Defaults to the
-   * current business day or the next business day if the current day is a bank
-   * holiday or weekend. Format: yyyy-mm-dd.
-   */
-  payment_effective_date?: string;
-
-  /**
-   * The method by which the invoice can be paid. `ui` will show the embedded payment
-   * collection flow. `automatic` will automatically initiate payment based upon the
-   * account details of the receiving_account id.\nIf the invoice amount is positive,
-   * the automatically initiated payment order's direction will be debit. If the
-   * invoice amount is negative, the automatically initiated payment order's
-   * direction will be credit. One of `manual`, `ui`, or `automatic`.
-   */
-  payment_method?: 'ui' | 'manual' | 'automatic';
-
-  /**
-   * One of `ach`, `eft`, `wire`, `check`, `sen`, `book`, `rtp`, `sepa`, `bacs`,
-   * `au_becs`, `interac`, `signet`, `provexchange`.
-   */
-  payment_type?:
-    | 'ach'
-    | 'au_becs'
-    | 'bacs'
-    | 'book'
-    | 'card'
-    | 'check'
-    | 'eft'
-    | 'cross_border'
-    | 'interac'
-    | 'masav'
-    | 'neft'
-    | 'provxchange'
-    | 'rtp'
-    | 'sen'
-    | 'sepa'
-    | 'signet'
-    | 'wire';
-
-  /**
-   * The receiving account ID. Can be an `external_account`.
+   * Either `debit` or `credit`. `debit` indicates that a client owes the business
+   * money and increases the invoice's `total_amount` due. `credit` has the opposite
+   * intention and effect.
    */
-  receiving_account_id?: string;
-}
-
-export namespace LineItemUpdateParams {
-  export interface ContactDetail {
-    id: string;
-
-    contact_identifier: string;
-
-    contact_identifier_type: 'email' | 'phone_number' | 'website';
-
-    created_at: string;
-
-    discarded_at: string | null;
-
-    /**
-     * This field will be true if this object exists in the live environment or false
-     * if it exists in the test environment.
-     */
-    live_mode: boolean;
-
-    object: string;
-
-    updated_at: string;
-  }
+  direction?: string;
 
   /**
-   * The counterparty's billing address.
+   * The name of the line item, typically a product or SKU name.
    */
-  export interface CounterpartyBillingAddress {
-    /**
-     * Country code conforms to [ISO 3166-1 alpha-2]
-     */
-    country: string;
-
-    line1: string;
-
-    /**
-     * Locality or City.
-     */
-    locality: string;
-
-    /**
-     * The postal code of the address.
-     */
-    postal_code: string;
-
-    /**
-     * Region or State.
-     */
-    region: string;
-
-    line2?: string;
-  }
+  name?: string;
 
   /**
-   * The counterparty's shipping address where physical goods should be delivered.
+   * The number of units of a product or service that this line item is for. Must be
+   * a whole number. Defaults to 1 if not provided.
    */
-  export interface CounterpartyShippingAddress {
-    /**
-     * Country code conforms to [ISO 3166-1 alpha-2]
-     */
-    country: string;
-
-    line1: string;
-
-    /**
-     * Locality or City.
-     */
-    locality: string;
-
-    /**
-     * The postal code of the address.
-     */
-    postal_code: string;
-
-    /**
-     * Region or State.
-     */
-    region: string;
-
-    line2?: string;
-  }
+  quantity?: number;
 
   /**
-   * The invoice issuer's business address.
+   * The cost per unit of the product or service that this line item is for,
+   * specified in the invoice currency's smallest unit.
    */
-  export interface InvoicerAddress {
-    /**
-     * Country code conforms to [ISO 3166-1 alpha-2]
-     */
-    country: string;
-
-    line1: string;
-
-    /**
-     * Locality or City.
-     */
-    locality: string;
-
-    /**
-     * The postal code of the address.
-     */
-    postal_code: string;
-
-    /**
-     * Region or State.
-     */
-    region: string;
-
-    line2?: string;
-  }
+  unit_amount?: number;
 }
 
 export interface LineItemListParams extends PageParams {}