@openscreen/internal-sdk 1.8.3 → 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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openscreen/internal-sdk",
3
- "version": "1.8.3",
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;
@@ -738,6 +758,7 @@ export interface App {
738
758
  appPrice: number;
739
759
  appStoreThumbnail?: string | null;
740
760
  appWebhook?: string | null;
761
+ bannerImage?: string | null;
741
762
  cardImage?: string | null;
742
763
  categories?: Array<any> | null;
743
764
  created?: string | Date | number | null;
@@ -1795,6 +1816,7 @@ export interface LastScan {
1795
1816
  qrCodeId?: string | null;
1796
1817
  scanId: string;
1797
1818
  scanTime: string | Date | number;
1819
+ sessionId?: string | null;
1798
1820
  userAgent?: string | null;
1799
1821
  }
1800
1822
  export interface Location {
@@ -2184,6 +2206,7 @@ export interface PatchApp {
2184
2206
  appPrice?: number | null;
2185
2207
  appStoreThumbnail?: string | null;
2186
2208
  appWebhook?: string | null;
2209
+ bannerImage?: string | null;
2187
2210
  cardImage?: string | null;
2188
2211
  categories?: Array<any> | null;
2189
2212
  created?: string | Date | number | null;
@@ -2513,6 +2536,12 @@ export interface ProjectContactByStringCustomAttribute {
2513
2536
  modified?: string | Date | number | null;
2514
2537
  projectId: string;
2515
2538
  }
2539
+ export interface ProjectDomain {
2540
+ created?: string | Date | number | null;
2541
+ customDomain: string;
2542
+ modified?: string | Date | number | null;
2543
+ projectId: string;
2544
+ }
2516
2545
  export interface ProjectEmailContact {
2517
2546
  contactId: string;
2518
2547
  created?: string | Date | number | null;
@@ -2684,6 +2713,7 @@ export interface RequestApp {
2684
2713
  appPrice: number;
2685
2714
  appStoreThumbnail?: string | null;
2686
2715
  appWebhook?: string | null;
2716
+ bannerImage?: string | null;
2687
2717
  cardImage?: string | null;
2688
2718
  categories?: Array<any> | null;
2689
2719
  created?: string | Date | number | null;
@@ -2708,6 +2738,7 @@ export interface RequestSessionAction {
2708
2738
  customAttributes?: NestedKeyValueObject | null;
2709
2739
  modified?: string | Date | number | null;
2710
2740
  name?: string | null;
2741
+ scanId?: string | null;
2711
2742
  tags?: Array<any> | null;
2712
2743
  timestamp?: string | Date | number | null;
2713
2744
  willUpdateSession?: boolean;
@@ -2797,7 +2828,9 @@ export interface ResponseSession {
2797
2828
  category?: string | null;
2798
2829
  created?: string | Date | number | null;
2799
2830
  customAttributes?: NestedKeyValueObject | null;
2831
+ endTime?: string | Date | number | null;
2800
2832
  lastActionId?: string | Date | number | null;
2833
+ lastScanId?: string | null;
2801
2834
  lastSessionAction?: SessionAction | null;
2802
2835
  modified?: string | Date | number | null;
2803
2836
  newTags?: Array<any> | null;
@@ -2856,6 +2889,7 @@ export interface Scan {
2856
2889
  qrCodeId?: string | null;
2857
2890
  scanId: string;
2858
2891
  scanTime: string | Date | number;
2892
+ sessionId?: string | null;
2859
2893
  userAgent?: string | null;
2860
2894
  }
2861
2895
  export interface ScanContact {
@@ -2880,6 +2914,7 @@ export interface SessionAction {
2880
2914
  name?: string | null;
2881
2915
  projectId: string;
2882
2916
  qrCodeId: string;
2917
+ scanId?: string | null;
2883
2918
  sessionId: string;
2884
2919
  tags?: Array<any> | null;
2885
2920
  }
@@ -3217,7 +3252,9 @@ export interface WebSession {
3217
3252
  category?: string | null;
3218
3253
  created?: string | Date | number | null;
3219
3254
  customAttributes?: NestedKeyValueObject | null;
3255
+ endTime?: string | Date | number | null;
3220
3256
  lastActionId?: string | Date | number | null;
3257
+ lastScanId?: string | null;
3221
3258
  modified?: string | Date | number | null;
3222
3259
  newTags?: Array<any> | null;
3223
3260
  projectId: string;
@@ -4924,6 +4961,49 @@ export interface UpdateContactResponseBody {
4924
4961
  contact: Contact;
4925
4962
  contactId: string;
4926
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
+ }
4927
5007
  export interface GetFilePathParameters {
4928
5008
  fileId: string;
4929
5009
  }
@@ -5759,6 +5839,7 @@ export interface SendSmsByScanIdRequestBody {
5759
5839
  cellPhone?: string | null;
5760
5840
  contactId?: string | null;
5761
5841
  customVariables?: NestedKeyValueObject | null;
5842
+ sessionId?: string | null;
5762
5843
  smsTemplateName?: string | null;
5763
5844
  }
5764
5845
  export interface SendSmsByScanIdResponseBody {
@@ -6532,6 +6613,21 @@ export declare class LinkContactToScanRequest extends RequestPost<LinkContactToS
6532
6613
  export declare class UpdateContactRequest extends RequestPatch<UpdateContactPathParameters, undefined, UpdateContactRequestBody, UpdateContactResponseBody> {
6533
6614
  routeSegments?: RequestRouteSegment[];
6534
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
+ }
6535
6631
  export declare class GetFileRequest extends RequestPost<GetFilePathParameters, undefined, undefined, GetFileResponseBody> {
6536
6632
  routeSegments?: RequestRouteSegment[];
6537
6633
  }
@@ -7026,6 +7122,17 @@ export declare class SdkAccountEngagePricePlanResources extends Resources {
7026
7122
  export declare class SdkAccountQrcodelogosUploadResources extends Resources {
7027
7123
  create(requestBody: UploadQrCodeLogoByAccountRequestBody, options?: any): Promise<UploadQrCodeLogoByAccountResponseBody>;
7028
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
+ }
7029
7136
  export declare class SdkAccountResource extends Resource {
7030
7137
  urlSafeties(): SdkAccountUrlSafetiesResources;
7031
7138
  apikeys(): SdkAccountApikeysResources;
@@ -7077,6 +7184,8 @@ export declare class SdkAccountResource extends Resource {
7077
7184
  clock(): SdkAccountClockResources;
7078
7185
  engagePricePlan(): SdkAccountEngagePricePlanResources;
7079
7186
  qrcodelogosUpload(): SdkAccountQrcodelogosUploadResources;
7187
+ customDomains(): SdkAccountCustomDomainsResources;
7188
+ customDomain(customDomain: string): SdkAccountCustomDomainResource;
7080
7189
  get(options?: any): Promise<GetAccountResponseBody>;
7081
7190
  update(requestBody: UpdateAccountRequestBody, options?: any): Promise<UpdateAccountResponseBody>;
7082
7191
  }
@@ -7247,42 +7356,8 @@ export declare class SdkContactResource extends Resource {
7247
7356
  get(options?: any): Promise<GetContactResponseBody>;
7248
7357
  update(requestBody: UpdateContactRequestBody, options?: any): Promise<UpdateContactResponseBody>;
7249
7358
  }
7250
- export declare class SdkFileValidateResources extends Resources {
7251
- create(options?: any): Promise<ValidateFileResponseBody>;
7252
- }
7253
- export declare class SdkFileResource extends Resource {
7254
- validate(): SdkFileValidateResources;
7255
- }
7256
- export declare class SdkInvitationUsersResources extends Resources {
7257
- create(options?: any): Promise<CreateUserByInvitationIdResponseBody>;
7258
- }
7259
- export declare class SdkInvitationResource extends Resource {
7260
- users(): SdkInvitationUsersResources;
7261
- delete(options?: any): Promise<DeleteInvitationResponseBody>;
7262
- get(options?: any): Promise<GetInvitationResponseBody>;
7263
- }
7264
- export declare class SdkJobResource extends Resource {
7265
- delete(options?: any): Promise<DeleteJobResponseBody>;
7266
- get(options?: any): Promise<GetJobResponseBody>;
7267
- }
7268
- export declare class SdkPrintJobResource extends Resource {
7269
- delete(options?: any): Promise<DeletePrintJobResponseBody>;
7270
- invoke(options?: any): Promise<InvokePrintJobByJobIdResponseBody>;
7271
- }
7272
- export declare class SdkLocationAssetsResources extends Resources {
7273
- update(requestBody: UpdateAssetsLocationsRequestBody, options?: any): Promise<UpdateAssetsLocationsResponseBody>;
7274
- get(queryStringParameters: GetAssetsByLocationIdQueryStringParameters, options?: any): Promise<GetAssetsByLocationIdResponseBody>;
7275
- }
7276
- export declare class SdkLocationResource extends Resource {
7277
- assets(): SdkLocationAssetsResources;
7278
- delete(queryStringParameters: DeleteLocationQueryStringParameters, options?: any): Promise<DeleteLocationResponseBody>;
7279
- update(requestBody: UpdateLocationRequestBody, options?: any): Promise<UpdateLocationResponseBody>;
7280
- }
7281
- export declare class SdkSupportResources extends Resources {
7282
- create(requestBody: SendSupportEmailRequestBody, options?: any): Promise<any>;
7283
- }
7284
- export declare class SdkPricePlansResources extends Resources {
7285
- get(options?: any): Promise<GetPricePlansResponseBody>;
7359
+ export declare class SdkProjectCustomDomainResource extends Resource {
7360
+ create(options?: any): Promise<AssignDomainToProjectResponseBody>;
7286
7361
  }
7287
7362
  export declare class SdkProjectAssetsResources extends Resources {
7288
7363
  create(requestBody: CreateAssetByProjectIdRequestBody, options?: any): Promise<CreateAssetByProjectIdResponseBody>;
@@ -7385,6 +7460,7 @@ export declare class SdkProjectUsermediasResources extends Resources {
7385
7460
  get(queryStringParameters: GetUserMediasByProjectIdQueryStringParameters, options?: any): Promise<GetUserMediasByProjectIdResponseBody>;
7386
7461
  }
7387
7462
  export declare class SdkProjectResource extends Resource {
7463
+ customDomain(customDomain: string): SdkProjectCustomDomainResource;
7388
7464
  assets(): SdkProjectAssetsResources;
7389
7465
  jobsAssetbatch(): SdkProjectJobsAssetbatchResources;
7390
7466
  presignedurlJobsAssetbatch(): SdkProjectPresignedurlJobsAssetbatchResources;
@@ -7420,6 +7496,43 @@ export declare class SdkProjectResource extends Resource {
7420
7496
  get(options?: any): Promise<GetProjectByProjectIdResponseBody>;
7421
7497
  update(requestBody: UpdateProjectByProjectIdRequestBody, options?: any): Promise<UpdateProjectByProjectIdResponseBody>;
7422
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
+ }
7423
7536
  export declare class SdkQrcodelogoResource extends Resource {
7424
7537
  get(options?: any): Promise<GetQrCodeLogoByQrCodeLogoIdResponseBody>;
7425
7538
  update(requestBody: UpdateQrCodeLogoByQrCodeLogoIdRequestBody, options?: any): Promise<UpdateQrCodeLogoByQrCodeLogoIdResponseBody>;
@@ -7570,6 +7683,7 @@ export declare class SdkResources extends Resources {
7570
7683
  billingUpgradePlan(accountId: string): SdkBillingUpgradePlanResource;
7571
7684
  careAccounts(): SdkCareAccountsResources;
7572
7685
  contact(contactId: string): SdkContactResource;
7686
+ project(projectId: string): SdkProjectResource;
7573
7687
  file(fileId: string): SdkFileResource;
7574
7688
  invitation(invitationId: string): SdkInvitationResource;
7575
7689
  job(jobId: string): SdkJobResource;
@@ -7577,7 +7691,6 @@ export declare class SdkResources extends Resources {
7577
7691
  location(locationId: string): SdkLocationResource;
7578
7692
  support(): SdkSupportResources;
7579
7693
  pricePlans(): SdkPricePlansResources;
7580
- project(projectId: string): SdkProjectResource;
7581
7694
  qrcodelogo(qrCodeLogoId: string): SdkQrcodelogoResource;
7582
7695
  qrCode(qrCodeId: string): SdkQrCodeResource;
7583
7696
  scan(scanId: string): SdkScanResource;