@rainapi/rain-sdk 0.1.0-alpha.3

package/src/resources/companies/companies.ts

@@ -0,0 +1,371 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as UserAPI from '../applications/user';
+import * as SignaturesAPI from './signatures';
+import {
+  IssuingSignature,
+  SignatureRetrievePaymentSignatureParams,
+  SignatureRetrieveWithdrawalSignatureParams,
+  Signatures,
+} from './signatures';
+import * as CompanyAPI from '../applications/company/company';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Companies extends APIResource {
+  signatures: SignaturesAPI.Signatures = new SignaturesAPI.Signatures(this._client);
+
+  /**
+   * Retrieve detailed information about a specific company using its unique ID
+   */
+  retrieve(companyID: string, options?: RequestOptions): APIPromise<CompanyAPI.IssuingCompany> {
+    return this._client.get(path`/companies/${companyID}`, options);
+  }
+
+  /**
+   * Update the details of an existing company such as its name and address
+   */
+  update(
+    companyID: string,
+    body: CompanyUpdateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<CompanyAPI.IssuingCompany> {
+    return this._client.patch(path`/companies/${companyID}`, { body, ...options });
+  }
+
+  /**
+   * Retrieves a list of all companies registered in the system
+   */
+  list(
+    query: CompanyListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<CompanyListResponse> {
+    return this._client.get('/companies', { query, ...options });
+  }
+
+  /**
+   * Initiate a custom fee charge for a company.
+   */
+  charge(
+    companyID: string,
+    body: CompanyChargeParams,
+    options?: RequestOptions,
+  ): APIPromise<IssuingChargeCreateResponse> {
+    return this._client.post(path`/companies/${companyID}/charges`, { body, ...options });
+  }
+
+  /**
+   * Creates a new user within a specific company. The user must provide details such
+   * as their name, birthdate, and contact information.
+   */
+  createUser(
+    companyID: string,
+    body: CompanyCreateUserParams,
+    options?: RequestOptions,
+  ): APIPromise<UserAPI.IssuingUser> {
+    return this._client.post(path`/companies/${companyID}/users`, { body, ...options });
+  }
+
+  /**
+   * Initiate a payment for a specific company by providing the payment amount and
+   * wallet address.
+   */
+  initiatePayment(
+    companyID: string,
+    body: CompanyInitiatePaymentParams,
+    options?: RequestOptions,
+  ): APIPromise<CompanyInitiatePaymentResponse> {
+    return this._client.post(path`/companies/${companyID}/payments`, { body, ...options });
+  }
+
+  /**
+   * Retrieve the current credit balances of a company, including credit limits,
+   * pending charges, and the amount due.
+   */
+  retrieveBalances(companyID: string, options?: RequestOptions): APIPromise<CompanyRetrieveBalancesResponse> {
+    return this._client.get(path`/companies/${companyID}/balances`, options);
+  }
+
+  /**
+   * Retrieve the smart contract details associated with a company
+   */
+  retrieveContracts(
+    companyID: string,
+    options?: RequestOptions,
+  ): APIPromise<CompanyRetrieveContractsResponse> {
+    return this._client.get(path`/companies/${companyID}/contracts`, options);
+  }
+}
+
+/**
+ * Represents the body of a request to create a charge, including the amount and a
+ * description of the charge.
+ */
+export interface IssuingChargeCreateBody {
+  /**
+   * The amount of the charge, in cents
+   */
+  amount: number;
+
+  /**
+   * The description of the charge
+   */
+  description: string;
+}
+
+/**
+ * Represents the response body returned after a charge is created, including the
+ * charge ID, creation timestamp, and charge details.
+ */
+export interface IssuingChargeCreateResponse {
+  /**
+   * The identifier of the charge
+   */
+  id: string;
+
+  /**
+   * The date and time when the charge was created
+   */
+  createdAt: string;
+
+  /**
+   * The amount of the charge, in cents
+   */
+  amount?: number;
+
+  /**
+   * The description of the charge
+   */
+  description?: string;
+}
+
+/**
+ * Represents an issuing contract with details about its deployment and token
+ * handling.
+ */
+export interface IssuingContract {
+  /**
+   * The contract's unique identifier
+   */
+  id: string;
+
+  /**
+   * The chain ID (base-10 number) that the smart contract is deployed on
+   */
+  chainId: number;
+
+  /**
+   * Version of the contract
+   */
+  contractVersion: number;
+
+  /**
+   * The address of the contract's controller
+   */
+  controllerAddress: string;
+
+  /**
+   * The proxy address of the contract
+   */
+  proxyAddress: string;
+
+  /**
+   * Tokens that the contract accepts for transactions
+   */
+  tokens: Array<IssuingContract.Token>;
+
+  /**
+   * The address where funds should be deposited
+   */
+  depositAddress?: string;
+}
+
+export namespace IssuingContract {
+  export interface Token {
+    /**
+     * The address of the token contract
+     */
+    address: string;
+
+    /**
+     * The advance rate for the token
+     */
+    advanceRate?: number;
+
+    /**
+     * The balance of the token
+     */
+    balance?: string;
+
+    /**
+     * The exchange rate for the token
+     */
+    exchangeRate?: number;
+  }
+}
+
+export type CompanyListResponse = Array<CompanyAPI.IssuingCompany>;
+
+export interface CompanyInitiatePaymentResponse {
+  /**
+   * The address to send the payment to
+   */
+  address: string;
+}
+
+export interface CompanyRetrieveBalancesResponse {
+  /**
+   * Balance due of the company, in cents
+   */
+  balanceDue: number;
+
+  /**
+   * Credit limit of the company, in cents
+   */
+  creditLimit: number;
+
+  /**
+   * Pending charges of the company, in cents
+   */
+  pendingCharges: number;
+
+  /**
+   * Posted charges of the company, in cents
+   */
+  postedCharges: number;
+
+  /**
+   * The amount of money the company can spend, in cents
+   */
+  spendingPower: number;
+}
+
+export type CompanyRetrieveContractsResponse = Array<IssuingContract>;
+
+export interface CompanyUpdateParams {
+  /**
+   * The company's physical address
+   */
+  address?: CompanyAPI.PhysicalAddress;
+
+  /**
+   * The company's name on the Rain platform
+   */
+  name?: string;
+}
+
+export interface CompanyListParams {
+  /**
+   * The ID of the resource after which to start fetching
+   */
+  cursor?: string;
+
+  /**
+   * The number of resources to fetch
+   */
+  limit?: number;
+}
+
+export interface CompanyChargeParams {
+  /**
+   * The amount of the charge, in cents
+   */
+  amount: number;
+
+  /**
+   * The description of the charge
+   */
+  description: string;
+}
+
+export interface CompanyCreateUserParams {
+  /**
+   * The user's email address
+   */
+  email: string;
+
+  /**
+   * The user's first name
+   */
+  firstName: string;
+
+  /**
+   * Indicates whether the user has accepted the terms of service
+   */
+  isTermsOfServiceAccepted: boolean;
+
+  /**
+   * The user's last name
+   */
+  lastName: string;
+
+  /**
+   * The user's address
+   */
+  address?: CompanyAPI.PhysicalAddress;
+
+  /**
+   * The user's birth date
+   */
+  birthDate?: string;
+
+  /**
+   * The user's phone country code
+   */
+  phoneCountryCode?: string;
+
+  /**
+   * The user's phone number
+   */
+  phoneNumber?: string;
+
+  /**
+   * The user's wallet address
+   */
+  walletAddress?: string;
+}
+
+export interface CompanyInitiatePaymentParams {
+  /**
+   * The amount of the payment, in cents
+   */
+  amount: number;
+
+  /**
+   * The wallet address the payment is being sent from
+   */
+  walletAddress: string;
+
+  /**
+   * The chain ID (base-10 number) that the payment transaction is on
+   */
+  chainId?: number;
+}
+
+Companies.Signatures = Signatures;
+
+export declare namespace Companies {
+  export {
+    type IssuingChargeCreateBody as IssuingChargeCreateBody,
+    type IssuingChargeCreateResponse as IssuingChargeCreateResponse,
+    type IssuingContract as IssuingContract,
+    type CompanyListResponse as CompanyListResponse,
+    type CompanyInitiatePaymentResponse as CompanyInitiatePaymentResponse,
+    type CompanyRetrieveBalancesResponse as CompanyRetrieveBalancesResponse,
+    type CompanyRetrieveContractsResponse as CompanyRetrieveContractsResponse,
+    type CompanyUpdateParams as CompanyUpdateParams,
+    type CompanyListParams as CompanyListParams,
+    type CompanyChargeParams as CompanyChargeParams,
+    type CompanyCreateUserParams as CompanyCreateUserParams,
+    type CompanyInitiatePaymentParams as CompanyInitiatePaymentParams,
+  };
+
+  export {
+    Signatures as Signatures,
+    type IssuingSignature as IssuingSignature,
+    type SignatureRetrievePaymentSignatureParams as SignatureRetrievePaymentSignatureParams,
+    type SignatureRetrieveWithdrawalSignatureParams as SignatureRetrieveWithdrawalSignatureParams,
+  };
+}

package/src/resources/companies/index.ts

@@ -0,0 +1,23 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Companies,
+  type IssuingChargeCreateBody,
+  type IssuingChargeCreateResponse,
+  type IssuingContract,
+  type CompanyListResponse,
+  type CompanyInitiatePaymentResponse,
+  type CompanyRetrieveBalancesResponse,
+  type CompanyRetrieveContractsResponse,
+  type CompanyUpdateParams,
+  type CompanyListParams,
+  type CompanyChargeParams,
+  type CompanyCreateUserParams,
+  type CompanyInitiatePaymentParams,
+} from './companies';
+export {
+  Signatures,
+  type IssuingSignature,
+  type SignatureRetrievePaymentSignatureParams,
+  type SignatureRetrieveWithdrawalSignatureParams,
+} from './signatures';

package/src/resources/companies/signatures.ts

@@ -0,0 +1,162 @@
+// 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 { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Signatures extends APIResource {
+  /**
+   * Retrieve the payment signature for a company, which is required for completing
+   * payment transactions.
+   */
+  retrievePaymentSignature(
+    companyID: string,
+    query: SignatureRetrievePaymentSignatureParams,
+    options?: RequestOptions,
+  ): APIPromise<IssuingSignature> {
+    return this._client.get(path`/companies/${companyID}/signatures/payments`, { query, ...options });
+  }
+
+  /**
+   * Retrieve the withdrawal signature for a company, which is required for
+   * processing withdrawal requests.
+   */
+  retrieveWithdrawalSignature(
+    companyID: string,
+    query: SignatureRetrieveWithdrawalSignatureParams,
+    options?: RequestOptions,
+  ): APIPromise<IssuingSignature> {
+    return this._client.get(path`/companies/${companyID}/signatures/withdrawals`, { query, ...options });
+  }
+}
+
+/**
+ * Indicates the signature is pending and provides the time after which a retry is
+ * possible.
+ */
+export type IssuingSignature = IssuingSignature.IfSignatureIsPending | IssuingSignature.IfSignatureIsReady;
+
+export namespace IssuingSignature {
+  /**
+   * Indicates the signature is pending and provides the time after which a retry is
+   * possible.
+   */
+  export interface IfSignatureIsPending {
+    /**
+     * The number of seconds after which the signature can be retried
+     */
+    retryAfter: number;
+
+    /**
+     * The status of the signature
+     */
+    status: 'pending';
+  }
+
+  /**
+   * Indicates that the signature is ready and includes the signature data and
+   * expiration time.
+   */
+  export interface IfSignatureIsReady {
+    signature: IfSignatureIsReady.Signature;
+
+    /**
+     * The status of the signature
+     */
+    status: 'ready';
+
+    /**
+     * The time at which the signature will expire
+     */
+    expiresAt?: string;
+  }
+
+  export namespace IfSignatureIsReady {
+    export interface Signature {
+      /**
+       * The actual signature data
+       */
+      data: string;
+
+      /**
+       * The salt used to generate the signature
+       */
+      salt: string;
+    }
+  }
+}
+
+export interface SignatureRetrievePaymentSignatureParams {
+  /**
+   * The address of the token that the payment should be made in (as a hex string for
+   * EVM or base58 string for Solana)
+   */
+  token: string;
+
+  /**
+   * The address of the admin making the payment, as a hex string for EVM or base58
+   * string for Solana
+   */
+  adminAddress: string;
+
+  /**
+   * The amount of tokens that are being paid
+   */
+  amount: string;
+
+  /**
+   * The chain ID (base-10 number) that the smart contract is deployed on
+   */
+  chainId?: number;
+
+  /**
+   * Indicates whether the amount is in the asset's native units. If false, the
+   * amount is expressed in cents.
+   */
+  isAmountNative?: boolean;
+}
+
+export interface SignatureRetrieveWithdrawalSignatureParams {
+  /**
+   * The address of the token that the withdrawal should be made in, as a hex string
+   * for EVM or base58 string for Solana
+   */
+  token: string;
+
+  /**
+   * The address of the admin making the payment, as a hex string for EVM or base58
+   * string for Solana
+   */
+  adminAddress: string;
+
+  /**
+   * The amount of tokens being withdrawn
+   */
+  amount: string;
+
+  /**
+   * The address the withdrawal should be sent to, as a hex string for EVM or base58
+   * string for Solana
+   */
+  recipientAddress: string;
+
+  /**
+   * The chain ID (base-10 number) that the smart contract is deployed on
+   */
+  chainId?: number;
+
+  /**
+   * Indicates whether the amount is in the asset's native units. If false, the
+   * amount is expressed in cents.
+   */
+  isAmountNative?: boolean;
+}
+
+export declare namespace Signatures {
+  export {
+    type IssuingSignature as IssuingSignature,
+    type SignatureRetrievePaymentSignatureParams as SignatureRetrievePaymentSignatureParams,
+    type SignatureRetrieveWithdrawalSignatureParams as SignatureRetrieveWithdrawalSignatureParams,
+  };
+}

package/src/resources/companies.ts

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

package/src/resources/contracts.ts

@@ -0,0 +1,21 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as CompaniesAPI from './companies/companies';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+export class Contracts extends APIResource {
+  /**
+   * Retrieve the smart contract information for a specific authorized user tenant.
+   */
+  list(options?: RequestOptions): APIPromise<ContractListResponse> {
+    return this._client.get('/contracts', options);
+  }
+}
+
+export type ContractListResponse = Array<CompaniesAPI.IssuingContract>;
+
+export declare namespace Contracts {
+  export { type ContractListResponse as ContractListResponse };
+}

package/src/resources/disputes/disputes.ts

@@ -0,0 +1,135 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as EvidenceAPI from './evidence';
+import { Evidence, EvidenceUploadParams } from './evidence';
+import { APIPromise } from '../../core/api-promise';
+import { buildHeaders } from '../../internal/headers';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Disputes extends APIResource {
+  evidence: EvidenceAPI.Evidence = new EvidenceAPI.Evidence(this._client);
+
+  /**
+   * Retrieve details of a specific dispute using its unique ID.
+   */
+  retrieve(disputeID: string, options?: RequestOptions): APIPromise<IssuingDispute> {
+    return this._client.get(path`/disputes/${disputeID}`, options);
+  }
+
+  /**
+   * Update the status or evidence of a dispute, typically to mark it as canceled or
+   * add new evidence.
+   */
+  update(
+    disputeID: string,
+    body: DisputeUpdateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<void> {
+    return this._client.patch(path`/disputes/${disputeID}`, {
+      body,
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Retrieve all disputes, optionally filtered by company, user, or transaction ID.
+   */
+  list(
+    query: DisputeListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<DisputeListResponse> {
+    return this._client.get('/disputes', { query, ...options });
+  }
+}
+
+/**
+ * Represents a dispute related to an issuing transaction.
+ */
+export interface IssuingDispute {
+  /**
+   * The dispute's unique identifier
+   */
+  id: string;
+
+  /**
+   * The date and time when the dispute was created
+   */
+  createdAt: string;
+
+  /**
+   * The current status of the dispute
+   */
+  status: 'pending' | 'inReview' | 'accepted' | 'rejected' | 'canceled';
+
+  /**
+   * The transaction's unique identifier
+   */
+  transactionId: string;
+
+  /**
+   * The date and time when the dispute was resolved, if applicable
+   */
+  resolvedAt?: string;
+
+  /**
+   * Textual evidence provided by the parties involved in the dispute
+   */
+  textEvidence?: string;
+}
+
+export type DisputeListResponse = Array<IssuingDispute>;
+
+export interface DisputeUpdateParams {
+  /**
+   * The new status of the dispute. Can only be set to 'canceled'.
+   */
+  status?: 'canceled';
+
+  /**
+   * The textual evidence to add to the dispute
+   */
+  textEvidence?: string;
+}
+
+export interface DisputeListParams {
+  /**
+   * For corporate cards, the identifier of the company to get disputes for
+   */
+  companyId?: string;
+
+  /**
+   * The ID of the resource after which to start fetching
+   */
+  cursor?: string;
+
+  /**
+   * The number of resources to fetch
+   */
+  limit?: number;
+
+  /**
+   * The ID of the transaction to get disputes for
+   */
+  transactionId?: string;
+
+  /**
+   * The ID of the user to get disputes for
+   */
+  userId?: string;
+}
+
+Disputes.Evidence = Evidence;
+
+export declare namespace Disputes {
+  export {
+    type IssuingDispute as IssuingDispute,
+    type DisputeListResponse as DisputeListResponse,
+    type DisputeUpdateParams as DisputeUpdateParams,
+    type DisputeListParams as DisputeListParams,
+  };
+
+  export { Evidence as Evidence, type EvidenceUploadParams as EvidenceUploadParams };
+}