@openscreen/internal-sdk 1.8.4 → 1.8.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +1 -1
- package/dist/index.mjs.map +1 -1
- package/dist/index.modern.mjs +1 -1
- package/dist/index.modern.mjs.map +1 -1
- package/package.json +3 -2
- package/typings/sdk.d.ts +146 -37
- package/typings/sdk.d.ts.map +1 -1
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@openscreen/internal-sdk",
|
|
3
|
-
"version": "1.8.
|
|
3
|
+
"version": "1.8.5",
|
|
4
4
|
"description": "Openscreen Software Development Kit (SDK)",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"qr",
|
|
@@ -43,7 +43,8 @@
|
|
|
43
43
|
},
|
|
44
44
|
"dependencies": {
|
|
45
45
|
"axios": "0.21.2",
|
|
46
|
-
"moment": "2.29.4"
|
|
46
|
+
"moment": "2.29.4",
|
|
47
|
+
"caniuse-lite": "~1.0.30001643"
|
|
47
48
|
},
|
|
48
49
|
"devDependencies": {
|
|
49
50
|
"@types/jest": "27.0.0",
|
package/typings/sdk.d.ts
CHANGED
|
@@ -143,6 +143,15 @@ export declare enum ContactSortingTypes {
|
|
|
143
143
|
LAST_SCAN_LOCATION = "LAST_SCAN_LOCATION",
|
|
144
144
|
SCAN_COUNT = "SCAN_COUNT"
|
|
145
145
|
}
|
|
146
|
+
export declare enum DomainStatus {
|
|
147
|
+
INITIATED = "INITIATED",
|
|
148
|
+
VERIFIED = "VERIFIED",
|
|
149
|
+
CERTIFICATE_REQUESTED = "CERTIFICATE_REQUESTED",
|
|
150
|
+
CERTIFICATE_VALIDATED = "CERTIFICATE_VALIDATED",
|
|
151
|
+
CDN_DISTRIBUTION_ADDED = "CDN_DISTRIBUTION_ADDED",
|
|
152
|
+
COMPLETED = "COMPLETED",
|
|
153
|
+
FAILED = "FAILED"
|
|
154
|
+
}
|
|
146
155
|
export declare enum EntitySources {
|
|
147
156
|
CARE_API = "CARE_API"
|
|
148
157
|
}
|
|
@@ -589,6 +598,17 @@ export interface AccountByUserCount {
|
|
|
589
598
|
modified?: string | Date | number | null;
|
|
590
599
|
userCount: number;
|
|
591
600
|
}
|
|
601
|
+
export interface AccountDomain {
|
|
602
|
+
accountId: string;
|
|
603
|
+
created?: string | Date | number | null;
|
|
604
|
+
customDomain: string;
|
|
605
|
+
expiresAt?: string | Date | number | null;
|
|
606
|
+
hostedZoneId?: string | null;
|
|
607
|
+
modified?: string | Date | number | null;
|
|
608
|
+
nameServers?: Array<any> | null;
|
|
609
|
+
projectIds?: Array<any> | null;
|
|
610
|
+
status?: DomainStatus;
|
|
611
|
+
}
|
|
592
612
|
export interface AccountEmailContact {
|
|
593
613
|
accountId: string;
|
|
594
614
|
contactId: string;
|
|
@@ -1796,6 +1816,7 @@ export interface LastScan {
|
|
|
1796
1816
|
qrCodeId?: string | null;
|
|
1797
1817
|
scanId: string;
|
|
1798
1818
|
scanTime: string | Date | number;
|
|
1819
|
+
sessionId?: string | null;
|
|
1799
1820
|
userAgent?: string | null;
|
|
1800
1821
|
}
|
|
1801
1822
|
export interface Location {
|
|
@@ -2515,6 +2536,12 @@ export interface ProjectContactByStringCustomAttribute {
|
|
|
2515
2536
|
modified?: string | Date | number | null;
|
|
2516
2537
|
projectId: string;
|
|
2517
2538
|
}
|
|
2539
|
+
export interface ProjectDomain {
|
|
2540
|
+
created?: string | Date | number | null;
|
|
2541
|
+
customDomain: string;
|
|
2542
|
+
modified?: string | Date | number | null;
|
|
2543
|
+
projectId: string;
|
|
2544
|
+
}
|
|
2518
2545
|
export interface ProjectEmailContact {
|
|
2519
2546
|
contactId: string;
|
|
2520
2547
|
created?: string | Date | number | null;
|
|
@@ -2711,6 +2738,7 @@ export interface RequestSessionAction {
|
|
|
2711
2738
|
customAttributes?: NestedKeyValueObject | null;
|
|
2712
2739
|
modified?: string | Date | number | null;
|
|
2713
2740
|
name?: string | null;
|
|
2741
|
+
scanId?: string | null;
|
|
2714
2742
|
tags?: Array<any> | null;
|
|
2715
2743
|
timestamp?: string | Date | number | null;
|
|
2716
2744
|
willUpdateSession?: boolean;
|
|
@@ -2800,7 +2828,9 @@ export interface ResponseSession {
|
|
|
2800
2828
|
category?: string | null;
|
|
2801
2829
|
created?: string | Date | number | null;
|
|
2802
2830
|
customAttributes?: NestedKeyValueObject | null;
|
|
2831
|
+
endTime?: string | Date | number | null;
|
|
2803
2832
|
lastActionId?: string | Date | number | null;
|
|
2833
|
+
lastScanId?: string | null;
|
|
2804
2834
|
lastSessionAction?: SessionAction | null;
|
|
2805
2835
|
modified?: string | Date | number | null;
|
|
2806
2836
|
newTags?: Array<any> | null;
|
|
@@ -2859,6 +2889,7 @@ export interface Scan {
|
|
|
2859
2889
|
qrCodeId?: string | null;
|
|
2860
2890
|
scanId: string;
|
|
2861
2891
|
scanTime: string | Date | number;
|
|
2892
|
+
sessionId?: string | null;
|
|
2862
2893
|
userAgent?: string | null;
|
|
2863
2894
|
}
|
|
2864
2895
|
export interface ScanContact {
|
|
@@ -2883,6 +2914,7 @@ export interface SessionAction {
|
|
|
2883
2914
|
name?: string | null;
|
|
2884
2915
|
projectId: string;
|
|
2885
2916
|
qrCodeId: string;
|
|
2917
|
+
scanId?: string | null;
|
|
2886
2918
|
sessionId: string;
|
|
2887
2919
|
tags?: Array<any> | null;
|
|
2888
2920
|
}
|
|
@@ -3220,7 +3252,9 @@ export interface WebSession {
|
|
|
3220
3252
|
category?: string | null;
|
|
3221
3253
|
created?: string | Date | number | null;
|
|
3222
3254
|
customAttributes?: NestedKeyValueObject | null;
|
|
3255
|
+
endTime?: string | Date | number | null;
|
|
3223
3256
|
lastActionId?: string | Date | number | null;
|
|
3257
|
+
lastScanId?: string | null;
|
|
3224
3258
|
modified?: string | Date | number | null;
|
|
3225
3259
|
newTags?: Array<any> | null;
|
|
3226
3260
|
projectId: string;
|
|
@@ -4927,6 +4961,49 @@ export interface UpdateContactResponseBody {
|
|
|
4927
4961
|
contact: Contact;
|
|
4928
4962
|
contactId: string;
|
|
4929
4963
|
}
|
|
4964
|
+
export interface AssignDomainToProjectPathParameters {
|
|
4965
|
+
customDomain: string;
|
|
4966
|
+
projectId: string;
|
|
4967
|
+
}
|
|
4968
|
+
export interface AssignDomainToProjectResponseBody {
|
|
4969
|
+
projectDomain: ProjectDomain;
|
|
4970
|
+
}
|
|
4971
|
+
export interface CreateCustomDomainByAccountIdPathParameters {
|
|
4972
|
+
accountId: string;
|
|
4973
|
+
}
|
|
4974
|
+
export interface CreateCustomDomainByAccountIdRequestBody {
|
|
4975
|
+
customDomain: string;
|
|
4976
|
+
projectId?: string | null;
|
|
4977
|
+
}
|
|
4978
|
+
export interface CreateCustomDomainByAccountIdResponseBody {
|
|
4979
|
+
accountDomain: AccountDomain;
|
|
4980
|
+
projectDomain?: ProjectDomain | null;
|
|
4981
|
+
}
|
|
4982
|
+
export interface GetCustomDomainPathParameters {
|
|
4983
|
+
accountId: string;
|
|
4984
|
+
customDomain: string;
|
|
4985
|
+
}
|
|
4986
|
+
export interface GetCustomDomainResponseBody {
|
|
4987
|
+
accountDomain: AccountDomain;
|
|
4988
|
+
}
|
|
4989
|
+
export interface GetDomainsByAccountIdPathParameters {
|
|
4990
|
+
accountId: string;
|
|
4991
|
+
}
|
|
4992
|
+
export interface GetDomainsByAccountIdQueryStringParameters {
|
|
4993
|
+
lastKey?: string | null;
|
|
4994
|
+
limit?: number | null;
|
|
4995
|
+
}
|
|
4996
|
+
export interface GetDomainsByAccountIdResponseBody {
|
|
4997
|
+
accountDomains: AccountDomain[];
|
|
4998
|
+
lastKey?: string | null;
|
|
4999
|
+
}
|
|
5000
|
+
export interface TestDomainConnectionPathParameters {
|
|
5001
|
+
accountId: string;
|
|
5002
|
+
customDomain: string;
|
|
5003
|
+
}
|
|
5004
|
+
export interface TestDomainConnectionResponseBody {
|
|
5005
|
+
accountDomain: AccountDomain;
|
|
5006
|
+
}
|
|
4930
5007
|
export interface GetFilePathParameters {
|
|
4931
5008
|
fileId: string;
|
|
4932
5009
|
}
|
|
@@ -6536,6 +6613,21 @@ export declare class LinkContactToScanRequest extends RequestPost<LinkContactToS
|
|
|
6536
6613
|
export declare class UpdateContactRequest extends RequestPatch<UpdateContactPathParameters, undefined, UpdateContactRequestBody, UpdateContactResponseBody> {
|
|
6537
6614
|
routeSegments?: RequestRouteSegment[];
|
|
6538
6615
|
}
|
|
6616
|
+
export declare class AssignDomainToProjectRequest extends RequestPost<AssignDomainToProjectPathParameters, undefined, undefined, AssignDomainToProjectResponseBody> {
|
|
6617
|
+
routeSegments?: RequestRouteSegment[];
|
|
6618
|
+
}
|
|
6619
|
+
export declare class CreateCustomDomainByAccountIdRequest extends RequestPost<CreateCustomDomainByAccountIdPathParameters, undefined, CreateCustomDomainByAccountIdRequestBody, CreateCustomDomainByAccountIdResponseBody> {
|
|
6620
|
+
routeSegments?: RequestRouteSegment[];
|
|
6621
|
+
}
|
|
6622
|
+
export declare class GetCustomDomainRequest extends RequestGet<GetCustomDomainPathParameters, undefined, GetCustomDomainResponseBody> {
|
|
6623
|
+
routeSegments?: RequestRouteSegment[];
|
|
6624
|
+
}
|
|
6625
|
+
export declare class GetDomainsByAccountIdRequest extends RequestGet<GetDomainsByAccountIdPathParameters, GetDomainsByAccountIdQueryStringParameters, GetDomainsByAccountIdResponseBody> {
|
|
6626
|
+
routeSegments?: RequestRouteSegment[];
|
|
6627
|
+
}
|
|
6628
|
+
export declare class TestDomainConnectionRequest extends RequestPatch<TestDomainConnectionPathParameters, undefined, undefined, TestDomainConnectionResponseBody> {
|
|
6629
|
+
routeSegments?: RequestRouteSegment[];
|
|
6630
|
+
}
|
|
6539
6631
|
export declare class GetFileRequest extends RequestPost<GetFilePathParameters, undefined, undefined, GetFileResponseBody> {
|
|
6540
6632
|
routeSegments?: RequestRouteSegment[];
|
|
6541
6633
|
}
|
|
@@ -7030,6 +7122,17 @@ export declare class SdkAccountEngagePricePlanResources extends Resources {
|
|
|
7030
7122
|
export declare class SdkAccountQrcodelogosUploadResources extends Resources {
|
|
7031
7123
|
create(requestBody: UploadQrCodeLogoByAccountRequestBody, options?: any): Promise<UploadQrCodeLogoByAccountResponseBody>;
|
|
7032
7124
|
}
|
|
7125
|
+
export declare class SdkAccountCustomDomainsResources extends Resources {
|
|
7126
|
+
create(requestBody: CreateCustomDomainByAccountIdRequestBody, options?: any): Promise<CreateCustomDomainByAccountIdResponseBody>;
|
|
7127
|
+
get(queryStringParameters: GetDomainsByAccountIdQueryStringParameters, options?: any): Promise<GetDomainsByAccountIdResponseBody>;
|
|
7128
|
+
}
|
|
7129
|
+
export declare class SdkAccountCustomDomainTestResources extends Resources {
|
|
7130
|
+
update(options?: any): Promise<TestDomainConnectionResponseBody>;
|
|
7131
|
+
}
|
|
7132
|
+
export declare class SdkAccountCustomDomainResource extends Resource {
|
|
7133
|
+
test(): SdkAccountCustomDomainTestResources;
|
|
7134
|
+
get(options?: any): Promise<GetCustomDomainResponseBody>;
|
|
7135
|
+
}
|
|
7033
7136
|
export declare class SdkAccountResource extends Resource {
|
|
7034
7137
|
urlSafeties(): SdkAccountUrlSafetiesResources;
|
|
7035
7138
|
apikeys(): SdkAccountApikeysResources;
|
|
@@ -7081,6 +7184,8 @@ export declare class SdkAccountResource extends Resource {
|
|
|
7081
7184
|
clock(): SdkAccountClockResources;
|
|
7082
7185
|
engagePricePlan(): SdkAccountEngagePricePlanResources;
|
|
7083
7186
|
qrcodelogosUpload(): SdkAccountQrcodelogosUploadResources;
|
|
7187
|
+
customDomains(): SdkAccountCustomDomainsResources;
|
|
7188
|
+
customDomain(customDomain: string): SdkAccountCustomDomainResource;
|
|
7084
7189
|
get(options?: any): Promise<GetAccountResponseBody>;
|
|
7085
7190
|
update(requestBody: UpdateAccountRequestBody, options?: any): Promise<UpdateAccountResponseBody>;
|
|
7086
7191
|
}
|
|
@@ -7251,42 +7356,8 @@ export declare class SdkContactResource extends Resource {
|
|
|
7251
7356
|
get(options?: any): Promise<GetContactResponseBody>;
|
|
7252
7357
|
update(requestBody: UpdateContactRequestBody, options?: any): Promise<UpdateContactResponseBody>;
|
|
7253
7358
|
}
|
|
7254
|
-
export declare class
|
|
7255
|
-
create(options?: any): Promise<
|
|
7256
|
-
}
|
|
7257
|
-
export declare class SdkFileResource extends Resource {
|
|
7258
|
-
validate(): SdkFileValidateResources;
|
|
7259
|
-
}
|
|
7260
|
-
export declare class SdkInvitationUsersResources extends Resources {
|
|
7261
|
-
create(options?: any): Promise<CreateUserByInvitationIdResponseBody>;
|
|
7262
|
-
}
|
|
7263
|
-
export declare class SdkInvitationResource extends Resource {
|
|
7264
|
-
users(): SdkInvitationUsersResources;
|
|
7265
|
-
delete(options?: any): Promise<DeleteInvitationResponseBody>;
|
|
7266
|
-
get(options?: any): Promise<GetInvitationResponseBody>;
|
|
7267
|
-
}
|
|
7268
|
-
export declare class SdkJobResource extends Resource {
|
|
7269
|
-
delete(options?: any): Promise<DeleteJobResponseBody>;
|
|
7270
|
-
get(options?: any): Promise<GetJobResponseBody>;
|
|
7271
|
-
}
|
|
7272
|
-
export declare class SdkPrintJobResource extends Resource {
|
|
7273
|
-
delete(options?: any): Promise<DeletePrintJobResponseBody>;
|
|
7274
|
-
invoke(options?: any): Promise<InvokePrintJobByJobIdResponseBody>;
|
|
7275
|
-
}
|
|
7276
|
-
export declare class SdkLocationAssetsResources extends Resources {
|
|
7277
|
-
update(requestBody: UpdateAssetsLocationsRequestBody, options?: any): Promise<UpdateAssetsLocationsResponseBody>;
|
|
7278
|
-
get(queryStringParameters: GetAssetsByLocationIdQueryStringParameters, options?: any): Promise<GetAssetsByLocationIdResponseBody>;
|
|
7279
|
-
}
|
|
7280
|
-
export declare class SdkLocationResource extends Resource {
|
|
7281
|
-
assets(): SdkLocationAssetsResources;
|
|
7282
|
-
delete(queryStringParameters: DeleteLocationQueryStringParameters, options?: any): Promise<DeleteLocationResponseBody>;
|
|
7283
|
-
update(requestBody: UpdateLocationRequestBody, options?: any): Promise<UpdateLocationResponseBody>;
|
|
7284
|
-
}
|
|
7285
|
-
export declare class SdkSupportResources extends Resources {
|
|
7286
|
-
create(requestBody: SendSupportEmailRequestBody, options?: any): Promise<any>;
|
|
7287
|
-
}
|
|
7288
|
-
export declare class SdkPricePlansResources extends Resources {
|
|
7289
|
-
get(options?: any): Promise<GetPricePlansResponseBody>;
|
|
7359
|
+
export declare class SdkProjectCustomDomainResource extends Resource {
|
|
7360
|
+
create(options?: any): Promise<AssignDomainToProjectResponseBody>;
|
|
7290
7361
|
}
|
|
7291
7362
|
export declare class SdkProjectAssetsResources extends Resources {
|
|
7292
7363
|
create(requestBody: CreateAssetByProjectIdRequestBody, options?: any): Promise<CreateAssetByProjectIdResponseBody>;
|
|
@@ -7389,6 +7460,7 @@ export declare class SdkProjectUsermediasResources extends Resources {
|
|
|
7389
7460
|
get(queryStringParameters: GetUserMediasByProjectIdQueryStringParameters, options?: any): Promise<GetUserMediasByProjectIdResponseBody>;
|
|
7390
7461
|
}
|
|
7391
7462
|
export declare class SdkProjectResource extends Resource {
|
|
7463
|
+
customDomain(customDomain: string): SdkProjectCustomDomainResource;
|
|
7392
7464
|
assets(): SdkProjectAssetsResources;
|
|
7393
7465
|
jobsAssetbatch(): SdkProjectJobsAssetbatchResources;
|
|
7394
7466
|
presignedurlJobsAssetbatch(): SdkProjectPresignedurlJobsAssetbatchResources;
|
|
@@ -7424,6 +7496,43 @@ export declare class SdkProjectResource extends Resource {
|
|
|
7424
7496
|
get(options?: any): Promise<GetProjectByProjectIdResponseBody>;
|
|
7425
7497
|
update(requestBody: UpdateProjectByProjectIdRequestBody, options?: any): Promise<UpdateProjectByProjectIdResponseBody>;
|
|
7426
7498
|
}
|
|
7499
|
+
export declare class SdkFileValidateResources extends Resources {
|
|
7500
|
+
create(options?: any): Promise<ValidateFileResponseBody>;
|
|
7501
|
+
}
|
|
7502
|
+
export declare class SdkFileResource extends Resource {
|
|
7503
|
+
validate(): SdkFileValidateResources;
|
|
7504
|
+
}
|
|
7505
|
+
export declare class SdkInvitationUsersResources extends Resources {
|
|
7506
|
+
create(options?: any): Promise<CreateUserByInvitationIdResponseBody>;
|
|
7507
|
+
}
|
|
7508
|
+
export declare class SdkInvitationResource extends Resource {
|
|
7509
|
+
users(): SdkInvitationUsersResources;
|
|
7510
|
+
delete(options?: any): Promise<DeleteInvitationResponseBody>;
|
|
7511
|
+
get(options?: any): Promise<GetInvitationResponseBody>;
|
|
7512
|
+
}
|
|
7513
|
+
export declare class SdkJobResource extends Resource {
|
|
7514
|
+
delete(options?: any): Promise<DeleteJobResponseBody>;
|
|
7515
|
+
get(options?: any): Promise<GetJobResponseBody>;
|
|
7516
|
+
}
|
|
7517
|
+
export declare class SdkPrintJobResource extends Resource {
|
|
7518
|
+
delete(options?: any): Promise<DeletePrintJobResponseBody>;
|
|
7519
|
+
invoke(options?: any): Promise<InvokePrintJobByJobIdResponseBody>;
|
|
7520
|
+
}
|
|
7521
|
+
export declare class SdkLocationAssetsResources extends Resources {
|
|
7522
|
+
update(requestBody: UpdateAssetsLocationsRequestBody, options?: any): Promise<UpdateAssetsLocationsResponseBody>;
|
|
7523
|
+
get(queryStringParameters: GetAssetsByLocationIdQueryStringParameters, options?: any): Promise<GetAssetsByLocationIdResponseBody>;
|
|
7524
|
+
}
|
|
7525
|
+
export declare class SdkLocationResource extends Resource {
|
|
7526
|
+
assets(): SdkLocationAssetsResources;
|
|
7527
|
+
delete(queryStringParameters: DeleteLocationQueryStringParameters, options?: any): Promise<DeleteLocationResponseBody>;
|
|
7528
|
+
update(requestBody: UpdateLocationRequestBody, options?: any): Promise<UpdateLocationResponseBody>;
|
|
7529
|
+
}
|
|
7530
|
+
export declare class SdkSupportResources extends Resources {
|
|
7531
|
+
create(requestBody: SendSupportEmailRequestBody, options?: any): Promise<any>;
|
|
7532
|
+
}
|
|
7533
|
+
export declare class SdkPricePlansResources extends Resources {
|
|
7534
|
+
get(options?: any): Promise<GetPricePlansResponseBody>;
|
|
7535
|
+
}
|
|
7427
7536
|
export declare class SdkQrcodelogoResource extends Resource {
|
|
7428
7537
|
get(options?: any): Promise<GetQrCodeLogoByQrCodeLogoIdResponseBody>;
|
|
7429
7538
|
update(requestBody: UpdateQrCodeLogoByQrCodeLogoIdRequestBody, options?: any): Promise<UpdateQrCodeLogoByQrCodeLogoIdResponseBody>;
|
|
@@ -7574,6 +7683,7 @@ export declare class SdkResources extends Resources {
|
|
|
7574
7683
|
billingUpgradePlan(accountId: string): SdkBillingUpgradePlanResource;
|
|
7575
7684
|
careAccounts(): SdkCareAccountsResources;
|
|
7576
7685
|
contact(contactId: string): SdkContactResource;
|
|
7686
|
+
project(projectId: string): SdkProjectResource;
|
|
7577
7687
|
file(fileId: string): SdkFileResource;
|
|
7578
7688
|
invitation(invitationId: string): SdkInvitationResource;
|
|
7579
7689
|
job(jobId: string): SdkJobResource;
|
|
@@ -7581,7 +7691,6 @@ export declare class SdkResources extends Resources {
|
|
|
7581
7691
|
location(locationId: string): SdkLocationResource;
|
|
7582
7692
|
support(): SdkSupportResources;
|
|
7583
7693
|
pricePlans(): SdkPricePlansResources;
|
|
7584
|
-
project(projectId: string): SdkProjectResource;
|
|
7585
7694
|
qrcodelogo(qrCodeLogoId: string): SdkQrcodelogoResource;
|
|
7586
7695
|
qrCode(qrCodeId: string): SdkQrCodeResource;
|
|
7587
7696
|
scan(scanId: string): SdkScanResource;
|