@openscreen/internal-sdk 1.8.4 → 1.8.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openscreen/internal-sdk",
-  "version": "1.8.4",
+  "version": "1.8.6",
   "description": "Openscreen Software Development Kit (SDK)",
   "keywords": [
     "qr",
@@ -43,7 +43,8 @@
   },
   "dependencies": {
     "axios": "0.21.2",
-    "moment": "2.29.4"
+    "moment": "2.29.4",
+    "caniuse-lite": "~1.0.30001643"
   },
   "devDependencies": {
     "@types/jest": "27.0.0",

package/typings/sdk.d.ts

@@ -143,6 +143,15 @@ export declare enum ContactSortingTypes {
     LAST_SCAN_LOCATION = "LAST_SCAN_LOCATION",
     SCAN_COUNT = "SCAN_COUNT"
 }
+export declare enum DomainStatus {
+    INITIATED = "INITIATED",
+    VERIFIED = "VERIFIED",
+    CERTIFICATE_REQUESTED = "CERTIFICATE_REQUESTED",
+    CERTIFICATE_VALIDATED = "CERTIFICATE_VALIDATED",
+    CDN_DISTRIBUTION_ADDED = "CDN_DISTRIBUTION_ADDED",
+    COMPLETED = "COMPLETED",
+    FAILED = "FAILED"
+}
 export declare enum EntitySources {
     CARE_API = "CARE_API"
 }
@@ -437,6 +446,7 @@ export interface Account {
     contactCount: number;
     created?: string | Date | number | null;
     customAttributeCount: number;
+    defaultCustomDomain?: string | null;
     dynamicQrCodeCount: number;
     emailCount: number;
     isLocked?: boolean | null;
@@ -589,6 +599,18 @@ export interface AccountByUserCount {
     modified?: string | Date | number | null;
     userCount: number;
 }
+export interface AccountDomain {
+    accountId: string;
+    created?: string | Date | number | null;
+    customDomain: string;
+    expiresAt?: string | Date | number | null;
+    hostedZoneId?: string | null;
+    modified?: string | Date | number | null;
+    nameServers?: Array<any> | null;
+    projectIds?: Array<any> | null;
+    status?: DomainStatus;
+    title?: string | null;
+}
 export interface AccountEmailContact {
     accountId: string;
     contactId: string;
@@ -658,6 +680,7 @@ export interface AccountResponse extends Account {
     created?: string | Date | number | null;
     currentPeriod: PricePlanPeriod;
     customAttributeCount: number;
+    defaultCustomDomain?: string | null;
     dynamicQrCodeCount: number;
     emailCount: number;
     isLocked?: boolean | null;
@@ -1237,6 +1260,7 @@ export interface CareUIAccounByIdResponse extends Account {
     created?: string | Date | number | null;
     currentPeriod: PricePlanPeriod;
     customAttributeCount: number;
+    defaultCustomDomain?: string | null;
     dynamicQrCodeCount: number;
     emailCount: number;
     isLocked?: boolean | null;
@@ -1291,6 +1315,7 @@ export interface CareUIPortalAccountResponse extends Account {
     createdDate: string | Date | number;
     currentPeriod: PricePlanPeriod;
     customAttributeCount: number;
+    defaultCustomDomain?: string | null;
     dynamicQrCodeCount: number;
     emailCount: number;
     isLocked?: boolean | null;
@@ -1796,6 +1821,7 @@ export interface LastScan {
     qrCodeId?: string | null;
     scanId: string;
     scanTime: string | Date | number;
+    sessionId?: string | null;
     userAgent?: string | null;
 }
 export interface Location {
@@ -2515,6 +2541,12 @@ export interface ProjectContactByStringCustomAttribute {
     modified?: string | Date | number | null;
     projectId: string;
 }
+export interface ProjectDomain {
+    created?: string | Date | number | null;
+    customDomain: string;
+    modified?: string | Date | number | null;
+    projectId: string;
+}
 export interface ProjectEmailContact {
     contactId: string;
     created?: string | Date | number | null;
@@ -2711,6 +2743,7 @@ export interface RequestSessionAction {
     customAttributes?: NestedKeyValueObject | null;
     modified?: string | Date | number | null;
     name?: string | null;
+    scanId?: string | null;
     tags?: Array<any> | null;
     timestamp?: string | Date | number | null;
     willUpdateSession?: boolean;
@@ -2800,7 +2833,9 @@ export interface ResponseSession {
     category?: string | null;
     created?: string | Date | number | null;
     customAttributes?: NestedKeyValueObject | null;
+    endTime?: string | Date | number | null;
     lastActionId?: string | Date | number | null;
+    lastScanId?: string | null;
     lastSessionAction?: SessionAction | null;
     modified?: string | Date | number | null;
     newTags?: Array<any> | null;
@@ -2859,6 +2894,7 @@ export interface Scan {
     qrCodeId?: string | null;
     scanId: string;
     scanTime: string | Date | number;
+    sessionId?: string | null;
     userAgent?: string | null;
 }
 export interface ScanContact {
@@ -2883,6 +2919,7 @@ export interface SessionAction {
     name?: string | null;
     projectId: string;
     qrCodeId: string;
+    scanId?: string | null;
     sessionId: string;
     tags?: Array<any> | null;
 }
@@ -3220,7 +3257,9 @@ export interface WebSession {
     category?: string | null;
     created?: string | Date | number | null;
     customAttributes?: NestedKeyValueObject | null;
+    endTime?: string | Date | number | null;
     lastActionId?: string | Date | number | null;
+    lastScanId?: string | null;
     modified?: string | Date | number | null;
     newTags?: Array<any> | null;
     projectId: string;
@@ -3499,6 +3538,7 @@ export interface GetAccountResponseBody extends Account {
     created?: string | Date | number | null;
     currentPeriod: PricePlanPeriod;
     customAttributeCount: number;
+    defaultCustomDomain?: string | null;
     dynamicQrCodeCount: number;
     emailCount: number;
     isLocked?: boolean | null;
@@ -4063,7 +4103,7 @@ export interface UpdateAccountPathParameters {
 }
 export interface UpdateAccountRequestBody {
     companyName?: string | null;
-    qrDomain?: string | null;
+    defaultCustomDomain?: string | null;
 }
 export interface UpdateAccountResponseBody extends Account {
     accountId: string;
@@ -4075,6 +4115,7 @@ export interface UpdateAccountResponseBody extends Account {
     contactCount: number;
     created?: string | Date | number | null;
     customAttributeCount: number;
+    defaultCustomDomain?: string | null;
     dynamicQrCodeCount: number;
     emailCount: number;
     isLocked?: boolean | null;
@@ -4251,6 +4292,7 @@ export interface GetMainAccountByAppAccountIdResponseBody extends Account {
     contactCount: number;
     created?: string | Date | number | null;
     customAttributeCount: number;
+    defaultCustomDomain?: string | null;
     dynamicQrCodeCount: number;
     emailCount: number;
     isLocked?: boolean | null;
@@ -4927,6 +4969,50 @@ export interface UpdateContactResponseBody {
     contact: Contact;
     contactId: string;
 }
+export interface AssignDomainToProjectPathParameters {
+    customDomain: string;
+    projectId: string;
+}
+export interface AssignDomainToProjectResponseBody {
+    projectDomain: ProjectDomain;
+}
+export interface CreateCustomDomainByAccountIdPathParameters {
+    accountId: string;
+}
+export interface CreateCustomDomainByAccountIdRequestBody {
+    customDomain: string;
+    projectId?: string | null;
+    title?: string | null;
+}
+export interface CreateCustomDomainByAccountIdResponseBody {
+    accountDomain: AccountDomain;
+    projectDomain?: ProjectDomain | null;
+}
+export interface GetCustomDomainPathParameters {
+    accountId: string;
+    customDomain: string;
+}
+export interface GetCustomDomainResponseBody {
+    accountDomain: AccountDomain;
+}
+export interface GetDomainsByAccountIdPathParameters {
+    accountId: string;
+}
+export interface GetDomainsByAccountIdQueryStringParameters {
+    lastKey?: string | null;
+    limit?: number | null;
+}
+export interface GetDomainsByAccountIdResponseBody {
+    accountDomains: AccountDomain[];
+    lastKey?: string | null;
+}
+export interface TestDomainConnectionPathParameters {
+    accountId: string;
+    customDomain: string;
+}
+export interface TestDomainConnectionResponseBody {
+    accountDomain: AccountDomain;
+}
 export interface GetFilePathParameters {
     fileId: string;
 }
@@ -5948,6 +6034,7 @@ export interface CreateAccountByUserIdResponseBody extends Account {
     contactCount: number;
     created?: string | Date | number | null;
     customAttributeCount: number;
+    defaultCustomDomain?: string | null;
     dynamicQrCodeCount: number;
     emailCount: number;
     isLocked?: boolean | null;
@@ -6536,6 +6623,21 @@ export declare class LinkContactToScanRequest extends RequestPost<LinkContactToS
 export declare class UpdateContactRequest extends RequestPatch<UpdateContactPathParameters, undefined, UpdateContactRequestBody, UpdateContactResponseBody> {
     routeSegments?: RequestRouteSegment[];
 }
+export declare class AssignDomainToProjectRequest extends RequestPost<AssignDomainToProjectPathParameters, undefined, undefined, AssignDomainToProjectResponseBody> {
+    routeSegments?: RequestRouteSegment[];
+}
+export declare class CreateCustomDomainByAccountIdRequest extends RequestPost<CreateCustomDomainByAccountIdPathParameters, undefined, CreateCustomDomainByAccountIdRequestBody, CreateCustomDomainByAccountIdResponseBody> {
+    routeSegments?: RequestRouteSegment[];
+}
+export declare class GetCustomDomainRequest extends RequestGet<GetCustomDomainPathParameters, undefined, GetCustomDomainResponseBody> {
+    routeSegments?: RequestRouteSegment[];
+}
+export declare class GetDomainsByAccountIdRequest extends RequestGet<GetDomainsByAccountIdPathParameters, GetDomainsByAccountIdQueryStringParameters, GetDomainsByAccountIdResponseBody> {
+    routeSegments?: RequestRouteSegment[];
+}
+export declare class TestDomainConnectionRequest extends RequestPatch<TestDomainConnectionPathParameters, undefined, undefined, TestDomainConnectionResponseBody> {
+    routeSegments?: RequestRouteSegment[];
+}
 export declare class GetFileRequest extends RequestPost<GetFilePathParameters, undefined, undefined, GetFileResponseBody> {
     routeSegments?: RequestRouteSegment[];
 }
@@ -7030,6 +7132,17 @@ export declare class SdkAccountEngagePricePlanResources extends Resources {
 export declare class SdkAccountQrcodelogosUploadResources extends Resources {
     create(requestBody: UploadQrCodeLogoByAccountRequestBody, options?: any): Promise<UploadQrCodeLogoByAccountResponseBody>;
 }
+export declare class SdkAccountCustomDomainsResources extends Resources {
+    create(requestBody: CreateCustomDomainByAccountIdRequestBody, options?: any): Promise<CreateCustomDomainByAccountIdResponseBody>;
+    get(queryStringParameters: GetDomainsByAccountIdQueryStringParameters, options?: any): Promise<GetDomainsByAccountIdResponseBody>;
+}
+export declare class SdkAccountCustomDomainTestResources extends Resources {
+    update(options?: any): Promise<TestDomainConnectionResponseBody>;
+}
+export declare class SdkAccountCustomDomainResource extends Resource {
+    test(): SdkAccountCustomDomainTestResources;
+    get(options?: any): Promise<GetCustomDomainResponseBody>;
+}
 export declare class SdkAccountResource extends Resource {
     urlSafeties(): SdkAccountUrlSafetiesResources;
     apikeys(): SdkAccountApikeysResources;
@@ -7081,6 +7194,8 @@ export declare class SdkAccountResource extends Resource {
     clock(): SdkAccountClockResources;
     engagePricePlan(): SdkAccountEngagePricePlanResources;
     qrcodelogosUpload(): SdkAccountQrcodelogosUploadResources;
+    customDomains(): SdkAccountCustomDomainsResources;
+    customDomain(customDomain: string): SdkAccountCustomDomainResource;
     get(options?: any): Promise<GetAccountResponseBody>;
     update(requestBody: UpdateAccountRequestBody, options?: any): Promise<UpdateAccountResponseBody>;
 }
@@ -7251,42 +7366,8 @@ export declare class SdkContactResource extends Resource {
     get(options?: any): Promise<GetContactResponseBody>;
     update(requestBody: UpdateContactRequestBody, options?: any): Promise<UpdateContactResponseBody>;
 }
-export declare class SdkFileValidateResources extends Resources {
-    create(options?: any): Promise<ValidateFileResponseBody>;
-}
-export declare class SdkFileResource extends Resource {
-    validate(): SdkFileValidateResources;
-}
-export declare class SdkInvitationUsersResources extends Resources {
-    create(options?: any): Promise<CreateUserByInvitationIdResponseBody>;
-}
-export declare class SdkInvitationResource extends Resource {
-    users(): SdkInvitationUsersResources;
-    delete(options?: any): Promise<DeleteInvitationResponseBody>;
-    get(options?: any): Promise<GetInvitationResponseBody>;
-}
-export declare class SdkJobResource extends Resource {
-    delete(options?: any): Promise<DeleteJobResponseBody>;
-    get(options?: any): Promise<GetJobResponseBody>;
-}
-export declare class SdkPrintJobResource extends Resource {
-    delete(options?: any): Promise<DeletePrintJobResponseBody>;
-    invoke(options?: any): Promise<InvokePrintJobByJobIdResponseBody>;
-}
-export declare class SdkLocationAssetsResources extends Resources {
-    update(requestBody: UpdateAssetsLocationsRequestBody, options?: any): Promise<UpdateAssetsLocationsResponseBody>;
-    get(queryStringParameters: GetAssetsByLocationIdQueryStringParameters, options?: any): Promise<GetAssetsByLocationIdResponseBody>;
-}
-export declare class SdkLocationResource extends Resource {
-    assets(): SdkLocationAssetsResources;
-    delete(queryStringParameters: DeleteLocationQueryStringParameters, options?: any): Promise<DeleteLocationResponseBody>;
-    update(requestBody: UpdateLocationRequestBody, options?: any): Promise<UpdateLocationResponseBody>;
-}
-export declare class SdkSupportResources extends Resources {
-    create(requestBody: SendSupportEmailRequestBody, options?: any): Promise<any>;
-}
-export declare class SdkPricePlansResources extends Resources {
-    get(options?: any): Promise<GetPricePlansResponseBody>;
+export declare class SdkProjectCustomDomainResource extends Resource {
+    create(options?: any): Promise<AssignDomainToProjectResponseBody>;
 }
 export declare class SdkProjectAssetsResources extends Resources {
     create(requestBody: CreateAssetByProjectIdRequestBody, options?: any): Promise<CreateAssetByProjectIdResponseBody>;
@@ -7389,6 +7470,7 @@ export declare class SdkProjectUsermediasResources extends Resources {
     get(queryStringParameters: GetUserMediasByProjectIdQueryStringParameters, options?: any): Promise<GetUserMediasByProjectIdResponseBody>;
 }
 export declare class SdkProjectResource extends Resource {
+    customDomain(customDomain: string): SdkProjectCustomDomainResource;
     assets(): SdkProjectAssetsResources;
     jobsAssetbatch(): SdkProjectJobsAssetbatchResources;
     presignedurlJobsAssetbatch(): SdkProjectPresignedurlJobsAssetbatchResources;
@@ -7424,6 +7506,43 @@ export declare class SdkProjectResource extends Resource {
     get(options?: any): Promise<GetProjectByProjectIdResponseBody>;
     update(requestBody: UpdateProjectByProjectIdRequestBody, options?: any): Promise<UpdateProjectByProjectIdResponseBody>;
 }
+export declare class SdkFileValidateResources extends Resources {
+    create(options?: any): Promise<ValidateFileResponseBody>;
+}
+export declare class SdkFileResource extends Resource {
+    validate(): SdkFileValidateResources;
+}
+export declare class SdkInvitationUsersResources extends Resources {
+    create(options?: any): Promise<CreateUserByInvitationIdResponseBody>;
+}
+export declare class SdkInvitationResource extends Resource {
+    users(): SdkInvitationUsersResources;
+    delete(options?: any): Promise<DeleteInvitationResponseBody>;
+    get(options?: any): Promise<GetInvitationResponseBody>;
+}
+export declare class SdkJobResource extends Resource {
+    delete(options?: any): Promise<DeleteJobResponseBody>;
+    get(options?: any): Promise<GetJobResponseBody>;
+}
+export declare class SdkPrintJobResource extends Resource {
+    delete(options?: any): Promise<DeletePrintJobResponseBody>;
+    invoke(options?: any): Promise<InvokePrintJobByJobIdResponseBody>;
+}
+export declare class SdkLocationAssetsResources extends Resources {
+    update(requestBody: UpdateAssetsLocationsRequestBody, options?: any): Promise<UpdateAssetsLocationsResponseBody>;
+    get(queryStringParameters: GetAssetsByLocationIdQueryStringParameters, options?: any): Promise<GetAssetsByLocationIdResponseBody>;
+}
+export declare class SdkLocationResource extends Resource {
+    assets(): SdkLocationAssetsResources;
+    delete(queryStringParameters: DeleteLocationQueryStringParameters, options?: any): Promise<DeleteLocationResponseBody>;
+    update(requestBody: UpdateLocationRequestBody, options?: any): Promise<UpdateLocationResponseBody>;
+}
+export declare class SdkSupportResources extends Resources {
+    create(requestBody: SendSupportEmailRequestBody, options?: any): Promise<any>;
+}
+export declare class SdkPricePlansResources extends Resources {
+    get(options?: any): Promise<GetPricePlansResponseBody>;
+}
 export declare class SdkQrcodelogoResource extends Resource {
     get(options?: any): Promise<GetQrCodeLogoByQrCodeLogoIdResponseBody>;
     update(requestBody: UpdateQrCodeLogoByQrCodeLogoIdRequestBody, options?: any): Promise<UpdateQrCodeLogoByQrCodeLogoIdResponseBody>;
@@ -7574,6 +7693,7 @@ export declare class SdkResources extends Resources {
     billingUpgradePlan(accountId: string): SdkBillingUpgradePlanResource;
     careAccounts(): SdkCareAccountsResources;
     contact(contactId: string): SdkContactResource;
+    project(projectId: string): SdkProjectResource;
     file(fileId: string): SdkFileResource;
     invitation(invitationId: string): SdkInvitationResource;
     job(jobId: string): SdkJobResource;
@@ -7581,7 +7701,6 @@ export declare class SdkResources extends Resources {
     location(locationId: string): SdkLocationResource;
     support(): SdkSupportResources;
     pricePlans(): SdkPricePlansResources;
-    project(projectId: string): SdkProjectResource;
     qrcodelogo(qrCodeLogoId: string): SdkQrcodelogoResource;
     qrCode(qrCodeId: string): SdkQrCodeResource;
     scan(scanId: string): SdkScanResource;