@monerium/sdk 2.0.2 → 2.0.4

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## [2.0.4](https://github.com/monerium/sdk/compare/v2.0.3...v2.0.4) (2023-01-05)
+
+### Bug Fixes
+
+- variable is a string ([831bcca](https://github.com/monerium/sdk/commit/831bcca6b1b646dc4a537790fe07d1195903a070))
+- workflow not triggering static page deploy ([#12](https://github.com/monerium/sdk/issues/12)) ([d481570](https://github.com/monerium/sdk/commit/d48157046a65b46a31e75d1212158a9178f509e1))
+
+## [2.0.3](https://github.com/monerium/sdk/compare/v2.0.2...v2.0.3) (2023-01-05)
+
+### Bug Fixes
+
+- build missing and static page deploy not being triggered([#7](https://github.com/monerium/sdk/issues/7)) ([#9](https://github.com/monerium/sdk/issues/9)) ([0c5e955](https://github.com/monerium/sdk/commit/0c5e955a9823c9d2c79cac5d21120fa49ce79741))
+- workflow ([cb27cb4](https://github.com/monerium/sdk/commit/cb27cb484e6f46beb379d9e46d1874c436eb7208))
+- workflow broken ([09623f0](https://github.com/monerium/sdk/commit/09623f0eee78535ee5e3712e6009e44c6082bbd7))
+
 ## [2.0.2](https://github.com/monerium/sdk/compare/v2.0.1...v2.0.2) (2023-01-05)
 
 ### Bug Fixes

package/dist/index.d.ts

@@ -0,0 +1,314 @@
+// Generated by dts-bundle-generator v7.1.0
+
+export type Environment = {
+  api: string;
+  web: string;
+};
+export type Config = {
+  environments: {
+    production: Environment;
+    sandbox: Environment;
+  };
+};
+export interface BearerProfile {
+  access_token: string;
+  token_type: string;
+  expires_in: number;
+  refresh_token: string;
+  profile: string;
+  userId: string;
+}
+export declare enum Currency {
+  eur = "eur",
+  usd = "usd",
+  gbp = "gbp",
+  isk = "isk",
+}
+export type AuthArgs =
+  | Omit<AuthCode, "grant_type">
+  | Omit<RefreshToken, "grant_type">
+  | Omit<ClientCredentials, "grant_type">;
+export interface AuthCode {
+  grant_type: "authorization_code";
+  client_id: string;
+  code: string;
+  code_verifier: string;
+  redirect_uri: string;
+  scope?: string;
+}
+export interface RefreshToken {
+  grant_type: "refresh_token";
+  client_id: string;
+  refresh_token: string;
+  scope?: string;
+}
+export interface ClientCredentials {
+  grant_type: "client_credentials";
+  client_id: string;
+  client_secret: string;
+  scope?: string;
+}
+export type PKCERequestArgs = Omit<
+  PKCERequest,
+  "code_challenge" | "code_challenge_method" | "response_type"
+>;
+export type PKCERequest = {
+  client_id: string;
+  code_challenge: string;
+  code_challenge_method: string;
+  response_type: string;
+  state: string;
+  redirect_uri?: string;
+  scope?: string;
+  address?: string;
+};
+declare enum Method {
+  password = "password",
+  resource = "resource",
+  jwt = "jwt",
+  apiKey = "apiKey",
+}
+export declare enum ProfileType {
+  corporate = "corporate",
+  personal = "personal",
+}
+export declare enum Permission {
+  read = "read",
+  write = "write",
+}
+export interface AuthProfile {
+  id: string;
+  type: ProfileType;
+  name: string;
+  perms: Permission[];
+}
+export interface AuthContext {
+  userId: string;
+  email: string;
+  name: string;
+  roles: "admin"[];
+  auth: {
+    method: Method;
+    subject: string;
+    verified: boolean;
+  };
+  defaultProfile: string;
+  profiles: AuthProfile[];
+}
+export declare enum KYCState {
+  absent = "absent",
+  submitted = "submitted",
+  pending = "pending",
+  confirmed = "confirmed",
+}
+export declare enum KYCOutcome {
+  approved = "approved",
+  rejected = "rejected",
+  unknown = "unknown",
+}
+export interface KYC {
+  state: KYCState;
+  outcome: KYCOutcome;
+}
+export declare enum PaymentStandard {
+  iban = "iban",
+  scan = "scan",
+}
+export interface Account {
+  address: string;
+  currency: Currency;
+  standard: PaymentStandard;
+  iban?: string;
+  sortCode?: string;
+  accountNumber?: string;
+  network: Network;
+  chain: Chain;
+  id?: string;
+}
+export interface Profile {
+  id: string;
+  name: string;
+  kyc: KYC;
+  accounts: Account[];
+}
+export declare enum Chain {
+  polygon = "polygon",
+  ethereum = "ethereum",
+  gnosis = "gnosis",
+}
+export declare enum Network {
+  mainnet = "mainnet",
+  chiado = "chiado",
+  goerli = "goerli",
+  mumbai = "mumbai",
+}
+export interface Balance {
+  currency: Currency;
+  amount: string;
+}
+export interface Balances {
+  id: string;
+  address: string;
+  chain: Chain;
+  network: Network;
+  balances: Balance[];
+}
+export declare enum OrderKind {
+  redeem = "redeem",
+  issue = "issue",
+}
+export declare enum OrderState {
+  placed = "placed",
+  pending = "pending",
+  processed = "processed",
+  rejected = "rejected",
+}
+export interface Fee {
+  provider: "satchel";
+  currency: Currency;
+  amount: string;
+}
+export interface IBAN {
+  standard: PaymentStandard.iban;
+  iban: string;
+}
+export interface SCAN {
+  standard: PaymentStandard.scan;
+  sortCode: string;
+  accountNumber: string;
+}
+export interface Individual {
+  firstName: string;
+  lastName: string;
+  country?: string;
+}
+export interface Corporation {
+  companyName: string;
+  country: string;
+}
+export interface Counterpart {
+  identifier: IBAN | SCAN;
+  details: Individual | Corporation;
+}
+export interface OrderMetadata {
+  approvedAt: string;
+  processedAt: string;
+  rejectedAt: string;
+  state: OrderState;
+  placedBy: string;
+  placedAt: string;
+  receivedAmount: string;
+  sentAmount: string;
+}
+export interface OrderFilter {
+  address?: string;
+  txHash?: string;
+  profile?: string;
+  memo?: string;
+  accountId?: string;
+  state?: OrderState;
+}
+export interface Order {
+  id: string;
+  profile: string;
+  accountId: string;
+  address: string;
+  kind: OrderKind;
+  amount: string;
+  currency: Currency;
+  totalFee: string;
+  fees: Fee[];
+  counterpart: Counterpart;
+  memo: string;
+  rejectedReason: string;
+  supportingDocumentId: string;
+  meta: OrderMetadata;
+}
+export interface Token {
+  currency: Currency;
+  ticker: string;
+  symbol: string;
+  chain: Chain;
+  network: Network;
+  address: string;
+  decimals: number;
+}
+export interface NewOrder {
+  kind: OrderKind;
+  amount: string;
+  signature: string;
+  accountId?: string;
+  address: string;
+  currency: Currency;
+  counterpart: Counterpart;
+  message: string;
+  memo: string;
+  supportingDocumentId?: string;
+  chain: Chain;
+  network: Network;
+}
+export interface SupportingDocMetadata {
+  uploadedBy: string;
+  createdAt: string;
+  updatedAt: string;
+}
+export interface SupportingDoc {
+  id: string;
+  name: string;
+  type: string;
+  size: number;
+  hash: string;
+  meta: SupportingDocMetadata;
+}
+export interface CurrencyAccounts {
+  network: Network;
+  chain: Chain;
+  currency: Currency;
+}
+export interface LinkAddress {
+  address: string;
+  message: string;
+  signature: string;
+  accounts: CurrencyAccounts[];
+}
+/**
+ * How to authenticate
+ * ```ts
+ *
+ * import { MoneriumClient } from '@monerium/sdk'
+ *
+ * const client = new MoneriumClient();
+ *
+ * // Start by authenticating
+ * await client.auth({
+ *  client_id:
+ *  client_secret:
+ * })
+ * ```
+ * */
+export declare class MoneriumClient {
+  #private;
+  /** The PKCE code verifier */
+  codeVerifier?: string;
+  bearerProfile?: BearerProfile;
+  constructor(env?: "production" | "sandbox");
+  auth(args: AuthArgs): Promise<void>;
+  pkceRequest(args: PKCERequestArgs): string;
+  getAuthContext(): Promise<AuthContext>;
+  /**
+   * @param {string} profileId - the id of the profile to fetch.
+   */
+  getProfile(profileId: string): Promise<Profile>;
+  /**
+   * @param {string=} profileId - the id of the profile to fetch balances.
+   */
+  getBalances(profileId?: string): Promise<Balances> | Promise<Balances[]>;
+  getOrders(filter?: OrderFilter): Promise<Order[]>;
+  getOrder(orderId: string): Promise<Order>;
+  getTokens(): Promise<Token[]>;
+  linkAddress(profileId: string, body: LinkAddress): Promise<any>;
+  placeOrder(order: NewOrder, profileId?: string): Promise<Order>;
+  uploadSupportingDocument(document: File): Promise<SupportingDoc>;
+}
+
+export {};