@go-avro/avro-js 0.0.4-beta.3 → 0.0.4-beta.31

package/dist/types/api/BillPayment.d.ts

@@ -0,0 +1,13 @@
+export interface BillPayment {
+    id: string;
+    amount: number;
+    avro_fees: number;
+    stripe_fees: number;
+    stripe_pi_id: string;
+    bill_user_id: string;
+    status: "created" | "processing" | "succeeded" | "failed" | "canceled" | "requires_action";
+    type: "us_bank_account" | "card";
+    action_required_at: number;
+    time_created: number;
+    time_updated: number | null;
+}

package/dist/types/api/BillPayment.js

@@ -0,0 +1 @@
+export {};

package/dist/types/api/BillUser.d.ts

@@ -0,0 +1,11 @@
+import { BillPayment } from "../../types/api/BillPayment";
+export interface BillUser {
+    id: string;
+    user_id: string;
+    bill_id: string;
+    invoice_id: string;
+    payment_attempts: BillPayment[];
+    time_created: number;
+    time_updated: number | null;
+    amount: number;
+}

package/dist/types/api/BillUser.js

@@ -0,0 +1 @@
+export {};

package/dist/types/api/Break.d.ts

@@ -0,0 +1,7 @@
+export interface Break {
+    id: string;
+    time_started: number;
+    time_ended: number;
+    company_billable: boolean;
+    client_billable: boolean;
+}

package/dist/types/api/Break.js

@@ -0,0 +1 @@
+export {};

package/dist/types/api/CatalogItem.d.ts

@@ -0,0 +1,16 @@
+import { PaymentOption } from "../../types/api/PaymentOption";
+export interface CatalogItem {
+    id: string;
+    name: string;
+    company_id: string;
+    description: string;
+    industry: string;
+    price_format: string;
+    payment_options: PaymentOption[];
+    recommended_frequency?: number | null;
+    recommended_activate_on?: number | null;
+    recommended_expire_on?: number | null;
+    time_created: number;
+    time_updated: number | null;
+    skills: string[];
+}

package/dist/types/api/CatalogItem.js

@@ -0,0 +1 @@
+export {};

package/dist/types/api/Chat.d.ts

@@ -0,0 +1,12 @@
+import { Message } from "../../types/api/Message";
+import { MemberState } from "../../types/api/MemberState";
+export interface Chat {
+    id: string;
+    name: string;
+    company_id: string;
+    time_created: number;
+    time_updated: number;
+    last_message: Message;
+    user_state: MemberState[];
+    messages: Message[];
+}

package/dist/types/api/Chat.js

@@ -0,0 +1 @@
+export {};

package/dist/types/api/Company.d.ts

@@ -0,0 +1,58 @@
+import { Bill } from "../../types/api/Bill";
+import { Email } from "../../types/api/Email";
+import { Group } from "../../types/api/Group";
+import { Label } from "../../types/api/Label";
+import { PaymentMethod } from "../../types/api/PaymentMethod";
+import { PaymentType } from "../../types/api/PaymentType";
+import { Plan } from "../../types/api/Plan";
+import { PlanPayment } from "../../types/api/PlanPayment";
+import { Session } from "../../types/api/Session";
+import { Skill } from "../../types/api/Skill";
+import { UserCompanyAssociation } from "../../types/api/UserCompanyAssociation";
+import { CatalogItem } from "../../types/api/CatalogItem";
+export interface Company {
+    id: string;
+    name: string;
+    email: string;
+    emails: Email[];
+    skills: Skill[];
+    catalog_items: CatalogItem[];
+    time_created: number;
+    time_updated: number | null;
+    users: UserCompanyAssociation[];
+    use_client_side_customer_start_billing: boolean;
+    use_client_side_customer_stop_billing: boolean;
+    use_client_side_employee_start_billing: boolean;
+    use_client_side_employee_stop_billing: boolean;
+    logo_url: string;
+    delay_scalar: number;
+    payments: PlanPayment[];
+    overdue_threshold: number;
+    stripe_account_id: string;
+    is_restricted: boolean;
+    disabled_reason: string;
+    completed_onboarding: boolean;
+    restricted_soon: boolean;
+    service_email_id: string;
+    billing_email_id: string;
+    num_events: number;
+    num_jobs: number;
+    num_routes: number;
+    num_teams: number;
+    num_skills: number;
+    bills: Bill[];
+    enabled_payment_methods: PaymentType[];
+    sessions: Session[];
+    num_sessions: number;
+    labels: Label[];
+    groups: Group[];
+    indicator_lifetime: number;
+    available_plans: Plan[];
+    last_payment: number;
+    last_charged: number;
+    balance: number;
+    plan_id: string;
+    payment_methods: PaymentMethod[];
+    intuit_connected: boolean;
+    next_payment_due: number | null;
+}

package/dist/types/api/Company.js

@@ -0,0 +1 @@
+export {};

package/dist/types/api/CustomLineItem.d.ts

@@ -0,0 +1,4 @@
+import { LineItem } from "../../types/api/LineItem";
+export interface CustomLineItem extends LineItem {
+    line_item_type: "CUSTOM";
+}

package/dist/types/api/CustomLineItem.js

@@ -0,0 +1 @@
+export {};

package/dist/types/api/Email.d.ts

@@ -0,0 +1,21 @@
+import { User } from "../../types/api/User";
+export interface Email {
+    id: string;
+    company_id: string;
+    name: string;
+    mail_server: string;
+    mail_port: number;
+    mail_username: string;
+    mail_password: string | null;
+    mail_default_sender: string;
+    mail_use_tls: boolean;
+    mail_use_ssl: boolean;
+    mail_api_key: string;
+    is_company_wide: boolean;
+    users: User[];
+    type: "OUTLOOK" | "SMTP" | "GMAIL";
+    access_token?: string;
+    access_token_expiry?: number;
+    refresh_token?: string;
+    refresh_token_expiry?: number;
+}

package/dist/types/api/Email.js

@@ -0,0 +1 @@
+export {};

package/dist/types/api/Friendship.d.ts

@@ -0,0 +1,2 @@
+export interface Friendship {
+}

package/dist/types/api/Friendship.js

@@ -0,0 +1 @@
+export {};

package/dist/types/api/Group.d.ts

@@ -0,0 +1,12 @@
+import { Permission } from "../../types/api/UserCompanyAssociation";
+export interface Group {
+    id: string;
+    name: string;
+    is_active: boolean;
+    is_user_type: boolean;
+    users: string[];
+    permissions: Permission[];
+    company_id: string;
+    time_created: number;
+    time_updated: number;
+}

package/dist/types/api/Group.js

@@ -0,0 +1 @@
+export {};

package/dist/types/api/Job.d.ts

@@ -0,0 +1,36 @@
+import { Task } from "../../types/api/Task";
+import { _Event } from "../../types/api/_Event";
+import { RouteJob } from "../../types/api/RouteJob";
+import { Subscription } from "../../types/api/Subscription";
+declare module '../../types/api/Job' {
+    interface Job {
+        address: string;
+        company: string;
+        description: string;
+        id: string;
+        is_one_time: boolean;
+        autostart_radius: number;
+        latitude: number;
+        longitude: number;
+        name: string;
+        internal_notes: string;
+        external_notes: string;
+        priority: number;
+        tasks: Partial<Task>[];
+        time_created: number;
+        time_updated: number | null;
+        routes: RouteJob[];
+        subscribers: Subscription[];
+        manual_emails: string[][];
+        overdue_time: number;
+        last_completed_event: _Event | null;
+        current_event: _Event | null;
+        labels: string[];
+        owner: string;
+    }
+}
+export declare class Job {
+    constructor(init?: Partial<Job>);
+    portionDone: (fallback?: Date | null, routeJob?: RouteJob) => number;
+    isDone: (fallback?: Date | null, routeJob?: RouteJob) => boolean;
+}

package/dist/types/api/Job.js

@@ -0,0 +1,22 @@
+import { Task } from "../../types/api/Task";
+import { RouteJob } from "../../types/api/RouteJob";
+export class Job {
+    constructor(init) {
+        this.portionDone = (fallback, routeJob) => {
+            if (!this.tasks || this.tasks.length === 0) {
+                return 0;
+            }
+            return this.tasks.filter(t => t.isDone?.(fallback) && (!routeJob || !t.id || routeJob.tasks.includes(t.id))).length / this.tasks.length;
+        };
+        this.isDone = (fallback, routeJob) => {
+            return this.portionDone(fallback, routeJob) === 1;
+        };
+        Object.assign(this, init);
+        if (init?.tasks) {
+            this.tasks = init.tasks.map(t => new Task(t));
+        }
+        if (init?.routes) {
+            this.routes = init.routes.map(r => new RouteJob(r));
+        }
+    }
+}

package/dist/types/api/Label.d.ts

@@ -0,0 +1,7 @@
+export interface Label {
+    name: string;
+    id: string;
+    company_id: string;
+    color: string;
+    jobs: string[];
+}

package/dist/types/api/Label.js

@@ -0,0 +1 @@
+export {};

package/dist/types/api/LineItem.d.ts

@@ -0,0 +1,41 @@
+export declare const LineItemStatus: {
+    readonly CREATED: "CREATED";
+    readonly EXTERNALLY_BILLED: "EXTERNALLY_BILLED";
+    readonly BILLED: "BILLED";
+    readonly PROCESSING: "PROCESSING";
+    readonly EXTERNALLY_PAID: "EXTERNALLY_PAID";
+    readonly PREPAID: "PREPAID";
+    readonly PAID: "PAID";
+};
+export type LineItemStatus = typeof LineItemStatus[keyof typeof LineItemStatus];
+export declare const LineItemType: {
+    readonly CUSTOM: "CUSTOM";
+    readonly ADDITIONAL_CHARGE: "ADDITIONAL_CHARGE";
+    readonly EVENT: "EVENT";
+    readonly SERVICE_MONTH: "SERVICE_MONTH";
+    readonly PREPAYMENT: "PREPAYMENT";
+};
+export type LineItemType = typeof LineItemType[keyof typeof LineItemType];
+declare module '../../types/api/LineItem' {
+    interface LineItem {
+        id: string;
+        line_item_type: LineItemType;
+        name: string;
+        description: string;
+        cost: number;
+        amount: number;
+        status: LineItemStatus;
+        job_id: string;
+        job_name: string;
+        job_address: string;
+        job_labels: string[];
+        company_id: string;
+        time_created: number;
+    }
+}
+export declare class LineItem {
+    constructor(init?: Partial<LineItem>);
+    isPaid: () => boolean;
+    isBilled: () => boolean;
+    isUnbilled: () => boolean;
+}

package/dist/types/api/LineItem.js

@@ -0,0 +1,30 @@
+export const LineItemStatus = {
+    CREATED: "CREATED",
+    EXTERNALLY_BILLED: "EXTERNALLY_BILLED",
+    BILLED: "BILLED",
+    PROCESSING: "PROCESSING",
+    EXTERNALLY_PAID: "EXTERNALLY_PAID",
+    PREPAID: "PREPAID",
+    PAID: "PAID",
+};
+export const LineItemType = {
+    CUSTOM: "CUSTOM",
+    ADDITIONAL_CHARGE: "ADDITIONAL_CHARGE",
+    EVENT: "EVENT",
+    SERVICE_MONTH: "SERVICE_MONTH",
+    PREPAYMENT: "PREPAYMENT",
+};
+export class LineItem {
+    constructor(init) {
+        this.isPaid = () => {
+            return this.status === LineItemStatus.PAID || this.status === LineItemStatus.PREPAID || this.status === LineItemStatus.EXTERNALLY_PAID;
+        };
+        this.isBilled = () => {
+            return this.status === LineItemStatus.BILLED || this.status === LineItemStatus.EXTERNALLY_BILLED;
+        };
+        this.isUnbilled = () => {
+            return !this.isBilled() && !this.isPaid();
+        };
+        Object.assign(this, init);
+    }
+}

package/dist/types/api/MemberState.d.ts

@@ -0,0 +1,7 @@
+import { Friendship } from "../../types/api/Friendship";
+export interface MemberState {
+    id: string;
+    state: string;
+    friendship: Friendship | null;
+    last_message_read_at: number | null;
+}

package/dist/types/api/MemberState.js

@@ -0,0 +1 @@
+export {};

package/dist/types/api/Message.d.ts

@@ -0,0 +1,13 @@
+import { Reaction } from "../../types/api/Reaction";
+export interface Message {
+    id: string;
+    chat_id: string;
+    sender_id: string;
+    reply_to_id: string;
+    content: string;
+    reactions: Reaction[];
+    time_created: number;
+    time_updated: number;
+    time_sent: number;
+    message: string;
+}

package/dist/types/api/Message.js

@@ -0,0 +1 @@
+export {};

package/dist/types/api/PaymentMethod.d.ts

@@ -0,0 +1,51 @@
+import { PaymentType } from "../../types/api/PaymentType";
+export interface PaymentMethod {
+    allow_redisplay: string;
+    autopay: boolean;
+    billing_details: {
+        email: string;
+        name: string;
+    };
+    created: number;
+    customer: string;
+    id: string;
+    type: PaymentType;
+    us_bank_account: {
+        account_holder_type: string;
+        account_type: string;
+        bank_name: string;
+        financial_connections_account: string;
+        fingerprint: string;
+        last4: string;
+        networks: {
+            preferred: string;
+            supported: string[];
+        };
+        routing_number: string;
+        status_details: object;
+    } | null;
+    card: {
+        brand: string;
+        checks: {
+            address_line1_check: string;
+            address_postal_code_check: string;
+            cvc_check: string;
+        };
+        country: string;
+        exp_month: number;
+        exp_year: number;
+        fingerprint: string;
+        funding: string;
+        last4: string;
+        networks: {
+            preferred: string;
+            supported: string[];
+        };
+        three_d_secure_usage: {
+            supported: boolean;
+        };
+        wallet: {
+            type: string;
+        } | null;
+    } | null;
+}

package/dist/types/api/PaymentMethod.js

@@ -0,0 +1 @@
+export {};

package/dist/types/api/PaymentOption.d.ts

@@ -0,0 +1,9 @@
+export interface PaymentOption {
+    name: string;
+    id: string;
+    is_prepay: boolean;
+    price_under_prepay?: number;
+    price: number;
+    recommended_prepay_count?: number;
+    mode: "MONTH" | "SERVICE";
+}

package/dist/types/api/PaymentOption.js

@@ -0,0 +1 @@
+export {};

package/dist/types/api/PaymentType.d.ts

@@ -0,0 +1,5 @@
+export type PaymentType = typeof PaymentType[keyof typeof PaymentType];
+export declare const PaymentType: {
+    readonly US_BANK_ACCOUNT: "us_bank_account";
+    readonly CARD: "card";
+};

package/dist/types/api/PaymentType.js

@@ -0,0 +1,5 @@
+// eslint-disable-next-line no-redeclare
+export const PaymentType = {
+    US_BANK_ACCOUNT: "us_bank_account",
+    CARD: "card",
+};

package/dist/types/api/Plan.d.ts

@@ -0,0 +1,13 @@
+export interface Plan {
+    id: string;
+    name: string;
+    base_rate: number;
+    price_per_job: number;
+    description: string;
+    referral_codes: string[];
+    trial_period_days: number;
+    time_created: number;
+    time_updated: number;
+    available_to_new_companies?: boolean;
+    available_to?: string[];
+}

package/dist/types/api/Plan.js

@@ -0,0 +1 @@
+export {};

package/dist/types/api/PlanPayment.d.ts

@@ -0,0 +1,10 @@
+export interface PlanPayment {
+    id: string;
+    amount: number;
+    stripe_pi_id: string;
+    company_id: string;
+    plan_id: string;
+    status: "created" | "processing" | "succeeded" | "failed" | "canceled";
+    time_created: number;
+    time_updated: number;
+}

package/dist/types/api/PlanPayment.js

@@ -0,0 +1 @@
+export {};

package/dist/types/api/Prepayment.d.ts

@@ -0,0 +1,15 @@
+import { LineItem } from "../../types/api/LineItem";
+declare module '../../types/api/Prepayment' {
+    interface Prepayment extends LineItem {
+        id: string;
+        task_id: string | null;
+        line_item_type: "PREPAYMENT";
+        type: "SERVICE" | "MONTH";
+        time_updated: number | null;
+        num_events: number;
+        num_service_months: number;
+    }
+}
+export declare class Prepayment extends LineItem {
+    constructor(init?: Partial<Prepayment>);
+}

package/dist/types/api/Prepayment.js

@@ -0,0 +1,7 @@
+import { LineItem } from "../../types/api/LineItem";
+export class Prepayment extends LineItem {
+    constructor(init) {
+        super(init);
+        Object.assign(this, init);
+    }
+}

package/dist/types/api/Reaction.d.ts

@@ -0,0 +1,8 @@
+export interface Reaction {
+    id: string;
+    message_id: string;
+    sender_id: string;
+    reaction: string;
+    time_created: number;
+    time_updated: number;
+}

package/dist/types/api/Reaction.js

@@ -0,0 +1 @@
+export {};

package/dist/types/api/Route.d.ts

@@ -0,0 +1,37 @@
+import { RouteJob } from "../../types/api/RouteJob";
+export declare const FrequencyType: {
+    readonly ONCE: "ONCE";
+    readonly DAILY: "DAILY";
+    readonly WEEKLY: "WEEKLY";
+    readonly BIWEEKLY: "BIWEEKLY";
+    readonly MONTHLY: "MONTHLY";
+    readonly YEARLY: "YEARLY";
+};
+export type FrequencyType = typeof FrequencyType[keyof typeof FrequencyType];
+declare module '../../types/api/Route' {
+    interface Route {
+        company: string;
+        id: string;
+        is_internal: boolean;
+        jobs: RouteJob[];
+        name: string;
+        time_created: number;
+        time_updated: number | null;
+        teams: string[];
+        polyline: string;
+        is_optimized: boolean;
+        start_time: number;
+        end_time: number;
+        start_latitude: number;
+        start_longitude: number;
+        end_latitude: number;
+        end_longitude: number;
+        frequency: typeof FrequencyType[keyof typeof FrequencyType];
+    }
+}
+export declare class Route {
+    constructor(init?: Partial<Route>);
+    getNextOccurrences: (count?: number) => (Date | null)[];
+    getNextOccurrence: (after?: Date) => Date | null;
+    getIndicatorExpiration: () => Date;
+}

package/dist/types/api/Route.js

@@ -0,0 +1,82 @@
+import { RouteJob } from "../../types/api/RouteJob";
+export const FrequencyType = {
+    ONCE: "ONCE",
+    DAILY: "DAILY",
+    WEEKLY: "WEEKLY",
+    BIWEEKLY: "BIWEEKLY",
+    MONTHLY: "MONTHLY",
+    YEARLY: "YEARLY",
+};
+export class Route {
+    constructor(init) {
+        this.getNextOccurrences = (count = 1) => {
+            let next_occurrences = [];
+            for (let i = 0; i < count; i++) {
+                next_occurrences.push(this.getNextOccurrence(next_occurrences.length > 0 ? next_occurrences[next_occurrences.length - 1] ?? new Date() : new Date()));
+            }
+            return next_occurrences;
+        };
+        this.getNextOccurrence = (after = new Date()) => {
+            let next_occurrence = new Date(this.start_time * 1000);
+            while (next_occurrence <= after) {
+                switch (this.frequency) {
+                    case FrequencyType.ONCE:
+                        return null;
+                    case FrequencyType.DAILY:
+                        next_occurrence.setDate(next_occurrence.getDate() + 1);
+                        break;
+                    case FrequencyType.WEEKLY:
+                        next_occurrence.setDate(next_occurrence.getDate() + 7);
+                        break;
+                    case FrequencyType.BIWEEKLY:
+                        next_occurrence.setDate(next_occurrence.getDate() + 14);
+                        break;
+                    case FrequencyType.MONTHLY:
+                        next_occurrence.setMonth(next_occurrence.getMonth() + 1);
+                        break;
+                    case FrequencyType.YEARLY:
+                        next_occurrence.setFullYear(next_occurrence.getFullYear() + 1);
+                        break;
+                }
+            }
+            return next_occurrence;
+        };
+        this.getIndicatorExpiration = () => {
+            const start_time = new Date(this.start_time * 1000);
+            if (this.frequency === FrequencyType.ONCE) {
+                return start_time;
+            }
+            // if the route is currently active, return the start time as the indicator expiration
+            if (Date.now() > start_time.getTime()) {
+                return start_time;
+            }
+            // else compute the previous occurrence and return that as the indicator expiration
+            const prev = new Date(start_time);
+            switch (this.frequency) {
+                case FrequencyType.DAILY:
+                    prev.setHours(prev.getHours() - 4);
+                    prev.setDate(prev.getDate() - 1);
+                    break;
+                case FrequencyType.WEEKLY:
+                    prev.setDate(prev.getDate() - 8);
+                    break;
+                case FrequencyType.BIWEEKLY:
+                    prev.setDate(prev.getDate() - 15);
+                    break;
+                case FrequencyType.MONTHLY:
+                    prev.setDate(prev.getDate() - 1);
+                    prev.setMonth(prev.getMonth() - 1);
+                    break;
+                case FrequencyType.YEARLY:
+                    prev.setDate(prev.getDate() - 1);
+                    prev.setFullYear(prev.getFullYear() - 1);
+                    break;
+            }
+            return prev;
+        };
+        Object.assign(this, init);
+        if (init?.jobs) {
+            this.jobs = init.jobs.map(j => new RouteJob(j));
+        }
+    }
+}