@giosg/types 6.5.0 → 7.0.1

package/lib/cjs/assets.d.ts

@@ -0,0 +1,144 @@
+import { NestedUser } from "./customer";
+import { AssetUid, OrganizationUid, UserUid, AssetType } from "./types";
+export interface Asset {
+    /** Unique identifier of the asset */
+    id: AssetUid;
+    /** The original file name of the uploaded file */
+    file_name: string;
+    /** Content type of the uploaded file */
+    content_type: string | null;
+    /** Kind of file the asset is */
+    kind: AssetType | null;
+    /** Name of the asset */
+    name: string;
+    /** Description of the asset */
+    description: string | null;
+    /** The full URL for original, uploaded file. Use this URL to link to your asset */
+    url: string;
+    /** Unique identifier of the organization that owns the asset */
+    organization_id: OrganizationUid;
+    /** Size of the uploaded file in bytes */
+    size: number;
+    /** Character encoding for a text file */
+    charset: string | null;
+    /** Date when the asset was created */
+    created_at: string;
+    /** Date when the asset was changed for the last time */
+    updated_at: string;
+    /** Unique identifier of the user who created the asset */
+    created_by_user_id: UserUid;
+    /** Unique identifier of the user who changed the asset for the last time */
+    updated_by_user_id: UserUid;
+    /** User who created the asset */
+    created_by_user: NestedUser;
+    /** User who changed the asset for the last time */
+    updated_by_user: NestedUser;
+    /** The width of an image in pixels. Available for images only. It is null for other types of assets */
+    width: number | null;
+    /** The height of an image in pixels. Available for images only. It is null for other types of assets */
+    height: number | null;
+}
+export interface AssetPayload {
+    /** Name for the newly created asset. If omitted, defaults to the file name. Otherwise, it must be a non-empty string value */
+    name?: string;
+    /** Description of the asset */
+    description?: string | null;
+    /** Character encoding for a text file */
+    charset?: string | null;
+    /** The asset file to be uploaded. File name is required */
+    upload: File;
+}
+/**
+ * @deprecated
+ */
+export interface AssetUpdate {
+    /** Unique identifier of the asset */
+    id: AssetUid;
+    /** The original file name of the uploaded file */
+    file_name: string;
+    /** Content type of the uploaded file */
+    content_type: string | null;
+    /** Kind of file the asset is */
+    kind: AssetType | null;
+    /** Name of the asset */
+    name: string;
+    /** Description of the asset */
+    description: string | null;
+    /** The full URL for original, uploaded file. Use this URL to link to your asset */
+    url: string;
+    /** Unique identifier of the organization that owns the asset */
+    organization_id: OrganizationUid;
+    /** Size of the uploaded file in bytes */
+    size: number;
+    /** Character encoding for a text file */
+    charset: string | null;
+    /** Date when the asset was created */
+    created_at: string;
+    /** Date when the asset was changed for the last time */
+    updated_at: string;
+    /** Unique identifier of the user who created the asset */
+    created_by_user_id: UserUid;
+    /** Unique identifier of the user who changed the asset for the last time */
+    updated_by_user_id: UserUid;
+    /** User who created the asset */
+    created_by_user: NestedUser;
+    /** User who changed the asset for the last time */
+    updated_by_user: NestedUser;
+    /** The width of an image in pixels. Available for images only. It is null for other types of assets */
+    width: number | null;
+    /** The height of an image in pixels. Available for images only. It is null for other types of assets */
+    height: number | null;
+    /** The asset file to be uploaded. File name is required */
+    upload?: File;
+}
+export interface AssetUpdatePayload {
+    /** Name of the asset */
+    name?: string;
+    /** Description of the asset */
+    description?: string | null;
+    /** Character encoding for a text file */
+    charset?: string | null;
+    /** The asset file to be uploaded. File name is required */
+    upload?: File;
+}
+export interface NestedAsset {
+    /** Unique identifier of the asset*/
+    id: AssetUid;
+    /** The full URL for original, uploaded file. Use this URL to link to your asset */
+    url: string;
+    /** Name of the asset */
+    name: string;
+    /** Description of the asset */
+    description: string | null;
+    /** Kind of file the asset is */
+    kind: AssetType | null;
+    /** Content type of the uploaded file */
+    content_type: string | null;
+    /** Size of the uploaded file in bytes */
+    size: number;
+    /** Character encoding for a text file */
+    charset: string | null;
+    /** The width of an image in pixels. Available for images only. It is null for other types of assets */
+    width: number | null;
+    /** The height of an image in pixels. Available for images only. It is null for other types of assets */
+    height: number | null;
+}
+export interface PublicNestedAsset {
+    /** Unique identifier of the asset */
+    id: AssetUid;
+    /** The full URL for original, uploaded file. Use this URL to link to your asset */
+    url: string;
+    /** Kind of file the asset is */
+    kind: AssetType | null;
+    /** Content type of the uploaded file */
+    content_type: string | null;
+    /** Size of the uploaded file in bytes */
+    size: number;
+    /** Character encoding for a text file */
+    charset: string | null;
+    /** The width of an image in pixels. Available for images only. It is null for other types of assets */
+    width: number | null;
+    /** The height of an image in pixels. Available for images only. It is null for other types of assets */
+    height: number | null;
+}
+//# sourceMappingURL=assets.d.ts.map

package/lib/cjs/assets.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"assets.d.ts","sourceRoot":"","sources":["../../src/assets.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AACxC,OAAO,EAAE,QAAQ,EAAE,eAAe,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAExE,MAAM,WAAW,KAAK;IACpB,qCAAqC;IACrC,EAAE,EAAE,QAAQ,CAAC;IAEb,kDAAkD;IAClD,SAAS,EAAE,MAAM,CAAC;IAElB,wCAAwC;IACxC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,gCAAgC;IAChC,IAAI,EAAE,SAAS,GAAG,IAAI,CAAC;IAEvB,wBAAwB;IACxB,IAAI,EAAE,MAAM,CAAC;IAEb,+BAA+B;IAC/B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,mFAAmF;IACnF,GAAG,EAAE,MAAM,CAAC;IAEZ,gEAAgE;IAChE,eAAe,EAAE,eAAe,CAAC;IAEjC,yCAAyC;IACzC,IAAI,EAAE,MAAM,CAAC;IAEb,yCAAyC;IACzC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB,sCAAsC;IACtC,UAAU,EAAE,MAAM,CAAC;IAEnB,wDAAwD;IACxD,UAAU,EAAE,MAAM,CAAC;IAEnB,0DAA0D;IAC1D,kBAAkB,EAAE,OAAO,CAAC;IAE5B,4EAA4E;IAC5E,kBAAkB,EAAE,OAAO,CAAC;IAE5B,iCAAiC;IACjC,eAAe,EAAE,UAAU,CAAC;IAE5B,mDAAmD;IACnD,eAAe,EAAE,UAAU,CAAC;IAE5B,uGAAuG;IACvG,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB,wGAAwG;IACxG,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,YAAY;IAC3B,8HAA8H;IAC9H,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,+BAA+B;IAC/B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,yCAAyC;IACzC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB,2DAA2D;IAC3D,MAAM,EAAE,IAAI,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,qCAAqC;IACrC,EAAE,EAAE,QAAQ,CAAC;IAEb,kDAAkD;IAClD,SAAS,EAAE,MAAM,CAAC;IAElB,wCAAwC;IACxC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,gCAAgC;IAChC,IAAI,EAAE,SAAS,GAAG,IAAI,CAAC;IAEvB,wBAAwB;IACxB,IAAI,EAAE,MAAM,CAAC;IAEb,+BAA+B;IAC/B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,mFAAmF;IACnF,GAAG,EAAE,MAAM,CAAC;IAEZ,gEAAgE;IAChE,eAAe,EAAE,eAAe,CAAC;IAEjC,yCAAyC;IACzC,IAAI,EAAE,MAAM,CAAC;IAEb,yCAAyC;IACzC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB,sCAAsC;IACtC,UAAU,EAAE,MAAM,CAAC;IAEnB,wDAAwD;IACxD,UAAU,EAAE,MAAM,CAAC;IAEnB,0DAA0D;IAC1D,kBAAkB,EAAE,OAAO,CAAC;IAE5B,4EAA4E;IAC5E,kBAAkB,EAAE,OAAO,CAAC;IAE5B,iCAAiC;IACjC,eAAe,EAAE,UAAU,CAAC;IAE5B,mDAAmD;IACnD,eAAe,EAAE,UAAU,CAAC;IAE5B,uGAAuG;IACvG,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB,wGAAwG;IACxG,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB,2DAA2D;IAC3D,MAAM,CAAC,EAAE,IAAI,CAAC;CACf;AAED,MAAM,WAAW,kBAAkB;IACjC,wBAAwB;IACxB,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,+BAA+B;IAC/B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,yCAAyC;IACzC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB,2DAA2D;IAC3D,MAAM,CAAC,EAAE,IAAI,CAAC;CACf;AAED,MAAM,WAAW,WAAW;IAC1B,oCAAoC;IACpC,EAAE,EAAE,QAAQ,CAAC;IAEb,mFAAmF;IACnF,GAAG,EAAE,MAAM,CAAC;IAEZ,wBAAwB;IACxB,IAAI,EAAE,MAAM,CAAC;IAEb,+BAA+B;IAC/B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,gCAAgC;IAChC,IAAI,EAAE,SAAS,GAAG,IAAI,CAAC;IAEvB,wCAAwC;IACxC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,yCAAyC;IACzC,IAAI,EAAE,MAAM,CAAC;IAEb,yCAAyC;IACzC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB,uGAAuG;IACvG,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB,wGAAwG;IACxG,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,iBAAiB;IAChC,qCAAqC;IACrC,EAAE,EAAE,QAAQ,CAAC;IAEb,mFAAmF;IACnF,GAAG,EAAE,MAAM,CAAC;IAEZ,gCAAgC;IAChC,IAAI,EAAE,SAAS,GAAG,IAAI,CAAC;IAEvB,wCAAwC;IACxC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,yCAAyC;IACzC,IAAI,EAAE,MAAM,CAAC;IAEb,yCAAyC;IACzC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB,uGAAuG;IACvG,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB,wGAAwG;IACxG,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB"}

package/lib/cjs/assets.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/cjs/brands.d.ts

@@ -0,0 +1,41 @@
+import { NestedAsset } from "./assets";
+import { NestedOrganization } from "./customer";
+import { NestedUser } from "./customer";
+import { PublicNestedAsset } from "./assets";
+import { BrandUid, OrganizationUid, AssetUid } from "./types";
+/** TODO: Add jsdocs and check nullability of fields */
+export interface Brand {
+    id: BrandUid;
+    organization: NestedOrganization;
+    organization_id: OrganizationUid;
+    name: string;
+    primary_color_code: string | null;
+    secondary_color_code: string | null;
+    logo_asset_id: AssetUid | null;
+    logo_asset: NestedAsset | null;
+    chat_button_asset_id: AssetUid | null;
+    chat_button_asset: NestedAsset | null;
+    created_at: string;
+    updated_at: string;
+    created_by_user_id: string;
+    updated_by_user_id: string;
+    created_by_user: NestedUser;
+    updated_by_user: NestedUser;
+}
+/** TODO: Add jsdocs and check nullability of fields */
+export interface BrandPayload {
+    name: string;
+    primary_color_code: string | null;
+    secondary_color_code: string | null;
+    logo_asset_id?: AssetUid | null;
+}
+/** TODO: Add jsdocs and check nullability of fields */
+export interface PublicBrand {
+    id: BrandUid;
+    organization_id: OrganizationUid;
+    primary_color_code: string | null;
+    secondary_color_code: string | null;
+    logo_asset_id: AssetUid | null;
+    logo_asset: PublicNestedAsset | null;
+}
+//# sourceMappingURL=brands.d.ts.map

package/lib/cjs/brands.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"brands.d.ts","sourceRoot":"","sources":["../../src/brands.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAChD,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AACxC,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAE9D,uDAAuD;AACvD,MAAM,WAAW,KAAK;IACpB,EAAE,EAAE,QAAQ,CAAC;IACb,YAAY,EAAE,kBAAkB,CAAC;IACjC,eAAe,EAAE,eAAe,CAAC;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAC;IACpC,aAAa,EAAE,QAAQ,GAAG,IAAI,CAAC;IAC/B,UAAU,EAAE,WAAW,GAAG,IAAI,CAAC;IAC/B,oBAAoB,EAAE,QAAQ,GAAG,IAAI,CAAC;IACtC,iBAAiB,EAAE,WAAW,GAAG,IAAI,CAAC;IACtC,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,kBAAkB,EAAE,MAAM,CAAC;IAC3B,eAAe,EAAE,UAAU,CAAC;IAC5B,eAAe,EAAE,UAAU,CAAC;CAC7B;AAED,uDAAuD;AACvD,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAC;IACpC,aAAa,CAAC,EAAE,QAAQ,GAAG,IAAI,CAAC;CACjC;AAED,uDAAuD;AACvD,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,QAAQ,CAAC;IACb,eAAe,EAAE,eAAe,CAAC;IACjC,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAC;IACpC,aAAa,EAAE,QAAQ,GAAG,IAAI,CAAC;IAC/B,UAAU,EAAE,iBAAiB,GAAG,IAAI,CAAC;CACtC"}

package/lib/cjs/brands.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/cjs/call.d.ts

@@ -0,0 +1,41 @@
+import { CallStatusUid, ChatUid, UserUid, VisitorCid, OrganizationUid } from "./types";
+export declare type CallStatusType = "idle" | "dialing" | "ringing" | "in-call";
+interface BaseCallStatus {
+    /** Unique identifier of the call status */
+    id: CallStatusUid;
+    /** Call state type */
+    type: CallStatusType;
+    /** Call state, for backward compatibility */
+    state: any;
+    /** Unique identifier of the related chat */
+    chat_id: ChatUid;
+    /** Unique identifier of the user/visitor being present at the call */
+    member_id: UserUid | VisitorCid;
+    /** Unique identifier of the organization of the call */
+    organization_id: OrganizationUid;
+    /** State of audio preference */
+    audio_enabled: boolean;
+    /** State of video preference */
+    video_enabled: boolean;
+    /** The text on ringing state */
+    call_name: string;
+    /** The avatar on ringing state */
+    call_avatar: string;
+}
+export interface IdleCallStatus extends BaseCallStatus {
+    type: "idle";
+}
+export interface DialingCallStatus extends BaseCallStatus {
+    type: "dialing";
+}
+export interface RingingCallStatus extends BaseCallStatus {
+    type: "ringing";
+}
+export declare type CobrowseState = "idle" | "requested" | "denied" | "sharing";
+export interface InCallStatus extends BaseCallStatus {
+    type: "in-call";
+    cobrowse_state: CobrowseState;
+}
+export declare type CallStatus = IdleCallStatus | DialingCallStatus | RingingCallStatus | InCallStatus;
+export {};
+//# sourceMappingURL=call.d.ts.map

package/lib/cjs/call.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"call.d.ts","sourceRoot":"","sources":["../../src/call.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAEvF,oBAAY,cAAc,GAAG,MAAM,GAAG,SAAS,GAAG,SAAS,GAAG,SAAS,CAAC;AAExE,UAAU,cAAc;IACtB,2CAA2C;IAC3C,EAAE,EAAE,aAAa,CAAC;IAClB,sBAAsB;IACtB,IAAI,EAAE,cAAc,CAAC;IACrB,6CAA6C;IAC7C,KAAK,EAAE,GAAG,CAAC;IACX,4CAA4C;IAC5C,OAAO,EAAE,OAAO,CAAC;IACjB,sEAAsE;IACtE,SAAS,EAAE,OAAO,GAAG,UAAU,CAAC;IAChC,wDAAwD;IACxD,eAAe,EAAE,eAAe,CAAC;IAEjC,gCAAgC;IAChC,aAAa,EAAE,OAAO,CAAC;IACvB,gCAAgC;IAChC,aAAa,EAAE,OAAO,CAAC;IAEvB,gCAAgC;IAChC,SAAS,EAAE,MAAM,CAAC;IAClB,kCAAkC;IAClC,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,cAAe,SAAQ,cAAc;IACpD,IAAI,EAAE,MAAM,CAAC;CACd;AACD,MAAM,WAAW,iBAAkB,SAAQ,cAAc;IACvD,IAAI,EAAE,SAAS,CAAC;CACjB;AACD,MAAM,WAAW,iBAAkB,SAAQ,cAAc;IACvD,IAAI,EAAE,SAAS,CAAC;CACjB;AAED,oBAAY,aAAa,GAAG,MAAM,GAAG,WAAW,GAAG,QAAQ,GAAG,SAAS,CAAC;AAExE,MAAM,WAAW,YAAa,SAAQ,cAAc;IAClD,IAAI,EAAE,SAAS,CAAC;IAChB,cAAc,EAAE,aAAa,CAAC;CAC/B;AAED,oBAAY,UAAU,GAAG,cAAc,GAAG,iBAAiB,GAAG,iBAAiB,GAAG,YAAY,CAAC"}

package/lib/cjs/call.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/cjs/canned_answers.d.ts

@@ -0,0 +1,26 @@
+import { OrganizationUid, CannedAnswerUid } from "./types";
+/** TODO: Add jsdocs and check nullability of fields */
+export interface CannedAnswerIncrement {
+    id: CannedAnswerUid;
+    organization_id: OrganizationUid;
+    message: string;
+    organization_count: number;
+    room_count: number;
+    created_at: string;
+    updated_at: string;
+}
+/** TODO: Add jsdocs and check nullability of fields */
+export interface CannedAnswer {
+    id: CannedAnswerUid;
+    organization_id: OrganizationUid;
+    message: string;
+    organization_count: number;
+    room_count: number;
+    created_at: string;
+    updated_at: string;
+}
+/** TODO: Add jsdocs and check nullability of fields */
+export interface CannedAnswerPayload {
+    message: string;
+}
+//# sourceMappingURL=canned_answers.d.ts.map

package/lib/cjs/canned_answers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"canned_answers.d.ts","sourceRoot":"","sources":["../../src/canned_answers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAE3D,uDAAuD;AACvD,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,eAAe,CAAC;IACpB,eAAe,EAAE,eAAe,CAAC;IACjC,OAAO,EAAE,MAAM,CAAC;IAChB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,uDAAuD;AACvD,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,eAAe,CAAC;IACpB,eAAe,EAAE,eAAe,CAAC;IACjC,OAAO,EAAE,MAAM,CAAC;IAChB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,uDAAuD;AACvD,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,MAAM,CAAC;CACjB"}

package/lib/cjs/canned_answers.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });