@openscreen/internal-sdk 1.8.0 → 1.8.2

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.0",
3
+ "version": "1.8.2",
4
4
  "description": "Openscreen Software Development Kit (SDK)",
5
5
  "keywords": [
6
6
  "qr",
package/typings/sdk.d.ts CHANGED
@@ -189,7 +189,8 @@ export declare enum JobType {
189
189
  CONTACT_EXPORT = "CONTACT_EXPORT",
190
190
  TEMPLATED_PRINT = "TEMPLATED_PRINT",
191
191
  CLONE_MICROSITE = "CLONE_MICROSITE",
192
- QRCODE_SCANS_EXPORT = "QRCODE_SCANS_EXPORT"
192
+ QRCODE_SCANS_EXPORT = "QRCODE_SCANS_EXPORT",
193
+ PROJECT_EXPORT = "PROJECT_EXPORT"
193
194
  }
194
195
  export declare enum Label {
195
196
  NONE = "NONE",
@@ -207,6 +208,11 @@ export declare enum OpenscreenEmails {
207
208
  SALES_EMAIL = "SALES_EMAIL",
208
209
  SUPPORT_EMAIL = "SUPPORT_EMAIL"
209
210
  }
211
+ export declare enum PluginStatus {
212
+ ACTIVE = "ACTIVE",
213
+ INACTIVE = "INACTIVE",
214
+ SUSPENDED = "SUSPENDED"
215
+ }
210
216
  export declare enum PricePlanName {
211
217
  FREE = "free",
212
218
  PAYASYOUGO = "payAsYouGo",
@@ -627,6 +633,14 @@ export interface AccountPhoneContact {
627
633
  modified?: string | Date | number | null;
628
634
  phone: string;
629
635
  }
636
+ export interface AccountPlugin {
637
+ accountId: string;
638
+ appAccountId?: string | null;
639
+ created?: string | Date | number | null;
640
+ isEnabled?: boolean;
641
+ modified?: string | Date | number | null;
642
+ pluginId: string;
643
+ }
630
644
  export interface AccountPublishedApp {
631
645
  appId: string;
632
646
  created?: string | Date | number | null;
@@ -1713,6 +1727,7 @@ export interface Job {
1713
1727
  accountId: string;
1714
1728
  appAccountId?: string | null;
1715
1729
  callbackUrl?: string | null;
1730
+ childJobIds?: Array<any>;
1716
1731
  created?: string | Date | number | null;
1717
1732
  errorMessage?: NestedKeyValueObject | null;
1718
1733
  expires?: string | Date | number | null;
@@ -2194,6 +2209,36 @@ export interface PhoneSession {
2194
2209
  smsId: string;
2195
2210
  twilioPhone: string;
2196
2211
  }
2212
+ export interface Plugin {
2213
+ appId: string;
2214
+ created?: string | Date | number | null;
2215
+ icon: string;
2216
+ installCount: number;
2217
+ modified?: string | Date | number | null;
2218
+ name: string;
2219
+ pluginId: string;
2220
+ status?: PluginStatus;
2221
+ version?: number;
2222
+ }
2223
+ export interface PluginByModified {
2224
+ _GLOBAL: string;
2225
+ _prefix?: string;
2226
+ appId: string;
2227
+ created?: string | Date | number | null;
2228
+ modified?: string | Date | number | null;
2229
+ pluginId: string;
2230
+ timestamp: string | Date | number;
2231
+ }
2232
+ export interface PluginByName {
2233
+ _GLOBAL: string;
2234
+ _prefix?: string;
2235
+ appId: string;
2236
+ created?: string | Date | number | null;
2237
+ modified?: string | Date | number | null;
2238
+ name: string;
2239
+ pluginId: string;
2240
+ timestamp: string | Date | number;
2241
+ }
2197
2242
  export interface PricePlan {
2198
2243
  annualPrice: number;
2199
2244
  assets: number;
@@ -2667,6 +2712,14 @@ export interface RequestSessionAction {
2667
2712
  timestamp?: string | Date | number | null;
2668
2713
  willUpdateSession?: boolean;
2669
2714
  }
2715
+ export interface ResponseAccountPlugin {
2716
+ accountId: string;
2717
+ appAccountId?: string | null;
2718
+ icon: string;
2719
+ isEnabled?: boolean;
2720
+ name: string;
2721
+ pluginId: string;
2722
+ }
2670
2723
  export interface ResponseAsset {
2671
2724
  appAccountId?: string | null;
2672
2725
  appId?: string | null;
@@ -3425,6 +3478,10 @@ export interface DeleteUserByAccountIdPathParameters {
3425
3478
  accountId: string;
3426
3479
  userId: string;
3427
3480
  }
3481
+ export interface EnablePluginByAccountIdPathParameters {
3482
+ accountId: string;
3483
+ pluginId: string;
3484
+ }
3428
3485
  export interface GetAccountPathParameters {
3429
3486
  accountId: string;
3430
3487
  }
@@ -3710,6 +3767,14 @@ export interface GetMostScannedAssetsByAccountIdQueryStringParameters {
3710
3767
  export interface GetMostScannedAssetsByAccountIdResponseBody {
3711
3768
  mostScannedAssets: Array<any>;
3712
3769
  }
3770
+ export interface GetPluginsByAccountIdPathParameters {
3771
+ accountId: string;
3772
+ }
3773
+ export interface GetPluginsByAccountIdResponseBody {
3774
+ accountId: string;
3775
+ numberOfPlugins: number;
3776
+ plugins: ResponseAccountPlugin[];
3777
+ }
3713
3778
  export interface GetPricePlanByAccountIdPathParameters {
3714
3779
  accountId: string;
3715
3780
  }
@@ -5227,6 +5292,18 @@ export interface GetAdvancedScanReportByProjectIdResponseBody {
5227
5292
  scansTotal: number;
5228
5293
  staticQRCodesTotal: number;
5229
5294
  }
5295
+ export interface GetAllExportsByProjectIdPathParameters {
5296
+ projectId: string;
5297
+ }
5298
+ export interface GetAllExportsByProjectIdRequestBody {
5299
+ email?: string | null;
5300
+ format?: string;
5301
+ from?: string | Date | number | null;
5302
+ to?: string | Date | number | null;
5303
+ }
5304
+ export interface GetAllExportsByProjectIdResponseBody {
5305
+ job: Job;
5306
+ }
5230
5307
  export interface GetAssetExportByProjectIdPathParameters {
5231
5308
  projectId: string;
5232
5309
  }
@@ -6135,6 +6212,9 @@ export declare class DeleteContactsByAccountIdRequest extends RequestDelete<Dele
6135
6212
  export declare class DeleteUserByAccountIdRequest extends RequestDelete<DeleteUserByAccountIdPathParameters, undefined, undefined> {
6136
6213
  routeSegments?: RequestRouteSegment[];
6137
6214
  }
6215
+ export declare class EnablePluginByAccountIdRequest extends RequestPatch<EnablePluginByAccountIdPathParameters, undefined, undefined, undefined> {
6216
+ routeSegments?: RequestRouteSegment[];
6217
+ }
6138
6218
  export declare class GetAccountRequest extends RequestGet<GetAccountPathParameters, undefined, GetAccountResponseBody> {
6139
6219
  routeSegments?: RequestRouteSegment[];
6140
6220
  }
@@ -6192,6 +6272,9 @@ export declare class GetLocationsByAccountIdRequest extends RequestGet<GetLocati
6192
6272
  export declare class GetMostScannedAssetsByAccountIdRequest extends RequestGet<GetMostScannedAssetsByAccountIdPathParameters, GetMostScannedAssetsByAccountIdQueryStringParameters, GetMostScannedAssetsByAccountIdResponseBody> {
6193
6273
  routeSegments?: RequestRouteSegment[];
6194
6274
  }
6275
+ export declare class GetPluginsByAccountIdRequest extends RequestGet<GetPluginsByAccountIdPathParameters, undefined, GetPluginsByAccountIdResponseBody> {
6276
+ routeSegments?: RequestRouteSegment[];
6277
+ }
6195
6278
  export declare class GetPricePlanByAccountIdRequest extends RequestGet<GetPricePlanByAccountIdPathParameters, undefined, GetPricePlanByAccountIdResponseBody> {
6196
6279
  routeSegments?: RequestRouteSegment[];
6197
6280
  }
@@ -6546,6 +6629,9 @@ export declare class GetAdvancedContactReportByProjectIdRequest extends RequestG
6546
6629
  export declare class GetAdvancedScanReportByProjectIdRequest extends RequestGet<GetAdvancedScanReportByProjectIdPathParameters, GetAdvancedScanReportByProjectIdQueryStringParameters, GetAdvancedScanReportByProjectIdResponseBody> {
6547
6630
  routeSegments?: RequestRouteSegment[];
6548
6631
  }
6632
+ export declare class GetAllExportsByProjectIdRequest extends RequestPost<GetAllExportsByProjectIdPathParameters, undefined, GetAllExportsByProjectIdRequestBody, GetAllExportsByProjectIdResponseBody> {
6633
+ routeSegments?: RequestRouteSegment[];
6634
+ }
6549
6635
  export declare class GetAssetExportByProjectIdRequest extends RequestPost<GetAssetExportByProjectIdPathParameters, undefined, GetAssetExportByProjectIdRequestBody, GetAssetExportByProjectIdResponseBody> {
6550
6636
  routeSegments?: RequestRouteSegment[];
6551
6637
  }
@@ -6837,6 +6923,9 @@ export declare class SdkAccountUserResource extends Resource {
6837
6923
  get(options?: any): Promise<GetUserByAccountIdResponseBody>;
6838
6924
  update(requestBody: UpdateUserByAccountIdRequestBody, options?: any): Promise<UpdateUserByAccountIdResponseBody>;
6839
6925
  }
6926
+ export declare class SdkAccountPluginResource extends Resource {
6927
+ update(options?: any): Promise<any>;
6928
+ }
6840
6929
  export declare class SdkAccountAdvancedAssetsReportResources extends Resources {
6841
6930
  get(queryStringParameters: GetAdvancedAssetReportByAccountIdQueryStringParameters, options?: any): Promise<GetAdvancedAssetReportByAccountIdResponseBody>;
6842
6931
  }
@@ -6879,6 +6968,9 @@ export declare class SdkAccountJobsResources extends Resources {
6879
6968
  export declare class SdkAccountAssetsMostscannedResources extends Resources {
6880
6969
  get(queryStringParameters: GetMostScannedAssetsByAccountIdQueryStringParameters, options?: any): Promise<GetMostScannedAssetsByAccountIdResponseBody>;
6881
6970
  }
6971
+ export declare class SdkAccountPluginsResources extends Resources {
6972
+ get(options?: any): Promise<GetPluginsByAccountIdResponseBody>;
6973
+ }
6882
6974
  export declare class SdkAccountPricePlanResources extends Resources {
6883
6975
  get(options?: any): Promise<GetPricePlanByAccountIdResponseBody>;
6884
6976
  update(requestBody: UpdatePricePlanByAccountIdRequestBody, options?: any): Promise<UpdatePricePlanByAccountIdResponseBody>;
@@ -6951,6 +7043,7 @@ export declare class SdkAccountResource extends Resource {
6951
7043
  usermediasPresignedurl(): SdkAccountUsermediasPresignedurlResources;
6952
7044
  contactsBatch(): SdkAccountContactsBatchResources;
6953
7045
  user(userId: string): SdkAccountUserResource;
7046
+ plugin(pluginId: string): SdkAccountPluginResource;
6954
7047
  advancedAssetsReport(): SdkAccountAdvancedAssetsReportResources;
6955
7048
  advancedContactsReport(): SdkAccountAdvancedContactsReportResources;
6956
7049
  advancedScansReport(): SdkAccountAdvancedScansReportResources;
@@ -6965,6 +7058,7 @@ export declare class SdkAccountResource extends Resource {
6965
7058
  contacts(): SdkAccountContactsResources;
6966
7059
  jobs(): SdkAccountJobsResources;
6967
7060
  assetsMostscanned(): SdkAccountAssetsMostscannedResources;
7061
+ plugins(): SdkAccountPluginsResources;
6968
7062
  pricePlan(): SdkAccountPricePlanResources;
6969
7063
  printJobs(): SdkAccountPrintJobsResources;
6970
7064
  exportQrCodesScans(): SdkAccountExportQrCodesScansResources;
@@ -7243,6 +7337,9 @@ export declare class SdkProjectAdvancedContactsReportResources extends Resources
7243
7337
  export declare class SdkProjectAdvancedScansReportResources extends Resources {
7244
7338
  get(queryStringParameters: GetAdvancedScanReportByProjectIdQueryStringParameters, options?: any): Promise<GetAdvancedScanReportByProjectIdResponseBody>;
7245
7339
  }
7340
+ export declare class SdkProjectExportResources extends Resources {
7341
+ create(requestBody: GetAllExportsByProjectIdRequestBody, options?: any): Promise<GetAllExportsByProjectIdResponseBody>;
7342
+ }
7246
7343
  export declare class SdkProjectAssetsExportResources extends Resources {
7247
7344
  create(requestBody: GetAssetExportByProjectIdRequestBody, options?: any): Promise<GetAssetExportByProjectIdResponseBody>;
7248
7345
  }
@@ -7302,6 +7399,7 @@ export declare class SdkProjectResource extends Resource {
7302
7399
  advancedAssetsReport(): SdkProjectAdvancedAssetsReportResources;
7303
7400
  advancedContactsReport(): SdkProjectAdvancedContactsReportResources;
7304
7401
  advancedScansReport(): SdkProjectAdvancedScansReportResources;
7402
+ export(): SdkProjectExportResources;
7305
7403
  assetsExport(): SdkProjectAssetsExportResources;
7306
7404
  basicAssetsReport(): SdkProjectBasicAssetsReportResources;
7307
7405
  basicContactsReport(): SdkProjectBasicContactsReportResources;