repzo 1.0.59 → 1.0.61

package/lib/index.d.ts

@@ -610,6 +610,36 @@ export default class Repzo {
       body: Service.Refund.Update.Body
     ) => Promise<Service.Refund.Update.Result>;
   };
+  settlement: {
+    _path: string;
+    find: (
+      params?: Service.Settlement.Find.Params
+    ) => Promise<Service.Settlement.Find.Result>;
+    get: (
+      id: Service.Settlement.Get.ID,
+      params?: Service.Settlement.Get.Params
+    ) => Promise<Service.Settlement.Get.Result>;
+    create: (
+      body: Service.Settlement.Create.Body
+    ) => Promise<Service.Settlement.Create.Result>;
+    update: (
+      id: Service.Settlement.Update.ID,
+      body: Service.Settlement.Update.Body
+    ) => Promise<Service.Settlement.Update.Result>;
+  };
+  check: {
+    _path: string;
+    find: (
+      params?: Service.Check.Find.Params
+    ) => Promise<Service.Check.Find.Result>;
+    get: (
+      id: Service.Check.Get.ID,
+      params?: Service.Check.Get.Params
+    ) => Promise<Service.Check.Get.Result>;
+    create: (
+      body: Service.Check.Create.Body
+    ) => Promise<Service.Check.Create.Result>;
+  };
   transfer: {
     _path: string;
     find: (

package/lib/index.js

@@ -1256,6 +1256,66 @@ export default class Repzo {
         return res;
       },
     };
+    this.settlement = {
+      _path: "/settlement",
+      find: async (params) => {
+        let res = await this._fetch(
+          this.svAPIEndpoint,
+          this.settlement._path,
+          params
+        );
+        return res;
+      },
+      get: async (id, params) => {
+        return await this._fetch(
+          this.svAPIEndpoint,
+          this.settlement._path + `/${id}`,
+          params
+        );
+      },
+      create: async (body) => {
+        let res = await this._create(
+          this.svAPIEndpoint,
+          this.settlement._path,
+          body
+        );
+        return res;
+      },
+      update: async (id, body) => {
+        let res = await this._update(
+          this.svAPIEndpoint,
+          this.settlement._path + `/${id}`,
+          body
+        );
+        return res;
+      },
+    };
+    this.check = {
+      _path: "/checks",
+      find: async (params) => {
+        let res = await this._fetch(
+          this.svAPIEndpoint,
+          this.check._path,
+          params
+        );
+        return res;
+      },
+      get: async (id, params) => {
+        return await this._fetch(
+          this.svAPIEndpoint,
+          this.check._path + `/${id}`,
+          params
+        );
+      },
+      create: async (body) => {
+        let res = await this._create(
+          this.svAPIEndpoint,
+          this.check._path,
+          body
+        );
+        return res;
+      },
+    };
     this.transfer = {
       _path: "/transfer",
       find: async (params) => {

package/lib/types/index.d.ts

@@ -5060,6 +5060,7 @@ export declare namespace Service {
       client_id: string;
       client_name: string;
       creator: AdminCreator | RepCreator;
+      implemented_by?: AdminCreator | RepCreator;
       time?: number;
       serial_number: SerialNumber;
       route?: string;
@@ -5194,6 +5195,236 @@ export declare namespace Service {
     }
     export {};
   }
+  namespace Settlement {
+    export interface SettlementSchema {
+      _id: string;
+      amount: number;
+      creator: {
+        _id: string;
+        type: "admin" | "rep";
+        admin?: string;
+        rep?: string;
+        name: string;
+      };
+      origin: {
+        _id: string;
+        type: "rep";
+        name: string;
+        rep?: string;
+      };
+      time?: number;
+      serial_number: SerialNumber;
+      paytime: string;
+      note?: string;
+      payment_type: "check" | "cash";
+      check_id?: string;
+      teams: string[];
+      company_namespace: string[];
+      sync_id: string;
+      transaction_processed: boolean;
+      createdAt: Date;
+      updatedAt: Date;
+    }
+    export interface CreateBody {
+      amount: number;
+      time?: number;
+      serial_number: SerialNumber;
+      paytime: string;
+      note?: string;
+      payment_type: "check" | "cash";
+      check_id?: string;
+      teams: string[];
+      company_namespace: string[];
+      sync_id: string;
+      transaction_processed: boolean;
+    }
+    export interface UpdateBody {
+      _id?: string;
+      amount?: number;
+      creator?: {
+        _id: string;
+        type: "admin" | "rep";
+        admin?: string;
+        rep?: string;
+        name: string;
+      };
+      origin?: {
+        _id: string;
+        type: "rep";
+        name: string;
+        rep?: string;
+      };
+      time?: number;
+      serial_number?: SerialNumber;
+      paytime?: string;
+      note?: string;
+      payment_type?: "check" | "cash";
+      check_id?: string;
+      teams?: string[];
+      company_namespace?: string[];
+      sync_id?: string;
+      transaction_processed?: boolean;
+    }
+    type SettlementSchemaWithPopulatedKeys = SettlementSchema & {
+      teams_populated?: string[] | Team.TeamSchema[];
+      check_populated?: string | Check.CheckSchema;
+    };
+    type PopulatedKeys = "teams" | "check_id";
+    export namespace Find {
+      type Params = DefaultPaginationQueryParams & {
+        _id?: string[] | string;
+        "creator._id"?: string[] | string;
+        "origin._id"?: string[] | string;
+        amount?: number;
+        payment_type?: string;
+        from_createdAt?: number;
+        to_createdAt?: number;
+        from_updatedAt?: number;
+        [key: string]: any;
+        populatedKeys?: PopulatedKeys[];
+      };
+      interface Result extends DefaultPaginationResult {
+        data: SettlementSchemaWithPopulatedKeys[];
+        absolute_total: number;
+        page_total: number;
+      }
+    }
+    export namespace Get {
+      type ID = string;
+      interface Params {
+        populatedKeys?: PopulatedKeys[];
+      }
+      type Result = SettlementSchemaWithPopulatedKeys;
+    }
+    export namespace Create {
+      type Body = CreateBody;
+      type Result = SettlementSchema;
+    }
+    export namespace Update {
+      type ID = string;
+      type Body = UpdateBody;
+      type Result = SettlementSchema;
+    }
+    export {};
+  }
+  namespace Check {
+    export interface CheckSchema {
+      _id: string;
+      drawer_name: string;
+      bank: string;
+      bank_branch: string;
+      check_number: number;
+      amount: number;
+      check_date: string;
+      photo?: string;
+      media?: string[];
+      caption: {
+        type: String;
+        default: null;
+      };
+      photo_meta?: {
+        device_orientation?: 1 | 2 | 3 | 4;
+        height?: 1 | 2 | 3 | 4;
+        width?: 1 | 2 | 3 | 4;
+      };
+      paytime: string;
+      client_id: string;
+      client_name: string;
+      creator: {
+        _id: string;
+        type: "rep" | "admin";
+        rep?: string;
+        admin?: string;
+        name?: string;
+      };
+      sync_id: string;
+      payment_serial_number: SerialNumber;
+      refund_serial_number?: SerialNumber;
+      disabled: boolean;
+      settled?: boolean;
+      teams?: string[];
+      company_namespace: string[];
+      createdAt: Date;
+      updatedAt: Date;
+    }
+    export interface CreateBody {
+      drawer_name: string;
+      bank: string;
+      bank_branch: string;
+      check_number: number;
+      amount: number;
+      check_date: string;
+      photo?: string;
+      media?: string[];
+      caption: {
+        type: String;
+        default: null;
+      };
+      photo_meta?: {
+        device_orientation?: 1 | 2 | 3 | 4;
+        height?: 1 | 2 | 3 | 4;
+        width?: 1 | 2 | 3 | 4;
+      };
+      paytime: string;
+      client_id: string;
+      client_name: string;
+      creator: {
+        _id: string;
+        type: "rep" | "admin";
+        rep?: string;
+        admin?: string;
+        name?: string;
+      };
+      sync_id: string;
+      payment_serial_number: SerialNumber;
+      refund_serial_number?: SerialNumber;
+      disabled: boolean;
+      settled?: boolean;
+      teams?: string[];
+      company_namespace: string[];
+    }
+    type CheckSchemaWithPopulatedKeys = CheckSchema & {
+      teams?: string[] | Team.TeamSchema[];
+      bank?: string | Bank.BankSchema;
+      client_id?: string | Client.ClientSchema;
+    };
+    type PopulatedKeys = "bank" | "teams" | "client_id";
+    export namespace Find {
+      type Params = DefaultPaginationQueryParams & {
+        _id?: string[] | string;
+        "creator._id"?: string[] | string;
+        client_id?: string[] | string;
+        check_number?: number;
+        client_name?: string;
+        rep_name?: string;
+        drawer_name?: string;
+        bank_name?: string;
+        amount?: number;
+        settled?: boolean;
+        from_updatedAt?: number;
+        [key: string]: any;
+        populatedKeys?: PopulatedKeys[];
+      };
+      interface Result extends DefaultPaginationResult {
+        data: CheckSchemaWithPopulatedKeys[];
+        absolute_total: number;
+        page_total: number;
+      }
+    }
+    export namespace Get {
+      type ID = string;
+      interface Params {
+        withPrintDetails?: boolean;
+        populatedKeys?: PopulatedKeys[];
+      }
+      type Result = CheckSchemaWithPopulatedKeys;
+    }
+    export namespace Create {
+      type Body = CreateBody;
+      type Result = CheckSchema;
+    }
+    export {};
+  }
   namespace Cycle {
     type CycleStatus = "pending" | "approved" | "processing" | "rejected";
     export interface Schema {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "repzo",
-  "version": "1.0.59",
+  "version": "1.0.61",
   "description": "Repzo TypeScript SDK",
   "main": "./lib/index.js",
   "type": "module",

package/src/index.ts

@@ -1792,6 +1792,88 @@ export default class Repzo {
     },
   };
 
+  settlement = {
+    _path: "/settlement",
+
+    find: async (
+      params?: Service.Settlement.Find.Params
+    ): Promise<Service.Settlement.Find.Result> => {
+      let res: Service.Settlement.Find.Result = await this._fetch(
+        this.svAPIEndpoint,
+        this.settlement._path,
+        params
+      );
+      return res;
+    },
+
+    get: async (
+      id: Service.Settlement.Get.ID,
+      params?: Service.Settlement.Get.Params
+    ): Promise<Service.Settlement.Get.Result> => {
+      return await this._fetch(
+        this.svAPIEndpoint,
+        this.settlement._path + `/${id}`,
+        params
+      );
+    },
+
+    create: async (
+      body: Service.Settlement.Create.Body
+    ): Promise<Service.Settlement.Create.Result> => {
+      let res = await this._create(
+        this.svAPIEndpoint,
+        this.settlement._path,
+        body
+      );
+      return res;
+    },
+
+    update: async (
+      id: Service.Settlement.Update.ID,
+      body: Service.Settlement.Update.Body
+    ): Promise<Service.Settlement.Update.Result> => {
+      let res: Service.Settlement.Update.Result = await this._update(
+        this.svAPIEndpoint,
+        this.settlement._path + `/${id}`,
+        body
+      );
+      return res;
+    },
+  };
+
+  check = {
+    _path: "/checks",
+
+    find: async (
+      params?: Service.Check.Find.Params
+    ): Promise<Service.Check.Find.Result> => {
+      let res: Service.Check.Find.Result = await this._fetch(
+        this.svAPIEndpoint,
+        this.check._path,
+        params
+      );
+      return res;
+    },
+
+    get: async (
+      id: Service.Check.Get.ID,
+      params?: Service.Check.Get.Params
+    ): Promise<Service.Check.Get.Result> => {
+      return await this._fetch(
+        this.svAPIEndpoint,
+        this.check._path + `/${id}`,
+        params
+      );
+    },
+
+    create: async (
+      body: Service.Check.Create.Body
+    ): Promise<Service.Check.Create.Result> => {
+      let res = await this._create(this.svAPIEndpoint, this.check._path, body);
+      return res;
+    },
+  };
+
   transfer = {
     _path: "/transfer",
     find: async (

package/src/types/index.ts

@@ -5066,6 +5066,7 @@ export namespace Service {
       client_id: string;
       client_name: string;
       creator: AdminCreator | RepCreator;
+      implemented_by?: AdminCreator | RepCreator;
       time?: number;
       serial_number: SerialNumber;
       route?: string;
@@ -5195,6 +5196,235 @@ export namespace Service {
       export type Result = RefundSchema;
     }
   }
+  export namespace Settlement {
+    export interface SettlementSchema {
+      _id: string;
+      amount: number;
+      creator: {
+        _id: string;
+        type: "admin" | "rep";
+        admin?: string;
+        rep?: string;
+        name: string;
+      };
+      origin: {
+        _id: string;
+        type: "rep";
+        name: string;
+        rep?: string;
+      };
+      time?: number;
+      serial_number: SerialNumber;
+      paytime: string;
+      note?: string;
+      payment_type: "check" | "cash";
+      check_id?: string;
+      teams: string[];
+      company_namespace: string[];
+      sync_id: string;
+      transaction_processed: boolean;
+      createdAt: Date;
+      updatedAt: Date;
+    }
+    export interface CreateBody {
+      amount: number;
+      time?: number;
+      serial_number: SerialNumber;
+      paytime: string;
+      note?: string;
+      payment_type: "check" | "cash";
+      check_id?: string;
+      teams: string[];
+      company_namespace: string[];
+      sync_id: string;
+      transaction_processed: boolean;
+    }
+    export interface UpdateBody {
+      _id?: string;
+      amount?: number;
+      creator?: {
+        _id: string;
+        type: "admin" | "rep";
+        admin?: string;
+        rep?: string;
+        name: string;
+      };
+      origin?: {
+        _id: string;
+        type: "rep";
+        name: string;
+        rep?: string;
+      };
+      time?: number;
+      serial_number?: SerialNumber;
+      paytime?: string;
+      note?: string;
+      payment_type?: "check" | "cash";
+      check_id?: string;
+      teams?: string[];
+      company_namespace?: string[];
+      sync_id?: string;
+      transaction_processed?: boolean;
+    }
+
+    type SettlementSchemaWithPopulatedKeys = SettlementSchema & {
+      teams_populated?: string[] | Team.TeamSchema[];
+      check_populated?: string | Check.CheckSchema;
+    };
+    type PopulatedKeys = "teams" | "check_id";
+    export namespace Find {
+      export type Params = DefaultPaginationQueryParams & {
+        _id?: string[] | string;
+        "creator._id"?: string[] | string;
+        "origin._id"?: string[] | string;
+        amount?: number;
+        payment_type?: string;
+        from_createdAt?: number;
+        to_createdAt?: number;
+        from_updatedAt?: number;
+        [key: string]: any; // integration_meta.
+        populatedKeys?: PopulatedKeys[];
+      };
+      export interface Result extends DefaultPaginationResult {
+        data: SettlementSchemaWithPopulatedKeys[];
+        absolute_total: number;
+        page_total: number;
+      }
+    }
+
+    export namespace Get {
+      export type ID = string;
+      export interface Params {
+        populatedKeys?: PopulatedKeys[];
+      }
+      export type Result = SettlementSchemaWithPopulatedKeys;
+    }
+
+    export namespace Create {
+      export type Body = CreateBody;
+      export type Result = SettlementSchema;
+    }
+
+    export namespace Update {
+      export type ID = string;
+      export type Body = UpdateBody;
+      export type Result = SettlementSchema;
+    }
+  }
+
+  export namespace Check {
+    export interface CheckSchema {
+      _id: string;
+      drawer_name: string;
+      bank: string;
+      bank_branch: string;
+      check_number: number;
+      amount: number;
+      check_date: string;
+      photo?: string;
+      media?: string[];
+      caption: { type: String; default: null };
+      photo_meta?: {
+        device_orientation?: 1 | 2 | 3 | 4;
+        height?: 1 | 2 | 3 | 4;
+        width?: 1 | 2 | 3 | 4;
+      };
+      paytime: string;
+      client_id: string;
+      client_name: string;
+      creator: {
+        _id: string;
+        type: "rep" | "admin";
+        rep?: string;
+        admin?: string;
+        name?: string;
+      };
+      sync_id: string;
+      payment_serial_number: SerialNumber;
+      refund_serial_number?: SerialNumber;
+      disabled: boolean;
+      settled?: boolean;
+      teams?: string[];
+      company_namespace: string[];
+      createdAt: Date;
+      updatedAt: Date;
+    }
+    export interface CreateBody {
+      drawer_name: string;
+      bank: string;
+      bank_branch: string;
+      check_number: number;
+      amount: number;
+      check_date: string;
+      photo?: string;
+      media?: string[];
+      caption: { type: String; default: null };
+      photo_meta?: {
+        device_orientation?: 1 | 2 | 3 | 4;
+        height?: 1 | 2 | 3 | 4;
+        width?: 1 | 2 | 3 | 4;
+      };
+      paytime: string;
+      client_id: string;
+      client_name: string;
+      creator: {
+        _id: string;
+        type: "rep" | "admin";
+        rep?: string;
+        admin?: string;
+        name?: string;
+      };
+      sync_id: string;
+      payment_serial_number: SerialNumber;
+      refund_serial_number?: SerialNumber;
+      disabled: boolean;
+      settled?: boolean;
+      teams?: string[];
+      company_namespace: string[];
+    }
+    type CheckSchemaWithPopulatedKeys = CheckSchema & {
+      teams?: string[] | Team.TeamSchema[];
+      bank?: string | Bank.BankSchema;
+      client_id?: string | Client.ClientSchema;
+    };
+    type PopulatedKeys = "bank" | "teams" | "client_id";
+    export namespace Find {
+      export type Params = DefaultPaginationQueryParams & {
+        _id?: string[] | string;
+        "creator._id"?: string[] | string;
+        client_id?: string[] | string;
+        check_number?: number;
+        client_name?: string;
+        rep_name?: string;
+        drawer_name?: string;
+        bank_name?: string;
+        amount?: number;
+        settled?: boolean;
+        from_updatedAt?: number;
+        [key: string]: any; // integration_meta.
+        populatedKeys?: PopulatedKeys[];
+      };
+      export interface Result extends DefaultPaginationResult {
+        data: CheckSchemaWithPopulatedKeys[];
+        absolute_total: number;
+        page_total: number;
+      }
+    }
+
+    export namespace Get {
+      export type ID = string;
+      export interface Params {
+        withPrintDetails?: boolean;
+        populatedKeys?: PopulatedKeys[];
+      }
+      export type Result = CheckSchemaWithPopulatedKeys;
+    }
+
+    export namespace Create {
+      export type Body = CreateBody;
+      export type Result = CheckSchema;
+    }
+  }
 
   export namespace Cycle {
     type CycleStatus = "pending" | "approved" | "processing" | "rejected";