@merchi/sdk 1.40.2

package/src/entities/company.ts

@@ -0,0 +1,397 @@
+import { Address } from './address.js';
+import { AutomaticPaymentRelationship } from './automatic_payment_relationship.js';
+import { Bank } from './bank.js';
+import { Cart } from './cart.js';
+import { CompanyInvitation } from './company_invitation.js';
+import { CountryTax } from './country_tax.js';
+import { Domain } from './domain.js';
+import { EmailAddress } from './email_address.js';
+import { Entity } from '../entity.js';
+import { MerchiFile } from './file.js';
+import { InternalTag } from './internal_tag.js';
+import { Invoice } from './invoice.js';
+import { Job } from './job.js';
+import { PhoneNumber } from './phone_number.js';
+import { Product } from './product.js';
+import { Reminder } from './reminder.js';
+import { Shipment } from './shipment.js';
+import { User } from './user.js';
+import { UserCompany } from './user_company.js';
+import { SubscriptionPlan } from './subscription_plan.js';
+import { PaymentDevice } from './payment_device.js';
+import type {
+  AgentTokenAnalyticsTimeseries,
+  CompanyAnalyticsResponse,
+} from './agent_token_analytics.js';
+import type { RequestOptions } from '../request.js';
+
+export class Company extends Entity {
+  protected static resourceName = 'companies';
+  protected static singularName = 'company';
+  protected static pluralName = 'companies';
+
+  @Company.property({type: Date})
+  public archived?: Date | null;
+
+  @Company.property()
+  public id?: number;
+
+  @Company.property()
+  public name?: string;
+
+  @Company.property()
+  public callToActions?: string;
+
+  @Company.property()
+  public callToActionDetails?: any[];
+
+  @Company.property({type: String})
+  public website?: string | null;
+
+  @Company.property()
+  public ownershipUnconfirmed?: boolean;
+
+  @Company.property({type: String})
+  public taxNumber?: string | null;
+
+  @Company.property({type: String})
+  public taxNumberType?: string | null;
+
+  @Company.property({type: String})
+  public paypalAccount?: string | null;
+
+  @Company.property({type: String})
+  public paypalPassword?: string | null;
+
+  @Company.property({type: String})
+  public paypalSignature?: string | null;
+
+  @Company.property()
+  public isPaypalValid?: boolean;
+
+  @Company.property({embeddedByDefault: false})
+  public isStripeAccountEnabled?: boolean;
+
+  @Company.property()
+  public stripeAccountId?: string;
+
+  @Company.property({type: String})
+  public stripeCustomerId?: string;
+
+  @Company.property()
+  public sendleActive?: boolean;
+
+  @Company.property({type: String})
+  public sendleApiKey?: string;
+
+  @Company.property({type: String})
+  public sendleId?: string;
+
+  @Company.property({type: String})
+  public unltdAiApiOrganizationId?: string;
+
+  @Company.property({type: String})
+  public unltdAiApiSecretKey?: string;
+
+  @Company.property({type: String})
+  public australiaPostApiKey?: string;
+
+  @Company.property({type: String})
+  public australiaPostPassword?: string;
+
+  @Company.property({type: String})
+  public startrackApiKey?: string;
+
+  @Company.property({type: String})
+  public startrackPassword?: string;
+
+  @Company.property({type: String})
+  public dhlApiKey?: string;
+
+  @Company.property({type: String})
+  public dhlApiSecret?: string;
+
+  @Company.property()
+  public dhlTrackingSandbox?: boolean;
+
+  @Company.property()
+  public dhlTrackingExpress?: boolean;
+
+  @Company.property({type: String})
+  public fedexApiKey?: string;
+
+  @Company.property({type: String})
+  public fedexApiSecret?: string;
+
+  @Company.property({type: String})
+  public upsClientId?: string;
+
+  @Company.property({type: String})
+  public upsClientSecret?: string;
+
+  @Company.property({type: String})
+  public uspsApiKey?: string;
+
+  @Company.property({type: String})
+  public tntApiKey?: string;
+
+  @Company.property({type: String})
+  public tntApiSecret?: string;
+
+  @Company.property({type: String})
+  public aramexAccountNumber?: string;
+
+  @Company.property({type: String})
+  public aramexApiKey?: string;
+
+  @Company.property({type: String})
+  public aramexApiSecret?: string;
+
+  @Company.property({type: String})
+  public nzPostApiKey?: string;
+
+  @Company.property({type: String})
+  public internalUseNotes?: string;
+
+  @Company.property({type: String})
+  public internalUseAiContext?: string;
+
+  @Company.property({type: String})
+  public aiContext?: string;
+
+  @Company.property()
+  public isNew?: boolean;
+
+  @Company.property()
+  public subscriptionOutstanding?: boolean;
+
+  @Company.property({type: Date})
+  public trialEndDate?: Date | null;
+
+  @Company.property({type: Date})
+  public trialEndDateUpdated?: Date | null;
+
+  @Company.property({type: 'User'})
+  public trialEndDateSetBy?: User;
+
+  @Company.property()
+  public isBlocked?: boolean;
+
+  @Company.property()
+  public isTesting?: boolean;
+
+  @Company.property({type: String})
+  public squareAccessToken?: string | null;
+
+  @Company.property({type: String})
+  public squareRefreshToken?: string | null;
+
+  @Company.property({type: Date})
+  public squareExpiresAt?: Date | null;
+
+  @Company.property()
+  public squareIsValid?: boolean;
+
+  @Company.property({type: String})
+  public squareMerchantId?: string | null;
+
+  @Company.property({type: String})
+  public squareWebLocationId?: string | null;
+
+  @Company.property({type: String})
+  public stripePublishableTestKey?: string | null;
+
+  @Company.property({type: String})
+  public stripeApiTestKey?: string | null;
+
+  @Company.property({type: String})
+  public stripePublishableKey?: string | null;
+
+  @Company.property({type: String})
+  public stripeApiKey?: string | null;
+
+  @Company.property()
+  public stripeConnectDisabled?: boolean;
+
+  @Company.property()
+  public isPayingCompany?: boolean;
+
+  @Company.property()
+  public isStripeValid?: boolean;
+
+  @Company.property()
+  public acceptSquare?: boolean;
+
+  @Company.property()
+  public acceptStripe?: boolean;
+
+  @Company.property()
+  public acceptPaypal?: boolean;
+
+  @Company.property()
+  public acceptUtrust?: boolean;
+
+  @Company.property({type: String})
+  public utrustApiKey?: string | null;
+
+  @Company.property({type: String})
+  public utrustWebhookKey?: string | null;
+
+  @Company.property()
+  public isUtrustValid?: boolean;
+
+  @Company.property()
+  public acceptBankTransfer?: boolean;
+
+  @Company.property()
+  public acceptPhonePayment?: boolean;
+
+  @Company.property()
+  public defaultCurrency?: string;
+
+  @Company.property()
+  public country?: string;
+
+  @Company.property({arrayType: 'InternalTag'})
+  public internalTags?: InternalTag[];
+
+  @Company.property({type: MerchiFile})
+  public logo?: MerchiFile | null;
+
+  @Company.property({type: 'CountryTax'})
+  public defaultTaxType?: CountryTax | null;
+
+  @Company.property({arrayType: 'AutomaticPaymentRelationship'})
+  public automaticPaymentRelationships?: AutomaticPaymentRelationship[];
+
+  @Company.property({arrayType: 'CountryTax'})
+  public taxTypes?: CountryTax[];
+
+  @Company.property({arrayType: 'PaymentDevice'})
+  public paymentDevices?: PaymentDevice[];
+
+  @Company.property({type: SubscriptionPlan})
+  public subscriptionPlan?: SubscriptionPlan | null;
+
+  @Company.property({arrayType: 'EmailAddress'})
+  public _emailAddresses?: EmailAddress[];
+
+  @Company.property({arrayType: 'PhoneNumber'})
+  public _paymentPhoneNumbers?: PhoneNumber[];
+
+  @Company.property({arrayType: 'PhoneNumber'})
+  public _phoneNumbers?: PhoneNumber[];
+
+  @Company.property({arrayType: 'Address'})
+  public _addresses?: Address[];
+
+  @Company.property({arrayType: 'UserCompany'})
+  public _users?: UserCompany[];
+
+  @Company.property({arrayType: 'Shipment'})
+  public shipmentsAsSender?: Shipment[];
+
+  @Company.property({arrayType: 'Shipment'})
+  public shipmentsAsReceiver?: Shipment[];
+
+  @Company.property({arrayType: 'Product'})
+  public savedProducts?: Product[];
+
+  @Company.property({arrayType: 'Reminder'})
+  public reminders?: Reminder[];
+
+  @Company.property({arrayType: 'Bank'})
+  public banks?: Bank[];
+
+  @Company.property({arrayType: 'UserCompany'})
+  public userCompanies?: UserCompany[];
+
+  @Company.property({arrayType: 'CompanyInvitation'})
+  public companyInvitations?: CompanyInvitation[];
+
+  @Company.property({arrayType: 'Job'})
+  public appliedJobs?: Job[];
+
+  @Company.property({arrayType: 'Cart'})
+  public carts?: Cart[];
+
+  @Company.property({arrayType: 'Domain'})
+  public domains?: Domain[];
+
+  @Company.property({arrayType: 'Domain'})
+  public accessibleDomainsAsClientCompany?: Domain[];
+
+  @Company.property({arrayType: 'EmailAddress'})
+  public emailAddresses?: EmailAddress[];
+
+  @Company.property({arrayType: 'PhoneNumber'})
+  public phoneNumbers?: PhoneNumber[];
+
+  @Company.property({arrayType: 'PhoneNumber'})
+  public paymentPhoneNumbers?: PhoneNumber[];
+
+  @Company.property({arrayType: 'Invoice'})
+  public invoicesHas?: Invoice[];
+
+  @Company.property({arrayType: 'Invoice'})
+  public subscriptionInvoices?: Invoice[];
+
+  @Company.property({arrayType: 'Address'})
+  public addresses?: Address[];
+
+  @Company.property({type: 'Company'})
+  public parentCompany?: Company | null;
+
+  @Company.property({arrayType: 'Company'})
+  public childCompanies?: Company[];
+
+  private getCompanyId = () => {
+    if (this.id === undefined || this.id === null) {
+      throw new Error('id is undefined, did you forget to set it?');
+    }
+    return this.id;
+  };
+
+  private analyticsRequest = (
+    resource: string,
+    method: 'GET' | 'POST' = 'GET',
+    payload?: Record<string, any>,
+    queryParams?: Record<string, string | undefined>
+  ) => {
+    const query: Array<[string, string]> = [];
+    if (queryParams) {
+      Object.entries(queryParams).forEach(([key, value]) => {
+        if (value !== undefined && value !== '') {
+          query.push([key, value]);
+        }
+      });
+    }
+    const fetchOptions: RequestOptions = {
+      method: method,
+      query: query,
+    };
+    if (payload !== undefined) {
+      fetchOptions.body = JSON.stringify(payload);
+      fetchOptions.headers = {'Content-Type': 'application/json'};
+    }
+    return this.merchi.authenticatedFetch(resource, fetchOptions);
+  };
+
+  public getAnalytics = (): Promise<CompanyAnalyticsResponse> => {
+    return this.analyticsRequest(
+      `/companies/${this.getCompanyId()}/analytics/`,
+      'GET'
+    ) as Promise<CompanyAnalyticsResponse>;
+  };
+
+  public getAgentTokenAnalytics = (
+    queryParams?: Record<string, string | undefined>
+  ): Promise<AgentTokenAnalyticsTimeseries> => {
+    return this.analyticsRequest(
+      `/companies/${this.getCompanyId()}/agent_token_analytics/`,
+      'GET',
+      undefined,
+      queryParams
+    ) as Promise<AgentTokenAnalyticsTimeseries>;
+  };
+}

package/src/entities/company_invitation.test.ts

@@ -0,0 +1,7 @@
+import { Merchi } from '../merchi.js';
+
+test('can make CompanyInvitation', () => {
+  const merchi = new Merchi();
+  const companyInvitation = new merchi.CompanyInvitation();
+  expect(companyInvitation).toBeTruthy();
+});

package/src/entities/company_invitation.ts

@@ -0,0 +1,33 @@
+import { Company } from './company.js';
+import { Entity } from '../entity.js';
+import { User } from './user.js';
+
+export class CompanyInvitation extends Entity {
+  protected static resourceName = 'company_invitations';
+  protected static singularName = 'companyInvitation';
+  protected static pluralName = 'companyInvitations';
+
+  @CompanyInvitation.property({type: Date})
+  public archived?: Date | null;
+
+  @CompanyInvitation.property()
+  public id?: number;
+
+  @CompanyInvitation.property()
+  public userName?: string;
+
+  @CompanyInvitation.property()
+  public userEmail?: string;
+
+  @CompanyInvitation.property()
+  public inviteAsAdmin?: boolean;
+
+  @CompanyInvitation.property()
+  public token?: string;
+
+  @CompanyInvitation.property()
+  public company?: Company;
+
+  @CompanyInvitation.property()
+  public sender?: User;
+}

package/src/entities/country_tax.test.ts

@@ -0,0 +1,13 @@
+import { Merchi } from '../merchi.js';
+
+test('can make CountryTax', () => {
+  const merchi = new Merchi();
+  const countryTax = new merchi.CountryTax();
+  expect(countryTax).toBeTruthy();
+});
+
+test('getNoTax', () => {
+  const merchi = new Merchi();
+  const noTax = merchi.CountryTax.getNoTax();
+  expect(noTax.id).toBe(3);
+});

package/src/entities/country_tax.ts

@@ -0,0 +1,46 @@
+import { Company } from './company.js';
+import { Entity } from '../entity.js';
+import { Item } from './item.js';
+import { Job } from './job.js';
+import { Shipment } from './shipment.js';
+
+export class CountryTax extends Entity {
+  protected static resourceName = 'country_taxes';
+  protected static singularName = 'countryTax';
+  protected static pluralName = 'countryTaxes';
+
+  @CountryTax.property({type: Date})
+  public archived?: Date | null;
+
+  @CountryTax.property()
+  public id?: number;
+
+  @CountryTax.property({type: String})
+  public country?: string | null;
+
+  @CountryTax.property()
+  public taxName?: string;
+
+  @CountryTax.property({type: Number})
+  public taxPercent?: number | null;
+
+  @CountryTax.property({arrayType: 'Shipment'})
+  public shipments?: Shipment[];
+
+  @CountryTax.property({type: 'Company'})
+  public company?: Company;
+
+  @CountryTax.property({arrayType: 'Job'})
+  public jobs?: Job[];
+
+  @CountryTax.property({arrayType: 'Item'})
+  public items?: Item[];
+
+  public static getNoTax() {
+    const result = new this.merchi.CountryTax();
+    result.id = 3;  // 3 is a reserved id for 'no tax' by the backend
+    result.taxName = 'No tax';
+    result.taxPercent = 0;
+    return result;
+  }
+}

package/src/entities/discount.test.ts

@@ -0,0 +1,36 @@
+import { Merchi } from '../merchi.js';
+
+test('can make Discount', () => {
+  const merchi = new Merchi();
+  const discount = new merchi.Discount();
+  expect(discount).toBeTruthy();
+});
+
+test('can set assignedUsers', () => {
+  const merchi = new Merchi();
+  const discount = new merchi.Discount();
+  const user = new merchi.User();
+  user.id = 11;
+  discount.assignedUsers = [user];
+  expect(discount.assignedUsers?.map((assigned) => assigned.id)).toEqual([11]);
+});
+
+test('can set referrer', () => {
+  const merchi = new Merchi();
+  const discount = new merchi.Discount();
+  const user = new merchi.User();
+  user.id = 22;
+  discount.referrer = user;
+  expect(discount.referrer?.id).toEqual(22);
+});
+
+test('discountedUnitCost', () => {
+  const merchi = new Merchi();
+  const discount = new merchi.Discount();
+  const product = new merchi.Product();
+  expect(() => discount.discountedUnitCost(product.unitPrice)).toThrow();
+  product.unitPrice = 200.8; 
+  expect(() => discount.discountedUnitCost(product.unitPrice)).toThrow();
+  discount.amount = 94.6;
+  expect(discount.discountedUnitCost(product.unitPrice)).toEqual('10.843');
+});

package/src/entities/discount.ts

@@ -0,0 +1,50 @@
+import { Entity } from '../entity.js';
+import { DiscountGroup } from './discount_group.js';
+import { User } from './user.js';
+
+export class Discount extends Entity {
+  protected static resourceName = 'discounts';
+  protected static singularName = 'discount';
+  protected static pluralName = 'discounts';
+
+  @Discount.property({type: Date})
+  public archived?: Date | null;
+
+  @Discount.property()
+  public id?: number;
+
+  @Discount.property()
+  public lowerLimit?: number;
+
+  @Discount.property()
+  public amount?: number;
+
+  @Discount.property()
+  public usageLimit?: number;
+
+  @Discount.property()
+  public isPercentage?: boolean;
+
+  @Discount.property()
+  public code?: string;
+
+  @Discount.property({arrayType: 'User'})
+  public assignedUsers?: User[];
+
+  @Discount.property({type: User})
+  public referrer?: User | null;
+
+  @Discount.property({type: DiscountGroup})
+  public discountGroup?: DiscountGroup | null;
+
+  public discountedUnitCost = (unitPrice: number | undefined) => {
+    if (unitPrice === undefined) {
+      throw 'unitPrice is undefined, did you forget to embed it?';
+    }
+    if (this.amount === undefined) {
+      throw 'amount is undefined, did you forget to embed it?';
+    }
+    const discount = 100 - this.amount;
+    return (unitPrice * discount / 100).toFixed(3);
+  };
+}

package/src/entities/discount_group.test.ts

@@ -0,0 +1,7 @@
+import { Merchi } from '../merchi.js';
+
+test('can make Discount Group', () => {
+  const merchi = new Merchi();
+  const discountGroup = new merchi.DiscountGroup();
+  expect(discountGroup).toBeTruthy();
+});

package/src/entities/discount_group.ts

@@ -0,0 +1,43 @@
+import { Entity } from '../entity.js';
+import { Domain } from './domain.js';
+import { Product } from './product.js';
+import { Discount } from './discount.js';
+
+export class DiscountGroup extends Entity {
+  protected static resourceName = 'discount_groups';
+  protected static singularName = 'discountGroup';
+  protected static pluralName = 'discountGroups';
+
+  @DiscountGroup.property({type: Date})
+  public archived?: Date | null;
+
+  @DiscountGroup.property({type: Date})
+  public created?: Date | null;
+
+  @DiscountGroup.property()
+  public id?: number;
+
+  @DiscountGroup.property({type: Date})
+  public dateStart?: Date | null;
+
+  @DiscountGroup.property({type: Date})
+  public dateEnd?: Date | null;
+
+  @DiscountGroup.property()
+  public discountType?: number;
+
+  @DiscountGroup.property({arrayType: 'Discount'})
+  public discounts?: Discount[];
+
+  @DiscountGroup.property()
+  public name?: string;
+
+  @DiscountGroup.property()
+  public groupRestricted?: boolean;
+
+  @DiscountGroup.property({type: 'Product'})
+  public product?: Product | null;
+
+  @DiscountGroup.property({type: 'Domain'})
+  public domain?: Domain | null;
+}