@augustusbank/typescript-sdk 0.20.0 → 0.22.0

package/src/resources/conversions.ts

@@ -8,7 +8,16 @@ import { path } from '../internal/utils/path';
 
 export class Conversions extends APIResource {
   /**
-   * Creates and executes a conversion.
+   * Starts a conversion.
+   *
+   * @example
+   * ```ts
+   * const conversion = await client.conversions.create({
+   *   source_account_id: '550e8400-e29b-41d4-a716-44665544000b',
+   *   source_amount: '100.50',
+   *   target_account_id: '550e8400-e29b-41d4-a716-44665544000c',
+   * });
+   * ```
    */
   create(body: ConversionCreateParams, options?: RequestOptions): APIPromise<ConversionCreateResponse> {
     return this._client.post('/v1/conversions', { body, ...options });
@@ -16,6 +25,13 @@ export class Conversions extends APIResource {
 
   /**
    * Retrieves a conversion by ID.
+   *
+   * @example
+   * ```ts
+   * const conversion = await client.conversions.retrieve(
+   *   '550e8400-e29b-41d4-a716-446655440006',
+   * );
+   * ```
    */
   retrieve(id: string, options?: RequestOptions): APIPromise<ConversionRetrieveResponse> {
     return this._client.get(path`/v1/conversions/${id}`, options);
@@ -23,6 +39,14 @@ export class Conversions extends APIResource {
 
   /**
    * Returns a paginated list of conversions.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const conversionListResponse of client.conversions.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     query: ConversionListParams | null | undefined = {},
@@ -53,36 +77,21 @@ export interface ConversionCreateResponse {
    */
   created_at: string;
 
-  /**
-   * Failure details when status is failed, otherwise null.
-   */
-  failure: ConversionCreateResponse.Failure | null;
-
   /**
    * Key-value pairs stored with the conversion.
    */
   metadata: { [key: string]: string };
 
-  /**
-   * ID of the associated quote, or null.
-   */
-  quote_id: string | null;
-
   /**
    * ID of the source account, or null.
    */
   source_account_id: string | null;
 
   /**
-   * Source amount as a string decimal.
+   * Amount as a string decimal (e.g. "100.50").
    */
   source_amount: string;
 
-  /**
-   * Source currency code.
-   */
-  source_currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
-
   /**
    * Current status of the conversion.
    */
@@ -94,9 +103,9 @@ export interface ConversionCreateResponse {
   target_account_id: string | null;
 
   /**
-   * Target currency code.
+   * Amount as a string decimal (e.g. "100.50").
    */
-  target_currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
+  target_amount: string;
 
   /**
    * Resource type discriminator.
@@ -109,18 +118,6 @@ export interface ConversionCreateResponse {
   updated_at: string;
 }
 
-export namespace ConversionCreateResponse {
-  /**
-   * Failure details when status is failed, otherwise null.
-   */
-  export interface Failure {
-    /**
-     * Human-readable description of the failure.
-     */
-    message: string;
-  }
-}
-
 export interface ConversionRetrieveResponse {
   /**
    * Unique identifier of the conversion.
@@ -137,36 +134,21 @@ export interface ConversionRetrieveResponse {
    */
   created_at: string;
 
-  /**
-   * Failure details when status is failed, otherwise null.
-   */
-  failure: ConversionRetrieveResponse.Failure | null;
-
   /**
    * Key-value pairs stored with the conversion.
    */
   metadata: { [key: string]: string };
 
-  /**
-   * ID of the associated quote, or null.
-   */
-  quote_id: string | null;
-
   /**
    * ID of the source account, or null.
    */
   source_account_id: string | null;
 
   /**
-   * Source amount as a string decimal.
+   * Amount as a string decimal (e.g. "100.50").
    */
   source_amount: string;
 
-  /**
-   * Source currency code.
-   */
-  source_currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
-
   /**
    * Current status of the conversion.
    */
@@ -178,9 +160,9 @@ export interface ConversionRetrieveResponse {
   target_account_id: string | null;
 
   /**
-   * Target currency code.
+   * Amount as a string decimal (e.g. "100.50").
    */
-  target_currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
+  target_amount: string;
 
   /**
    * Resource type discriminator.
@@ -193,18 +175,6 @@ export interface ConversionRetrieveResponse {
   updated_at: string;
 }
 
-export namespace ConversionRetrieveResponse {
-  /**
-   * Failure details when status is failed, otherwise null.
-   */
-  export interface Failure {
-    /**
-     * Human-readable description of the failure.
-     */
-    message: string;
-  }
-}
-
 export interface ConversionListResponse {
   /**
    * Unique identifier of the conversion.
@@ -221,36 +191,21 @@ export interface ConversionListResponse {
    */
   created_at: string;
 
-  /**
-   * Failure details when status is failed, otherwise null.
-   */
-  failure: ConversionListResponse.Failure | null;
-
   /**
    * Key-value pairs stored with the conversion.
    */
   metadata: { [key: string]: string };
 
-  /**
-   * ID of the associated quote, or null.
-   */
-  quote_id: string | null;
-
   /**
    * ID of the source account, or null.
    */
   source_account_id: string | null;
 
   /**
-   * Source amount as a string decimal.
+   * Amount as a string decimal (e.g. "100.50").
    */
   source_amount: string;
 
-  /**
-   * Source currency code.
-   */
-  source_currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
-
   /**
    * Current status of the conversion.
    */
@@ -262,9 +217,9 @@ export interface ConversionListResponse {
   target_account_id: string | null;
 
   /**
-   * Target currency code.
+   * Amount as a string decimal (e.g. "100.50").
    */
-  target_currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
+  target_amount: string;
 
   /**
    * Resource type discriminator.
@@ -277,18 +232,6 @@ export interface ConversionListResponse {
   updated_at: string;
 }
 
-export namespace ConversionListResponse {
-  /**
-   * Failure details when status is failed, otherwise null.
-   */
-  export interface Failure {
-    /**
-     * Human-readable description of the failure.
-     */
-    message: string;
-  }
-}
-
 export interface ConversionCreateParams {
   /**
    * ID of the source account to debit.
@@ -296,7 +239,7 @@ export interface ConversionCreateParams {
   source_account_id: string;
 
   /**
-   * Amount to convert as a string decimal (e.g. "100.50").
+   * Amount as a string decimal (e.g. "100.50").
    */
   source_amount: string;
 
@@ -308,7 +251,7 @@ export interface ConversionCreateParams {
   /**
    * Key-value pairs stored with the conversion.
    */
-  metadata?: { [key: string]: string };
+  metadata?: { [key: string]: string } | null;
 }
 
 export interface ConversionListParams extends CursorPageParams {