Skip to content

Added types for user statements. #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
john-fowler wants to merge 1 commit into
base: types-master
Choose a base branch
from
Open

Added types for user statements. #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 69 additions & 0 deletions src/interfaces/statement.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
export interface IGetStatementsApiResponse {
error_code: string;
http_code: string;
limit: number;
page: number;
page_count: number;
statements_count: number;
statements: (IStatementObject|IInterestIncome1099)[],
success: boolean;
}

/**
* {@link [Statement Object Details](https://docs.synapsefi.com/api-references/statements/statement-object-details)}
*/
export interface IStatementObject {
_id: string;
client: {
id: string;
name: string;
user_id: string;
};
date_end: number;
date_start: number;
end_date: number;
ending_balance: number;
is_fee_node: boolean;
node: IStatementNode;
node_id: string;
opening_balance: number;
start_date: number;
subnet: IStatementSubnet;
type: string;
urls: {
csv: string;
json: string;
pdf: string;
};
user_id: string;
user_name: string;
}

export interface IStatementNode {
created_on: number;
currency: string;
nickname: string;
type: string;
}

export interface IStatementSubnet {
account_num: string;
ach: string;
has_subnet: boolean;
wire: string;
}


/**
* {@link [Undocumented Object Details, but referenced in the 'type' property](https://docs.synapsefi.com/api-references/statements/statement-object-details)}
*/
export interface IInterestIncome1099 {
_id: string;
client_id: string;
date_end: number;
date_start: number;
link: string;
node_id: string;
type: string;
user_id: string;
}
5 changes: 3 additions & 2 deletions src/lib/User.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import { IUserObject } from "../interfaces/user";
import { IgenECashBarcodePayload, IGetNodesApiResponse, INodeDetailsObject } from "../interfaces/node";
import { IDisputeTransactionPayload, IGetTransactionsApiResponse, ITransactionDetailsObject } from "../interfaces/transaction";
import { IGetShipmentsApiResponse, IGetSubnetsApiResponse, IShipmentObject, ISubnetDetailsObject } from "../interfaces/subnet";
import { IGetStatementsApiResponse } from "../interfaces/statement";

class User {
id: string;
Expand Down Expand Up @@ -329,7 +330,7 @@ class User {
*/
getStatementsByUser(
queryParams: IQueryParams = {}
): Promise<AxiosResponse<any>> {
): Promise<AxiosResponse<IGetStatementsApiResponse>> {
const { page, per_page } = queryParams;
const { host, headers, id } = this;
const originalUrl = `${host}/users/${id}/statements`;
Expand All @@ -354,7 +355,7 @@ class User {
getStatementsByNode(
node_id: string,
queryParams: IQueryParams = {}
): Promise<AxiosResponse<any>> {
): Promise<AxiosResponse<IGetStatementsApiResponse>> {
const { page, per_page } = queryParams;
const { host, headers, id } = this;
const originalUrl = `${host}/users/${id}/nodes/${node_id}/statements`;
Expand Down
64 changes: 64 additions & 0 deletions types/interfaces/statement.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
export interface IGetStatementsApiResponse {
error_code: string;
http_code: string;
limit: number;
page: number;
page_count: number;
statements_count: number;
statements: (IStatementObject | IInterestIncome1099)[];
success: boolean;
}
/**
* {@link [Statement Object Details](https://docs.synapsefi.com/api-references/statements/statement-object-details)}
*/
export interface IStatementObject {
_id: string;
client: {
id: string;
name: string;
user_id: string;
};
date_end: number;
date_start: number;
end_date: number;
ending_balance: number;
is_fee_node: boolean;
node: IStatementNode;
node_id: string;
opening_balance: number;
start_date: number;
subnet: IStatementSubnet;
type: string;
urls: {
csv: string;
json: string;
pdf: string;
};
user_id: string;
user_name: string;
}
export interface IStatementNode {
created_on: number;
currency: string;
nickname: string;
type: string;
}
export interface IStatementSubnet {
account_num: string;
ach: string;
has_subnet: boolean;
wire: string;
}
/**
* {@link [Undocumented Object Details, but referenced in the 'type' property](https://docs.synapsefi.com/api-references/statements/statement-object-details)}
*/
export interface IInterestIncome1099 {
_id: string;
client_id: string;
date_end: number;
date_start: number;
link: string;
node_id: string;
type: string;
user_id: string;
}
5 changes: 3 additions & 2 deletions types/lib/User.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import { IUserObject } from "../interfaces/user";
import { IgenECashBarcodePayload, IGetNodesApiResponse, INodeDetailsObject } from "../interfaces/node";
import { IDisputeTransactionPayload, IGetTransactionsApiResponse, ITransactionDetailsObject } from "../interfaces/transaction";
import { IGetShipmentsApiResponse, IGetSubnetsApiResponse, IShipmentObject, ISubnetDetailsObject } from "../interfaces/subnet";
import { IGetStatementsApiResponse } from "../interfaces/statement";
declare class User {
id: string;
body: IUserObject;
Expand Down Expand Up @@ -126,7 +127,7 @@ declare class User {
* {@link [Statement Object Details](https://docs.synapsefi.com/api-references/statements/statement-object-details)}
* {@link [View all user statements](https://docs.synapsefi.com/api-references/statements/view-all-user-statements)}
*/
getStatementsByUser(queryParams?: IQueryParams): Promise<AxiosResponse<any>>;
getStatementsByUser(queryParams?: IQueryParams): Promise<AxiosResponse<IGetStatementsApiResponse>>;
/**
* @description gets list of statement objects base on passed node id
* @param queryParams
Expand All @@ -135,7 +136,7 @@ declare class User {
* {@link [Statement Object Details](https://docs.synapsefi.com/api-references/statements/statement-object-details)}
* {@link [View all node statements](https://docs.synapsefi.com/api-references/statements/view-all-node-statements)}
*/
getStatementsByNode(node_id: string, queryParams?: IQueryParams): Promise<AxiosResponse<any>>;
getStatementsByNode(node_id: string, queryParams?: IQueryParams): Promise<AxiosResponse<IGetStatementsApiResponse>>;
/**
* @deprecated use `shipCard` instead
*/
Expand Down