@openscreen/internal-sdk 1.9.6 → 1.9.8

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.9.6",
3
+ "version": "1.9.8",
4
4
  "description": "Openscreen Software Development Kit (SDK)",
5
5
  "keywords": [
6
6
  "qr",
package/typings/sdk.d.ts CHANGED
@@ -213,7 +213,8 @@ export declare enum JobType {
213
213
  WEB_SESSION_EXPORT = "WEB_SESSION_EXPORT",
214
214
  USER_DB_ENTITIES_GENENERATION = "USER_DB_ENTITIES_GENENERATION",
215
215
  USER_DB_ENTITIES_EXPORT = "USER_DB_ENTITIES_EXPORT",
216
- UPDATE_MICROSITE_QR_CODE_CUSTOM_DOMAIN = "UPDATE_MICROSITE_QR_CODE_CUSTOM_DOMAIN"
216
+ UPDATE_MICROSITE_QR_CODE_CUSTOM_DOMAIN = "UPDATE_MICROSITE_QR_CODE_CUSTOM_DOMAIN",
217
+ UPDATE_MICROSITE_CDN_CUSTOM_DOMAIN = "UPDATE_MICROSITE_CDN_CUSTOM_DOMAIN"
217
218
  }
218
219
  export declare enum Label {
219
220
  NONE = "NONE",
@@ -231,6 +232,15 @@ export declare enum OpenscreenEmails {
231
232
  SALES_EMAIL = "SALES_EMAIL",
232
233
  SUPPORT_EMAIL = "SUPPORT_EMAIL"
233
234
  }
235
+ export declare enum Permission {
236
+ PLUGIN_CONFIGURATION = "PLUGIN_CONFIGURATION",
237
+ INDIVIDUAL_ACCOUNT_SETTINGS = "INDIVIDUAL_ACCOUNT_SETTINGS",
238
+ WORKFLOW_BUILDER = "WORKFLOW_BUILDER",
239
+ QR_CODE_AND_PRINT_STUDIO = "QR_CODE_AND_PRINT_STUDIO",
240
+ REPORTING_AND_ANALYTICS = "REPORTING_AND_ANALYTICS",
241
+ USER_MANAGEMENT = "USER_MANAGEMENT",
242
+ BILLING = "BILLING"
243
+ }
234
244
  export declare enum PluginNameTypes {
235
245
  ADMIN_PLUGIN = "ADMIN_PLUGIN",
236
246
  REHRIG_VISION = "REHRIG_VISION",
@@ -771,6 +781,7 @@ export interface AccountUser {
771
781
  modified?: string | Date | number | null;
772
782
  userId: string;
773
783
  userRole: AccountUserRole;
784
+ userRoleIds?: Array<any>;
774
785
  }
775
786
  export interface ApiKey {
776
787
  apiKeyId: string;
@@ -1979,6 +1990,10 @@ export interface MostScannedAssetResponse {
1979
1990
  totalScansCount?: number | null;
1980
1991
  weeklyScansCount?: number | null;
1981
1992
  }
1993
+ export interface MultipartUploadPart {
1994
+ ETag?: string | null;
1995
+ PartNumber?: number;
1996
+ }
1982
1997
  export interface NestedAsset {
1983
1998
  category?: string | null;
1984
1999
  customAttributes?: NestedKeyValueObject | null;
@@ -2867,6 +2882,7 @@ export interface ReservedMappedQrLocatorKey {
2867
2882
  _prefix?: string;
2868
2883
  created?: string | Date | number | null;
2869
2884
  customDomain: string;
2885
+ isSingle?: boolean;
2870
2886
  isStart: boolean;
2871
2887
  locatorKeyNumber: number;
2872
2888
  modified?: string | Date | number | null;
@@ -3387,6 +3403,15 @@ export interface UserMediaByTypeTimestamp {
3387
3403
  scanId?: string | null;
3388
3404
  timestamp: string | Date | number;
3389
3405
  }
3406
+ export interface UserRole {
3407
+ _GLOBAL: string;
3408
+ created?: string | Date | number | null;
3409
+ isApiKey?: boolean;
3410
+ modified?: string | Date | number | null;
3411
+ name: string;
3412
+ permissions?: Permission;
3413
+ roleId: string;
3414
+ }
3390
3415
  export interface UserSession {
3391
3416
  created?: string | Date | number | null;
3392
3417
  email: string;
@@ -3681,6 +3706,24 @@ export interface CreateTicketByAccountIdRequestBody {
3681
3706
  message: string;
3682
3707
  subject?: string;
3683
3708
  }
3709
+ export interface CreateUserMediaMultipartPresignedUrlByAccountIdPathParameters {
3710
+ accountId: string;
3711
+ }
3712
+ export interface CreateUserMediaMultipartPresignedUrlByAccountIdRequestBody {
3713
+ assetId?: string | null;
3714
+ category?: string | null;
3715
+ fileType: UserMediaFileTypes;
3716
+ name?: string | null;
3717
+ parts: number;
3718
+ projectId?: string | null;
3719
+ scanId?: string | null;
3720
+ subFolder?: string | null;
3721
+ }
3722
+ export interface CreateUserMediaMultipartPresignedUrlByAccountIdResponseBody {
3723
+ presignedUrls: Array<any>;
3724
+ uploadId: string;
3725
+ userMedia: UserMedia;
3726
+ }
3684
3727
  export interface CreateUserMediaPresignedUrlByAccountIdPathParameters {
3685
3728
  accountId: string;
3686
3729
  }
@@ -4319,6 +4362,14 @@ export interface GetUsersByAccountIdResponseBody {
4319
4362
  owners: ResponseBodyUser[];
4320
4363
  users: ResponseBodyUser[];
4321
4364
  }
4365
+ export interface GetUsersRolesByAccountIdPathParameters {
4366
+ accountId: string;
4367
+ userId: string;
4368
+ }
4369
+ export interface GetUsersRolesByAccountIdResponseBody {
4370
+ permissions: Permission;
4371
+ userRoles: UserRole[];
4372
+ }
4322
4373
  export interface GetWebSessionsTimelineByAccountIdPathParameters {
4323
4374
  accountId: string;
4324
4375
  }
@@ -4462,6 +4513,16 @@ export interface UpdateUserByAccountIdRequestBody {
4462
4513
  export interface UpdateUserByAccountIdResponseBody {
4463
4514
  accountUser: AccountUser;
4464
4515
  }
4516
+ export interface UpdateUsersRolesByAccountIdPathParameters {
4517
+ accountId: string;
4518
+ userId: string;
4519
+ }
4520
+ export interface UpdateUsersRolesByAccountIdRequestBody {
4521
+ userRoleIds: Array<any>;
4522
+ }
4523
+ export interface UpdateUsersRolesByAccountIdResponseBody {
4524
+ accountUser: AccountUser;
4525
+ }
4465
4526
  export interface UploadQrCodeLogoByAccountPathParameters {
4466
4527
  accountId: string;
4467
4528
  }
@@ -5484,6 +5545,18 @@ export interface AssignDomainToProjectPathParameters {
5484
5545
  export interface AssignDomainToProjectResponseBody {
5485
5546
  projectDomain: ProjectDomain;
5486
5547
  }
5548
+ export interface CreateAssetBatchValidationJobByProjectIdPathParameters {
5549
+ projectId: string;
5550
+ }
5551
+ export interface CreateAssetBatchValidationJobByProjectIdRequestBody {
5552
+ callbackUrl?: string | null;
5553
+ fileId?: string | null;
5554
+ trackFileId?: string | null;
5555
+ trackJobId?: string | null;
5556
+ }
5557
+ export interface CreateAssetBatchValidationJobByProjectIdResponseBody {
5558
+ job: Job;
5559
+ }
5487
5560
  export interface CreateAssetByProjectIdPathParameters {
5488
5561
  projectId: string;
5489
5562
  }
@@ -6377,6 +6450,17 @@ export interface UpdateQrCodeStylingTemplateByStylingTemplateIdResponseBody {
6377
6450
  qrCodeStylingTemplate: QrCodeStylingTemplate;
6378
6451
  stylingTemplateId: string;
6379
6452
  }
6453
+ export interface CompleteUserMediaMultipartUploadPathParameters {
6454
+ mediaId: string;
6455
+ }
6456
+ export interface CompleteUserMediaMultipartUploadRequestBody {
6457
+ key: string;
6458
+ parts: MultipartUploadPart[];
6459
+ uploadId: string;
6460
+ }
6461
+ export interface CompleteUserMediaMultipartUploadResponseBody {
6462
+ userMedia: UserMedia;
6463
+ }
6380
6464
  export interface GetMediaPathParameters {
6381
6465
  mediaId: string;
6382
6466
  }
@@ -6443,6 +6527,15 @@ export interface UnlinkMediasRequestBody {
6443
6527
  }
6444
6528
  export interface UnlinkMediasResponseBody {
6445
6529
  }
6530
+ export interface UpdateMediaPathParameters {
6531
+ mediaId: string;
6532
+ }
6533
+ export interface UpdateMediaRequestBody {
6534
+ category?: string | null;
6535
+ }
6536
+ export interface UpdateMediaResponseBody {
6537
+ userMedia: UserMedia;
6538
+ }
6446
6539
  export interface CreateAccountByUserIdPathParameters {
6447
6540
  userId: string;
6448
6541
  }
@@ -6753,6 +6846,9 @@ export declare class CreateSamlConfigurationRequest extends RequestPost<CreateSa
6753
6846
  export declare class CreateTicketByAccountIdRequest extends RequestPost<CreateTicketByAccountIdPathParameters, undefined, CreateTicketByAccountIdRequestBody, undefined> {
6754
6847
  routeSegments?: RequestRouteSegment[];
6755
6848
  }
6849
+ export declare class CreateUserMediaMultipartPresignedUrlByAccountIdRequest extends RequestPost<CreateUserMediaMultipartPresignedUrlByAccountIdPathParameters, undefined, CreateUserMediaMultipartPresignedUrlByAccountIdRequestBody, CreateUserMediaMultipartPresignedUrlByAccountIdResponseBody> {
6850
+ routeSegments?: RequestRouteSegment[];
6851
+ }
6756
6852
  export declare class CreateUserMediaPresignedUrlByAccountIdRequest extends RequestPost<CreateUserMediaPresignedUrlByAccountIdPathParameters, undefined, CreateUserMediaPresignedUrlByAccountIdRequestBody, CreateUserMediaPresignedUrlByAccountIdResponseBody> {
6757
6853
  routeSegments?: RequestRouteSegment[];
6758
6854
  }
@@ -6897,6 +6993,9 @@ export declare class GetUserMediasByAccountIdRequest extends RequestGet<GetUserM
6897
6993
  export declare class GetUsersByAccountIdRequest extends RequestGet<GetUsersByAccountIdPathParameters, GetUsersByAccountIdQueryStringParameters, GetUsersByAccountIdResponseBody> {
6898
6994
  routeSegments?: RequestRouteSegment[];
6899
6995
  }
6996
+ export declare class GetUsersRolesByAccountIdRequest extends RequestGet<GetUsersRolesByAccountIdPathParameters, undefined, GetUsersRolesByAccountIdResponseBody> {
6997
+ routeSegments?: RequestRouteSegment[];
6998
+ }
6900
6999
  export declare class GetWebSessionsTimelineByAccountIdRequest extends RequestGet<GetWebSessionsTimelineByAccountIdPathParameters, GetWebSessionsTimelineByAccountIdQueryStringParameters, GetWebSessionsTimelineByAccountIdResponseBody> {
6901
7000
  routeSegments?: RequestRouteSegment[];
6902
7001
  }
@@ -6933,6 +7032,9 @@ export declare class UpdateRehrigAccountPluginRequest extends RequestPatch<Updat
6933
7032
  export declare class UpdateUserByAccountIdRequest extends RequestPatch<UpdateUserByAccountIdPathParameters, undefined, UpdateUserByAccountIdRequestBody, UpdateUserByAccountIdResponseBody> {
6934
7033
  routeSegments?: RequestRouteSegment[];
6935
7034
  }
7035
+ export declare class UpdateUsersRolesByAccountIdRequest extends RequestPatch<UpdateUsersRolesByAccountIdPathParameters, undefined, UpdateUsersRolesByAccountIdRequestBody, UpdateUsersRolesByAccountIdResponseBody> {
7036
+ routeSegments?: RequestRouteSegment[];
7037
+ }
6936
7038
  export declare class UploadQrCodeLogoByAccountRequest extends RequestPost<UploadQrCodeLogoByAccountPathParameters, undefined, UploadQrCodeLogoByAccountRequestBody, UploadQrCodeLogoByAccountResponseBody> {
6937
7039
  routeSegments?: RequestRouteSegment[];
6938
7040
  }
@@ -7191,6 +7293,9 @@ export declare class GetPricePlansRequest extends RequestGet<undefined, undefine
7191
7293
  export declare class AssignDomainToProjectRequest extends RequestPost<AssignDomainToProjectPathParameters, undefined, undefined, AssignDomainToProjectResponseBody> {
7192
7294
  routeSegments?: RequestRouteSegment[];
7193
7295
  }
7296
+ export declare class CreateAssetBatchValidationJobByProjectIdRequest extends RequestPost<CreateAssetBatchValidationJobByProjectIdPathParameters, undefined, CreateAssetBatchValidationJobByProjectIdRequestBody, CreateAssetBatchValidationJobByProjectIdResponseBody> {
7297
+ routeSegments?: RequestRouteSegment[];
7298
+ }
7194
7299
  export declare class CreateAssetByProjectIdRequest extends RequestPost<CreateAssetByProjectIdPathParameters, undefined, CreateAssetByProjectIdRequestBody, CreateAssetByProjectIdResponseBody> {
7195
7300
  routeSegments?: RequestRouteSegment[];
7196
7301
  }
@@ -7398,6 +7503,9 @@ export declare class UpdatePrintStickerTemplateRequest extends RequestPatch<Upda
7398
7503
  export declare class UpdateQrCodeStylingTemplateByStylingTemplateIdRequest extends RequestPatch<UpdateQrCodeStylingTemplateByStylingTemplateIdPathParameters, undefined, UpdateQrCodeStylingTemplateByStylingTemplateIdRequestBody, UpdateQrCodeStylingTemplateByStylingTemplateIdResponseBody> {
7399
7504
  routeSegments?: RequestRouteSegment[];
7400
7505
  }
7506
+ export declare class CompleteUserMediaMultipartUploadRequest extends RequestPost<CompleteUserMediaMultipartUploadPathParameters, undefined, CompleteUserMediaMultipartUploadRequestBody, CompleteUserMediaMultipartUploadResponseBody> {
7507
+ routeSegments?: RequestRouteSegment[];
7508
+ }
7401
7509
  export declare class GetMediaRequest extends RequestGet<GetMediaPathParameters, undefined, GetMediaResponseBody> {
7402
7510
  routeSegments?: RequestRouteSegment[];
7403
7511
  }
@@ -7425,6 +7533,9 @@ export declare class UnlinkMediaToScanRequest extends RequestDelete<UnlinkMediaT
7425
7533
  export declare class UnlinkMediasRequest extends RequestPost<UnlinkMediasPathParameters, undefined, UnlinkMediasRequestBody, UnlinkMediasResponseBody> {
7426
7534
  routeSegments?: RequestRouteSegment[];
7427
7535
  }
7536
+ export declare class UpdateMediaRequest extends RequestPatch<UpdateMediaPathParameters, undefined, UpdateMediaRequestBody, UpdateMediaResponseBody> {
7537
+ routeSegments?: RequestRouteSegment[];
7538
+ }
7428
7539
  export declare class CreateAccountByUserIdRequest extends RequestPost<CreateAccountByUserIdPathParameters, undefined, CreateAccountByUserIdRequestBody, CreateAccountByUserIdResponseBody> {
7429
7540
  routeSegments?: RequestRouteSegment[];
7430
7541
  }
@@ -7509,8 +7620,13 @@ export declare class SignOnRequest extends RequestGet<SignOnPathParameters, unde
7509
7620
  export declare class SdkAccountUserConfirmResources extends Resources {
7510
7621
  get(options?: any): Promise<GetAccountAccessDataResponseBody>;
7511
7622
  }
7623
+ export declare class SdkAccountUserRolesResources extends Resources {
7624
+ get(options?: any): Promise<GetUsersRolesByAccountIdResponseBody>;
7625
+ update(requestBody: UpdateUsersRolesByAccountIdRequestBody, options?: any): Promise<UpdateUsersRolesByAccountIdResponseBody>;
7626
+ }
7512
7627
  export declare class SdkAccountUserResource extends Resource {
7513
7628
  confirm(): SdkAccountUserConfirmResources;
7629
+ roles(): SdkAccountUserRolesResources;
7514
7630
  delete(options?: any): Promise<any>;
7515
7631
  get(options?: any): Promise<GetUserByAccountIdResponseBody>;
7516
7632
  update(requestBody: UpdateUserByAccountIdRequestBody, options?: any): Promise<UpdateUserByAccountIdResponseBody>;
@@ -7577,6 +7693,9 @@ export declare class SdkAccountSSOConfigurationResources extends Resources {
7577
7693
  export declare class SdkAccountZendeskTicketResources extends Resources {
7578
7694
  create(requestBody: CreateTicketByAccountIdRequestBody, options?: any): Promise<any>;
7579
7695
  }
7696
+ export declare class SdkAccountUsermediasPresignedurlmultipartResources extends Resources {
7697
+ create(requestBody: CreateUserMediaMultipartPresignedUrlByAccountIdRequestBody, options?: any): Promise<CreateUserMediaMultipartPresignedUrlByAccountIdResponseBody>;
7698
+ }
7580
7699
  export declare class SdkAccountUsermediasPresignedurlResources extends Resources {
7581
7700
  create(requestBody: CreateUserMediaPresignedUrlByAccountIdRequestBody, options?: any): Promise<CreateUserMediaPresignedUrlByAccountIdResponseBody>;
7582
7701
  }
@@ -7735,6 +7854,7 @@ export declare class SdkAccountResource extends Resource {
7735
7854
  customattributes(): SdkAccountCustomattributesResources;
7736
7855
  SSOConfiguration(): SdkAccountSSOConfigurationResources;
7737
7856
  zendeskTicket(): SdkAccountZendeskTicketResources;
7857
+ usermediasPresignedurlmultipart(): SdkAccountUsermediasPresignedurlmultipartResources;
7738
7858
  usermediasPresignedurl(): SdkAccountUsermediasPresignedurlResources;
7739
7859
  websessionsExport(): SdkAccountWebsessionsExportResources;
7740
7860
  contactsBatch(): SdkAccountContactsBatchResources;
@@ -8016,6 +8136,9 @@ export declare class SdkPricePlansResources extends Resources {
8016
8136
  export declare class SdkProjectCustomDomainResource extends Resource {
8017
8137
  create(options?: any): Promise<AssignDomainToProjectResponseBody>;
8018
8138
  }
8139
+ export declare class SdkProjectJobsAssetbatchvalidationResources extends Resources {
8140
+ create(requestBody: CreateAssetBatchValidationJobByProjectIdRequestBody, options?: any): Promise<CreateAssetBatchValidationJobByProjectIdResponseBody>;
8141
+ }
8019
8142
  export declare class SdkProjectAssetsResources extends Resources {
8020
8143
  create(requestBody: CreateAssetByProjectIdRequestBody, options?: any): Promise<CreateAssetByProjectIdResponseBody>;
8021
8144
  get(queryStringParameters: GetAssetsByProjectIdQueryStringParameters, options?: any): Promise<GetAssetsByProjectIdResponseBody>;
@@ -8128,6 +8251,7 @@ export declare class SdkProjectWebsessionsTimelineResources extends Resources {
8128
8251
  }
8129
8252
  export declare class SdkProjectResource extends Resource {
8130
8253
  customDomain(customDomain: string): SdkProjectCustomDomainResource;
8254
+ jobsAssetbatchvalidation(): SdkProjectJobsAssetbatchvalidationResources;
8131
8255
  assets(): SdkProjectAssetsResources;
8132
8256
  jobsAssetbatch(): SdkProjectJobsAssetbatchResources;
8133
8257
  presignedurlJobsAssetbatch(): SdkProjectPresignedurlJobsAssetbatchResources;
@@ -8222,6 +8346,9 @@ export declare class SdkStylingtemplateResource extends Resource {
8222
8346
  get(options?: any): Promise<GetQrCodeStylingTemplateByStylingTemplateIdResponseBody>;
8223
8347
  update(requestBody: UpdateQrCodeStylingTemplateByStylingTemplateIdRequestBody, options?: any): Promise<UpdateQrCodeStylingTemplateByStylingTemplateIdResponseBody>;
8224
8348
  }
8349
+ export declare class SdkUsermediaMultipartResources extends Resources {
8350
+ create(requestBody: CompleteUserMediaMultipartUploadRequestBody, options?: any): Promise<CompleteUserMediaMultipartUploadResponseBody>;
8351
+ }
8225
8352
  export declare class SdkUsermediaAssetResource extends Resource {
8226
8353
  link(requestBody: UnlinkMediasRequestBody, options?: any): Promise<UnlinkMediasResponseBody>;
8227
8354
  unlink(options?: any): Promise<UnlinkMediaToAssetResponseBody>;
@@ -8235,10 +8362,12 @@ export declare class SdkUsermediaScanResource extends Resource {
8235
8362
  unlink(options?: any): Promise<UnlinkMediaToScanResponseBody>;
8236
8363
  }
8237
8364
  export declare class SdkUsermediaResource extends Resource {
8365
+ multipart(): SdkUsermediaMultipartResources;
8238
8366
  asset(assetId: string): SdkUsermediaAssetResource;
8239
8367
  project(projectId: string): SdkUsermediaProjectResource;
8240
8368
  scan(scanId: string): SdkUsermediaScanResource;
8241
8369
  get(options?: any): Promise<GetMediaResponseBody>;
8370
+ update(requestBody: UpdateMediaRequestBody, options?: any): Promise<UpdateMediaResponseBody>;
8242
8371
  }
8243
8372
  export declare class SdkUserAccountsResources extends Resources {
8244
8373
  create(requestBody: CreateAccountByUserIdRequestBody, options?: any): Promise<CreateAccountByUserIdResponseBody>;