@trakit/objects 0.0.6 → 0.0.8

package/_publish/API/TimeSpan.d.ts

@@ -1,109 +0,0 @@
-import { nothing, timespan } from "./Types";
-/**
- * An object which represents an interval of time.
- */
-export declare class TimeSpan {
-    #private;
-    /**
-     * Constructs a new TimeSpan with the value specified in days.
-     */
-    static fromDays(value: number): TimeSpan;
-    /**
-     * Constructs a new TimeSpan with the value specified in hours.
-     */
-    static fromHours(value: number): TimeSpan;
-    /**
-     * Constructs a new TimeSpan with the value specified in minutes.
-     */
-    static fromMinutes(value: number): TimeSpan;
-    /**
-     * Constructs a new TimeSpan with the value specified in seconds.
-     */
-    static fromSeconds(value: number): TimeSpan;
-    /**
-     * Constructs a new TimeSpan with the value specified in milliseconds.
-     */
-    static fromMilliseconds(value: number): TimeSpan;
-    /**
-     * @param duration		A time-span formatted string, or a number representing milliseconds
-     */
-    constructor(duration?: TimeSpan | timespan | number | nothing);
-    /**
-     * Days component of the time-span.
-     */
-    get days(): number;
-    /**
-     * Hours component of the time-span.
-     */
-    get hours(): number;
-    /**
-     * Minutes component of the time-span.
-     */
-    get minutes(): number;
-    /**
-     * Seconds component of the time-span.
-     */
-    get seconds(): number;
-    /**
-     * Millisecond component of the time-span.
-     */
-    get milliseconds(): number;
-    /**
-     * Total time-span value in decimal days.
-     */
-    get totalDays(): number;
-    /**
-     * Total time-span value in decimal hours.
-     */
-    get totalHours(): number;
-    /**
-     * Total time-span value in decimal minutes.
-     */
-    get totalMinutes(): number;
-    /**
-     * Total time-span value in decimal seconds.
-     */
-    get totalSeconds(): number;
-    /**
-     * Total time-span value in milliseconds.
-     */
-    get totalMilliseconds(): number;
-    /**
-     * Parses the time-span into a serialized TimeSpan string.
-     * The format follows the {@link timespan} definition.
-     * @param format	Use format strings like "HH:mm" for just hours and minutes.  Valid flags are d, h, H, m, s, and f.  If you use
-     */
-    toString(format?: timespan): timespan;
-    /**
-     * Same as {@link TimeSpan#toString}.
-     */
-    toJSON: (format?: timespan) => timespan;
-    /**
-     * Gets the comparable value of this time-span as total milliseconds.
-     */
-    valueOf(): number;
-    /**
-     * Adds the given value to the current time-span.
-     * @param duration	A time-span formatted string, or a number representing milliseconds
-     * @param subtract	When true, the value is subtracted from the time-span instead of added.
-     */
-    add(duration: TimeSpan | timespan | number, subtract?: boolean): number;
-    /**
-     * Subtracts the given value from the time-span.
-     * @param duration	A time-span formatted string, or a number representing milliseconds
-     * @param add		When true, the value is added from the time-span instead of subtracted.
-     */
-    subtract(duration: TimeSpan | timespan | number, add?: boolean): number;
-}
-/**
- * Parses a serialized TimeSpan into a number representing the total seconds.
- * For example the string "1.07:42:03.467" equals 114123.467, which is 1 day, 7 hours, 42 minutes, 3 seconds, and 467 milliseconds.
- * @param duration	A valid timespan string.  The format is [-]( d | [d.]hh:mm[:ss[.fff]] )
- */
-export declare function TIMESPAN_PARSE(duration: TimeSpan | timespan | number): number;
-/**
- * Parses a number representing the total seconds into a serialized TimeSpan string.
- * For example the number 114123.467 would be serialized as "1.07:42:03.467".
- * @param value		Use a decimal to show milliseconds.
- */
-export declare function TIMESPAN_STRINGIFY(value: number): timespan;

package/_publish/API/Timezone.d.ts

@@ -1,44 +0,0 @@
-import { IRequestable } from "./Interfaces/IRequestable";
-import { ISerializable } from "./Interfaces/ISerializable";
-import { short, JsonObject } from "./Types";
-/**
- * Timezone definition
-*/
-export declare class Timezone implements IRequestable, ISerializable {
-    /**
-     *
-     * @param json
-     */
-    static fromJSON(json: JsonObject): Timezone;
-    /**
-     *
-     */
-    static utc: Timezone;
-    /**
-     * Unique timezone code
-     */
-    code: string;
-    /**
-     * Common timezone name
-     */
-    name: string;
-    /**
-     * Minutes offset from GMT
-     */
-    offset: short;
-    /**
-     * Indicates whether this timezone abides by daylight savings
-     */
-    dst: boolean;
-    constructor(code: string, name?: string, offset?: short, dst?: boolean);
-    toJSON(): {
-        code: string;
-        name: string;
-        offset: number;
-        dst: boolean;
-    };
-    /**
-     * The {@link code} is the key.
-     */
-    getKey(): string;
-}

package/_publish/API/Types.d.ts

@@ -1,132 +0,0 @@
-/**
- * Represents the absence of a value.
- **/
-export type nothing = undefined | null;
-/**
- * 8bit integer
- * @example minimum value (-128) to maximum value (127)
- **/
-export type sbyte = number;
-/**
- * 16bit integer
- * @example minimum value (-32768) to maximum value (32767)
- **/
-export type short = number;
-/**
- * 32bit integer
- * @example minimum value (-2147483648) to maximum value (2147483647)
- **/
-export type int = number;
-/**
- * 64bit integer
- * @example minimum value (-9223372036854775808) to maximum value (9223372036854775807)
- **/
-export type long = number;
-/**
- * 8bit unsigned integer
- * @example minimum value (0) to maximum value (255)
- **/
-export type byte = number;
-/**
- * 16bit unsigned integer
- * @example minimum value (0) to maximum value (65535)
- **/
-export type ushort = number;
-/**
- * 32bit unsigned integer
- * @example minimum value (0) to maximum value (4294967295)
- **/
-export type uint = number;
-/**
- * 64bit unsigned integer
- * @example minimum value (0) to maximum value (18446744073709551615)
- **/
-export type ulong = number;
-/**
- * Single-precision floating point number
- * @example minimum value (-3.40282347E+38F) to maximum value (3.40282347E+38F)
- **/
-export type single = number;
-/**
- * Double-precision floating point number
- * @example minimum value (-1.7976931348623157e+308) to maximum value (1.7976931348623157e+308)
- **/
-export type double = number;
-/**
- * A phone number for a phone in Canada or the United States of America. All phone numbers start with a 1 and are eleven digits long.
- * @example "[1]AAALLLSSSS"
- **/
-export type phone = number;
-/**
- * A lower-case string with all the apostrophes and quotation marks [`"`, `'`, ```, `“`, and `”`] removed, and all non-alphanumeric character sequences replaced with a single minus sign.  Diacritics such as `®`, `é`, and `ç` are also replaced with their alhpabetic equivalents (`r`, `e`, and `c`).
- **/
-export type codified = string;
-/**
- * A string that contains only a valid CSS colour.
- * More: {@link https://developer.mozilla.org/en-US/docs/Web/CSS/color_value}
- **/
-export type colour = string;
-/**
- * A serialized-string representation of a date and time in ISO-8601 format.  Square brackets `[]` are used to show optional format information. All other non-alphabetic characters are required.
- * @example "yyyy-MM-ddTHH:mm:ss[.fff]Z"
- **/
-export type datetime = string;
-/**
- * These formats define the text representation of dates and times.
- **/
-export type datetimetemplate = string;
-/**
- * An email address identifies a mailbox to which messages are delivered. We follow the `RFC 2822` pattern for addresses.
- * More: {@link https://tools.ietf.org/html/rfc2822}
- * @example "user@domain.tld"
- **/
-export type email = string;
-/**
- * A targeting pattern is a string that represents an in-the-moment search for objects. The operators used depend entirely on the context of the search, and compatibility with the sub-system.
- * More: {@link https://fleetfreedom.freshdesk.com/en/support/solutions/articles/3000061325-advanced-search-options}
- * @example "operator:terms terms"
- **/
-export type expression = string;
-/**
- * Globally/Universally Unique Identifier. It is a 36 character long string made up of letters, numbers, and dashes. The letters can be transmitted as upper-case, lower-case, or a combination.
- * More: {@link https://docs.microsoft.com/en-us/dotnet/api/system.guid?view=net-5.0}
- * @example "xxxxxxxx-xxxx-4xxx-xxxx-xxxxxxxxxxxx"
- **/
-export type guid = string;
-/**
- * A serialized-string representation of an IPv4 Address.  Square brackets `[]` are used to show optional format information. All other non-alphabetic characters are required.
- * @example "n.n.n.n[/r]"
- **/
-export type ipv4 = string;
-/**
- * The algorithm is a lossy compression that stores a series of coordinates as a single string. All coordinates are rounded to six decimal places before encoding, but this should be accurate to within roughly one and a half meters.
- * More: {@link https://developers.google.com/maps/documentation/utilities/polylinealgorithm}
- **/
-export type polyline = string;
-/**
- * A serialized-string representation of a duration of time.  There are two possible formats when using a duration string.  Square brackets `[]` are used to show optional format information. All other non-alphabetic characters are required.
- * @example "[-][d.]H:mm[:ss[.fff]]"
- * @example "[-]d"
- **/
-export type timespan = string;
-/**
- * Most commonly a website address, but can also be any other type of locator like `ssh:`. We follow the `RFC 1738` pattern for addresses.
- * More: {@link https://tools.ietf.org/html/rfc1738}
- * @example "http[s]://domain.tld/path?query#fragment"
- * @example "protocol:path?query"
- **/
-export type url = string;
-/**
- * A JSON object is an unordered collection of key/value pairs.
- */
-export type JsonObject = {
-    [key: string]: JsonValue;
-};
-/**
- * An array of any valid JSON value.
- */
-export type JsonArray = JsonValue[];
-/**
- * Any valid JSON value.
- */
-export type JsonValue = null | boolean | number | string | JsonArray | JsonObject;

package/_publish/Accounts/Contact.d.ts

@@ -1,140 +0,0 @@
-import { BaseComponent } from "../API/BaseComponent";
-import { IBelongCompany } from "../API/Interfaces/IBelongCompany";
-import { IIdUlong } from "../API/Interfaces/IIdUlong";
-import { INamed } from "../API/Interfaces/INamed";
-import { IPictured } from "../API/Interfaces/IPictured";
-import { codified, email, JsonObject, phone, ulong, url } from "../API/Types";
-import { Company } from "../Companies/Company";
-import { Picture } from "../Images/Picture";
-/**
- * Contact information.
- */
-export declare class Contact extends BaseComponent implements IIdUlong, INamed, IBelongCompany, IPictured {
-    /**
-     * Unique identifier of this contact.
-     */
-    id: ulong;
-    /**
-     * The company to which this contact belongs
-     * {@link Company.id}
-     */
-    companyId: ulong;
-    /**
-     * The company to which this contact belongs
-     * {@link Company.id}
-     */
-    get company(): Company;
-    /**
-     * The person's name
-     */
-    name: string;
-    /**
-     * Notes about this person.
-     */
-    notes: string;
-    /**
-     * A collection of other names this person might go by.
-     * Use the object key like a name identifier.
-     * Example keys: Initials, Nickname, Maiden Name, etc.
-     */
-    otherNames: Map<string, string>;
-    /**
-     * Email addresses.
-     * Use the object key like a name of the address.
-     * Example keys: Home, Work, Support, Old, etc.
-     */
-    emails: Map<string, email>;
-    /**
-     * Phone numbers.
-     * Use the object key like a name of the phone number.
-     * Example keys: Mobile, Fax, Home, Office, etc.
-     */
-    phones: Map<string, phone>;
-    /**
-     * Mailing addresses.
-     * Use the object key like a name of the address.
-     * Example keys: Home, Work, Park, etc.
-     */
-    addresses: Map<string, string>;
-    /**
-     * Websites and other online resources.
-     * Use the object key like a name of the address.
-     * Example keys: Downloads, Support, FTP, etc.
-     */
-    urls: Map<string, url>;
-    /**
-     * Date information.
-     * Use the object key like a name of the date.
-     * Example keys: Birthday, Started Date, Retired On, etc.
-     */
-    dates: Map<string, Date>;
-    /**
-     * Uncategorized information.
-     * Use the object keys and values however you'd like.
-     */
-    options: Map<string, string>;
-    /**
-     * A list of roles they play in the Company.
-     */
-    roles: codified[];
-    /**
-     * {@link Picture.id}s of this Contact.
-     */
-    pictureIds: ulong[];
-    /**
-     * {@link Picture}s of this Contact.
-     */
-    get pictures(): Picture[];
-    set pictures(values: Picture[]);
-    /**
-     * Primary email address.
-     */
-    get email(): email;
-    set email(value: email);
-    /**
-     * A cellular phone number.
-     */
-    get mobile(): phone;
-    set mobile(value: phone);
-    /**
-     * A workplace landline phone number.
-     */
-    get office(): phone;
-    set office(value: phone);
-    /**
-     * Why can't we get rid of these damn machines?
-     */
-    get fax(): phone;
-    set fax(value: phone);
-    /**
-     * Primary email address.
-     */
-    get address(): string;
-    set address(value: string);
-    /**
-     * Website.
-     */
-    get url(): url;
-    set url(value: url);
-    toJSON(): {
-        id: number | null;
-        v: number[];
-        company: number;
-        name: string;
-        notes: string;
-        otherNames: JsonObject;
-        emails: JsonObject;
-        phones: JsonObject;
-        addresses: JsonObject;
-        urls: JsonObject;
-        dates: JsonObject;
-        options: JsonObject;
-        roles: string[];
-        pictures: number[];
-    };
-    fromJSON(json: JsonObject, force?: boolean): boolean;
-    /**
-     * The {@link id} is the key.
-     */
-    getKey(): number;
-}

package/_publish/Accounts/Machine.d.ts

@@ -1,139 +0,0 @@
-import { BaseComponent } from '../API/BaseComponent';
-import { IBelongCompany } from '../API/Interfaces/IBelongCompany';
-import { IEnabled } from '../API/Interfaces/IEnabled';
-import { IHavePermissions } from '../API/Interfaces/IHavePermissions';
-import { IHavePreferences } from '../API/Interfaces/IHavePreferences';
-import { Timezone } from '../API/Timezone';
-import { codified, ipv4, JsonObject, ulong, url } from '../API/Types';
-import { Company } from '../Companies/Company';
-import { Permission } from './Permissions/Permission';
-import { SystemsOfUnits } from './SystemsOfUnits';
-import { UserGroup } from './UserGroup';
-/**
- * A service account that allowes for API access of system services.
- */
-export declare class Machine extends BaseComponent implements IEnabled, IBelongCompany, IHavePreferences, IHavePermissions {
-    /**
-     * The unique idenifier used to access the system.
-     */
-    key: string;
-    /**
-     * The company to which this user belongs.
-     */
-    companyId: ulong;
-    /**
-     *
-     */
-    get company(): Company;
-    /**
-     * Indicates whether system access is disable.
-     */
-    enabled: boolean;
-    /**
-     * A token used to encode or validate requests.
-     */
-    secret: string;
-    /**
-     * Human friendly name for these credentials
-     */
-    nickname: string;
-    /**
-     * Notes about this machine.
-     */
-    notes: string;
-    /**
-     * An optional timestamp that restricts this machine account from being used before the given date.
-     */
-    notBefore: Date;
-    /**
-     * An optional timestamp that restricts this machine account from being used after the given date.
-     */
-    notAfter: Date;
-    /**
-     * The service account's local timezone.
-     */
-    timezone: Timezone;
-    /**
-     * Preferred region/language for the UI and notifications.
-     * Valid formats use <ISO 639-1><dash><ISO 3166-2> such as "fr-CA" or "en-US".
-     */
-    language: string;
-    /**
-     * The format strings defining the preferred way to display ambiguous values.
-     */
-    formats: Map<codified, string>;
-    /**
-     * Preferred way of displaying ambiguous numbers in the context of measurements.
-     */
-    measurements: Map<string, SystemsOfUnits>;
-    /**
-     * Additional options which do not fit in with the formats or measurements preferences.
-     */
-    options: Map<string, string>;
-    /**
-     * A list of groups to which this machine account belongs.
-     */
-    groupIds: ulong[];
-    /**
-     * A list of groups to which this machine account belongs.
-     */
-    get groups(): UserGroup[];
-    set groups(value: UserGroup[]);
-    /**
-     * Permission rules which override the group rules.
-     */
-    permissions: Permission[];
-    /**
-     * List of system service URIs that this machine account is permitted to access.
-     */
-    services: url[];
-    /**
-     * Optional list of your managed domains from which this machine account can be used.
-     */
-    referrers: url[];
-    /**
-     * Restrict service access to only the provided IP ranges.
-     * Currently we only support IPv4 ranges using CIDR slash-notation.
-     */
-    ipRanges: ipv4[];
-    /**
-     * Restrict service access to only the provided IP ranges.
-     * Currently we only support IPv4 ranges
-     * When true, no access restrictions ({@link secret}, {@link referrers}, or {@link ipRanges}) are enforced.
-     */
-    insecure: boolean;
-    toJSON(): {
-        key: string;
-        v: number[];
-        company: number;
-        nickname: string;
-        notes: string;
-        enabled: boolean;
-        notBefore: string | null;
-        notAfter: string | null;
-        timezone: string;
-        language: string;
-        formats: JsonObject;
-        measurements: JsonObject;
-        options: JsonObject;
-        groups: number[];
-        permissions: any[];
-        services: string[];
-        referrers: string[];
-        ipRanges: string[];
-        insecure: boolean;
-    };
-    fromJSON(json: JsonObject, force?: boolean): boolean;
-    /**
-     * The {@link key} is the key (how about that).
-     */
-    getKey(): string;
-    /**
-     * Creates an HMAC256 signed input for use in requests.
-     * @param absoluteUri	URL of the request.
-     * @param method		HTTP verb of the request.
-     * @param contentLength	Content length of the request.
-     * @param date			Timestamp for when the request is created.
-     */
-    createHmacSignature(absoluteUri: URL | string, method?: string, contentLength?: number, date?: Date): Promise<string>;
-}