Release 6.0.2

Author: fern-api[bot]

.mock/definition/access-tokens.yml

@@ -2,6 +2,7 @@ imports:
   errors: types/errors.yml
   headers: types/headers.yml
   common: types/common.yml
+  payer: types/payer.yml
 types:
   AccessTokenSchema:
     examples:
@@ -21,6 +22,101 @@ types:
       expiresAt:
         type: datetime
         docs: The expiration date and time of the access token in `ISO 8601` format.
+      customizations: optional<CustomizationsSchema>
+      userId:
+        type: optional<string>
+        docs: The unique identifier of the user associated with this access token.
+  CustomizationsSchema:
+    docs: The component customizations for this access token.
+    properties:
+      payeeTaxProfile:
+        type: optional<PayeeTaxProfileSchema>
+        docs: The Payee Tax Profile component customizations.
+  PayeeTaxProfileSchema:
+    properties:
+      shouldPreloadFromUserId:
+        type: optional<boolean>
+        docs: >-
+          Determines if Abound should preload the Payee Tax Profile by `userId`
+          lookup. Default is `true`.
+      shouldCollectElectronicDeliveryConsent:
+        type: optional<boolean>
+        docs: >-
+          Determines if the electronic delivery consent question should be asked
+          in the Payee Tax Profile component. Default is `true`.
+      supportedTaxForms:
+        type: optional<list<SupportedTaxFormsEnum>>
+        docs: >-
+          A list of the forms your organizaton intends to support and collect
+          during a Payee Tax Profile submission. Default is all forms:
+          `["FORM_W_9", "FORM_W_8BEN", "FORM_W_8BEN_E"]`.
+      defaults:
+        type: optional<DefaultsSchema>
+        docs: >-
+          Used to preload the Payee Tax Profile with default values. These
+          defaults will be ignored if data is preloaded by `userId`.
+      requestingPayer:
+        type: optional<payer.PayerRequestSchema>
+        docs: >-
+          If supplied, a Payee Tax Profile submission that creates a Form W-9
+          will attach this information as the `Payer`.
+  DefaultsSchema:
+    properties:
+      firstName:
+        type: optional<string>
+        docs: The payee's legal first name.
+      lastName:
+        type: optional<string>
+        docs: The payee's legal last name.
+      businessName:
+        type: optional<string>
+        docs: The payee's business name.
+      dateOfBirth:
+        type: optional<date>
+        docs: The date, in `YYYY-MM-DD` format, the payee was born on.
+      address:
+        type: optional<string>
+        docs: The legal address.
+      address2:
+        type: optional<string>
+        docs: >-
+          The second part of the legal address, such as an apartment or suite
+          number.
+      city:
+        type: optional<string>
+        docs: >-
+          The city associated with the street address. Required if `country` is
+          `US`.
+      state:
+        type: optional<string>
+        docs: >-
+          The two-letter character code for this state (`CA` for California,
+          `ME` for Maine). Required if `country` is `US`. If foreign, use the
+          province.
+      postalCode:
+        type: optional<string>
+        docs: >-
+          The postal code associated with the street address. Required to be a
+          5-digit numerical value if `country` is `US`. If foreign, use the
+          foreign postal code.
+      country:
+        type: optional<string>
+        validation:
+          minLength: 2
+          maxLength: 2
+        docs: The country adhering to `ISO 3166-2` standards.
+      email:
+        type: optional<string>
+        validation:
+          format: email
+        docs: >-
+          The payee's email address. Abound assume's you have taken the proper
+          steps to verify the ownership of this email address.
+  SupportedTaxFormsEnum:
+    enum:
+      - FORM_W_9
+      - FORM_W_8BEN
+      - FORM_W_8BEN_E
 service:
   auth: false
   base-path: ''
@@ -39,6 +135,7 @@ service:
             expiresIn:
               type: integer
               docs: The number of seconds until the access token expires.
+            customizations: optional<CustomizationsSchema>
             userId:
               type: optional<string>
               docs: >-

package.json

@@ -1,6 +1,6 @@
 {
     "name": "@withabound/node-sdk",
-    "version": "6.0.1",
+    "version": "6.0.2",
     "private": false,
     "repository": "https://github.com/withabound/abound-node",
     "main": "./index.js",

src/api/resources/accessTokens/client/Client.ts

@@ -59,8 +59,8 @@ export class AccessTokens {
                 Authorization: await this._getAuthorizationHeader(),
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@withabound/node-sdk",
-                "X-Fern-SDK-Version": "6.0.1",
-                "User-Agent": "@withabound/node-sdk/6.0.1",
+                "X-Fern-SDK-Version": "6.0.2",
+                "User-Agent": "@withabound/node-sdk/6.0.2",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
                 "Idempotency-Key": idempotencyKey != null ? idempotencyKey : undefined,

src/api/resources/accessTokens/client/requests/AccessTokenRequestSchema.ts

@@ -14,6 +14,7 @@ export interface AccessTokenRequestSchema {
     "Idempotency-Key"?: Abound.types.IdempotencyKey | undefined;
     /** The number of seconds until the access token expires. */
     expiresIn: number;
+    customizations?: Abound.CustomizationsSchema;
     /** The unique identifier of the user associated with this access token. */
     userId?: string;
 }

src/api/resources/accessTokens/types/AccessTokenSchema.ts

@@ -2,6 +2,8 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 
+import * as Abound from "../../../index";
+
 /**
  * @example
  *     {
@@ -17,4 +19,7 @@ export interface AccessTokenSchema {
     createdAt: string;
     /** The expiration date and time of the access token in `ISO 8601` format. */
     expiresAt: string;
+    customizations?: Abound.CustomizationsSchema;
+    /** The unique identifier of the user associated with this access token. */
+    userId?: string;
 }

src/api/resources/accessTokens/types/CustomizationsSchema.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+import * as Abound from "../../../index";
+
+/**
+ * The component customizations for this access token.
+ */
+export interface CustomizationsSchema {
+    /** The Payee Tax Profile component customizations. */
+    payeeTaxProfile?: Abound.PayeeTaxProfileSchema;
+}

src/api/resources/accessTokens/types/DefaultsSchema.ts

@@ -0,0 +1,28 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+export interface DefaultsSchema {
+    /** The payee's legal first name. */
+    firstName?: string;
+    /** The payee's legal last name. */
+    lastName?: string;
+    /** The payee's business name. */
+    businessName?: string;
+    /** The date, in `YYYY-MM-DD` format, the payee was born on. */
+    dateOfBirth?: string;
+    /** The legal address. */
+    address?: string;
+    /** The second part of the legal address, such as an apartment or suite number. */
+    address2?: string;
+    /** The city associated with the street address. Required if `country` is `US`. */
+    city?: string;
+    /** The two-letter character code for this state (`CA` for California, `ME` for Maine). Required if `country` is `US`. If foreign, use the province. */
+    state?: string;
+    /** The postal code associated with the street address. Required to be a 5-digit numerical value if `country` is `US`. If foreign, use the foreign postal code. */
+    postalCode?: string;
+    /** The country adhering to `ISO 3166-2` standards. */
+    country?: string;
+    /** The payee's email address. Abound assume's you have taken the proper steps to verify the ownership of this email address. */
+    email?: string;
+}

src/api/resources/accessTokens/types/PayeeTaxProfileSchema.ts

@@ -0,0 +1,18 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+import * as Abound from "../../../index";
+
+export interface PayeeTaxProfileSchema {
+    /** Determines if Abound should preload the Payee Tax Profile by `userId` lookup. Default is `true`. */
+    shouldPreloadFromUserId?: boolean;
+    /** Determines if the electronic delivery consent question should be asked in the Payee Tax Profile component. Default is `true`. */
+    shouldCollectElectronicDeliveryConsent?: boolean;
+    /** A list of the forms your organizaton intends to support and collect during a Payee Tax Profile submission. Default is all forms: `["FORM_W_9", "FORM_W_8BEN", "FORM_W_8BEN_E"]`. */
+    supportedTaxForms?: Abound.SupportedTaxFormsEnum[];
+    /** Used to preload the Payee Tax Profile with default values. These defaults will be ignored if data is preloaded by `userId`. */
+    defaults?: Abound.DefaultsSchema;
+    /** If supplied, a Payee Tax Profile submission that creates a Form W-9 will attach this information as the `Payer`. */
+    requestingPayer?: Abound.types.PayerRequestSchema;
+}

src/api/resources/accessTokens/types/SupportedTaxFormsEnum.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+export type SupportedTaxFormsEnum = "FORM_W_9" | "FORM_W_8BEN" | "FORM_W_8BEN_E";
+
+export const SupportedTaxFormsEnum = {
+    FormW9: "FORM_W_9",
+    FormW8Ben: "FORM_W_8BEN",
+    FormW8BenE: "FORM_W_8BEN_E",
+} as const;

src/api/resources/accessTokens/types/index.ts

@@ -1 +1,5 @@
 export * from "./AccessTokenSchema";
+export * from "./CustomizationsSchema";
+export * from "./PayeeTaxProfileSchema";
+export * from "./DefaultsSchema";
+export * from "./SupportedTaxFormsEnum";