@rainapi/rain-sdk 0.1.0-alpha.3

package/src/resources/applications/company/index.ts

@@ -0,0 +1,15 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Company,
+  type IssuingApplication,
+  type IssuingApplicationPerson,
+  type IssuingCompany,
+  type PhysicalAddress,
+  type CompanyRetrieveResponse,
+  type CompanyCreateParams,
+  type CompanyUpdateParams,
+  type CompanyReapplyParams,
+  type CompanyUploadDocumentParams,
+} from './company';
+export { Ubo, type UboUpdateParams, type UboUploadDocumentParams } from './ubo/index';

package/src/resources/applications/company/ubo/document.ts

@@ -0,0 +1,89 @@
+// 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 { type Uploadable } from '../../../../core/uploads';
+import { buildHeaders } from '../../../../internal/headers';
+import { RequestOptions } from '../../../../internal/request-options';
+import { multipartFormRequestOptions } from '../../../../internal/uploads';
+import { path } from '../../../../internal/utils/path';
+
+export class Document extends APIResource {
+  /**
+   * Uploads a document for a company's Ultimate Beneficial Owner (UBO) to support
+   * the company's corporate application. This endpoint allows for the submission of
+   * various legal and identification documents.
+   *
+   * @example
+   * ```ts
+   * await client.applications.company.ubo.document.upload(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   {
+   *     companyId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *     document: fs.createReadStream('path/to/file'),
+   *   },
+   * );
+   * ```
+   */
+  upload(uboID: string, params: DocumentUploadParams, options?: RequestOptions): APIPromise<void> {
+    const { companyId, ...body } = params;
+    return this._client.put(
+      path`/applications/company/${companyId}/ubo/${uboID}/document`,
+      multipartFormRequestOptions(
+        { body, ...options, headers: buildHeaders([{ Accept: '*/*' }, options?.headers]) },
+        this._client,
+      ),
+    );
+  }
+}
+
+export interface DocumentUploadParams {
+  /**
+   * Path param: The identifier of the company to upload a document for
+   */
+  companyId: string;
+
+  /**
+   * Body param: The actual document file to be uploaded. The document must be in
+   * binary format, and the maximum allowed size is 20 MB.
+   */
+  document: Uploadable;
+
+  /**
+   * Body param: The country where the document was issued
+   */
+  country?: string;
+
+  /**
+   * Body param: The side of the document being uploaded
+   */
+  side?: 'front' | 'back';
+
+  /**
+   * Body param: The type of the document being uploaded
+   */
+  type?:
+    | 'idCard'
+    | 'passport'
+    | 'drivers'
+    | 'residencePermit'
+    | 'utilityBill'
+    | 'selfie'
+    | 'videoSelfie'
+    | 'profileImage'
+    | 'idDocPhoto'
+    | 'agreement'
+    | 'contract'
+    | 'driversTranslation'
+    | 'investorDoc'
+    | 'vehicleRegistrationCertificate'
+    | 'incomeSource'
+    | 'paymentMethod'
+    | 'bankCard'
+    | 'covidVaccinationForm'
+    | 'other';
+}
+
+export declare namespace Document {
+  export { type DocumentUploadParams as DocumentUploadParams };
+}

package/src/resources/applications/company/ubo/index.ts

@@ -0,0 +1,4 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Document, type DocumentUploadParams } from './document';
+export { Ubo, type UboUpdateParams, type UboUploadDocumentParams } from './ubo';

package/src/resources/applications/company/ubo/ubo.ts

@@ -0,0 +1,158 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../../core/resource';
+import * as CompanyAPI from '../company';
+import * as DocumentAPI from './document';
+import { Document, DocumentUploadParams } from './document';
+import { APIPromise } from '../../../../core/api-promise';
+import { type Uploadable } from '../../../../core/uploads';
+import { buildHeaders } from '../../../../internal/headers';
+import { RequestOptions } from '../../../../internal/request-options';
+import { multipartFormRequestOptions } from '../../../../internal/uploads';
+import { path } from '../../../../internal/utils/path';
+
+export class Ubo extends APIResource {
+  document: DocumentAPI.Document = new DocumentAPI.Document(this._client);
+
+  /**
+   * Updates the application information for a company's Ultimate Beneficial Owner
+   * (UBO). This allows modification of the UBO's personal details such as name,
+   * birth date, national ID, and address.
+   *
+   * @example
+   * ```ts
+   * const issuingCompany =
+   *   await client.applications.company.ubo.update(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *     { companyId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
+   *   );
+   * ```
+   */
+  update(
+    uboID: string,
+    params: UboUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<CompanyAPI.IssuingCompany> {
+    const { companyId, ...body } = params;
+    return this._client.patch(path`/applications/company/${companyId}/ubo/${uboID}`, { body, ...options });
+  }
+
+  /**
+   * This deprecated endpoint allows the upload of a document for a UBO to support a
+   * company's corporate application. It is recommended to use the newer endpoint for
+   * document uploads.
+   *
+   * @deprecated
+   */
+  uploadDocument(
+    companyID: string,
+    body: UboUploadDocumentParams,
+    options?: RequestOptions,
+  ): APIPromise<void> {
+    return this._client.put(
+      path`/applications/company/${companyID}/ubo/document`,
+      multipartFormRequestOptions(
+        { body, ...options, headers: buildHeaders([{ Accept: '*/*' }, options?.headers]) },
+        this._client,
+      ),
+    );
+  }
+}
+
+export interface UboUpdateParams {
+  /**
+   * Path param: The identifier of the company whose UBO's application is being
+   * updated
+   */
+  companyId: string;
+
+  /**
+   * Body param: The UBO's address
+   */
+  address?: CompanyAPI.PhysicalAddress;
+
+  /**
+   * Body param: The UBO's birth date
+   */
+  birthDate?: string;
+
+  /**
+   * Body param: The 2-digit country code of the user's national ID issuer
+   */
+  countryOfIssue?: string;
+
+  /**
+   * Body param: The UBO's email address
+   */
+  email?: string;
+
+  /**
+   * Body param: The UBO's first name
+   */
+  firstName?: string;
+
+  /**
+   * Body param: The UBO's last name
+   */
+  lastName?: string;
+
+  /**
+   * Body param: The UBO's national ID number. For the US, this is a 9-digit SSN
+   */
+  nationalId?: string;
+}
+
+export interface UboUploadDocumentParams {
+  /**
+   * The actual document file to be uploaded. The document must be in binary format,
+   * and the maximum allowed size is 20 MB.
+   */
+  document: Uploadable;
+
+  /**
+   * The UBO's email address
+   */
+  email: string;
+
+  /**
+   * The country where the document was issued
+   */
+  country?: string;
+
+  /**
+   * The side of the document being uploaded
+   */
+  side?: 'front' | 'back';
+
+  /**
+   * The type of the document being uploaded
+   */
+  type?:
+    | 'idCard'
+    | 'passport'
+    | 'drivers'
+    | 'residencePermit'
+    | 'utilityBill'
+    | 'selfie'
+    | 'videoSelfie'
+    | 'profileImage'
+    | 'idDocPhoto'
+    | 'agreement'
+    | 'contract'
+    | 'driversTranslation'
+    | 'investorDoc'
+    | 'vehicleRegistrationCertificate'
+    | 'incomeSource'
+    | 'paymentMethod'
+    | 'bankCard'
+    | 'covidVaccinationForm'
+    | 'other';
+}
+
+Ubo.Document = Document;
+
+export declare namespace Ubo {
+  export { type UboUpdateParams as UboUpdateParams, type UboUploadDocumentParams as UboUploadDocumentParams };
+
+  export { Document as Document, type DocumentUploadParams as DocumentUploadParams };
+}

package/src/resources/applications/company/ubo.ts

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

package/src/resources/applications/company.ts

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

package/src/resources/applications/index.ts

@@ -0,0 +1,25 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Applications } from './applications';
+export {
+  Company,
+  type IssuingApplication,
+  type IssuingApplicationPerson,
+  type IssuingCompany,
+  type PhysicalAddress,
+  type CompanyRetrieveResponse,
+  type CompanyCreateParams,
+  type CompanyUpdateParams,
+  type CompanyReapplyParams,
+  type CompanyUploadDocumentParams,
+} from './company/index';
+export {
+  User,
+  type IssuingUser,
+  type UserRetrieveResponse,
+  type UserCreateParams,
+  type UserUpdateParams,
+  type UserInitiateParams,
+  type UserReapplyParams,
+  type UserUploadDocumentParams,
+} from './user';