@flipdish/authorization 0.2.6 → 0.2.7-rc.1763978242
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/.openapi-generator/FILES +1 -0
- package/api.ts +1160 -0
- package/configuration.ts +1 -1
- package/dist/api.d.ts +1018 -0
- package/dist/api.js +1014 -1
- package/dist/configuration.js +1 -1
- package/package.json +1 -1
package/api.ts
CHANGED
|
@@ -552,6 +552,897 @@ export interface ErrorResponse {
|
|
|
552
552
|
*/
|
|
553
553
|
'message': string;
|
|
554
554
|
}
|
|
555
|
+
/**
|
|
556
|
+
* Request to get authorized brands for a principal or the authenticated user based on the headers. Either principal or headers must be provided, but not both. If both are provided, the principal will be used.
|
|
557
|
+
* @export
|
|
558
|
+
* @interface GetAuthorizedBrandsRequest
|
|
559
|
+
*/
|
|
560
|
+
export interface GetAuthorizedBrandsRequest {
|
|
561
|
+
/**
|
|
562
|
+
*
|
|
563
|
+
* @type {GetAuthorizedOrgsRequestPrincipal}
|
|
564
|
+
* @memberof GetAuthorizedBrandsRequest
|
|
565
|
+
*/
|
|
566
|
+
'principal'?: GetAuthorizedOrgsRequestPrincipal;
|
|
567
|
+
/**
|
|
568
|
+
* Incoming request headers to be used for authentication
|
|
569
|
+
* @type {{ [key: string]: any; }}
|
|
570
|
+
* @memberof GetAuthorizedBrandsRequest
|
|
571
|
+
*/
|
|
572
|
+
'headers'?: { [key: string]: any; };
|
|
573
|
+
/**
|
|
574
|
+
* The action to check authorisation for
|
|
575
|
+
* @type {string}
|
|
576
|
+
* @memberof GetAuthorizedBrandsRequest
|
|
577
|
+
*/
|
|
578
|
+
'action': GetAuthorizedBrandsRequestActionEnum;
|
|
579
|
+
}
|
|
580
|
+
|
|
581
|
+
export const GetAuthorizedBrandsRequestActionEnum = {
|
|
582
|
+
AnyAuditLogs: 'AnyAuditLogs',
|
|
583
|
+
ViewApp: 'ViewApp',
|
|
584
|
+
CreateApp: 'CreateApp',
|
|
585
|
+
UpdateApp: 'UpdateApp',
|
|
586
|
+
ViewAppName: 'ViewAppName',
|
|
587
|
+
EditAppAssets: 'EditAppAssets',
|
|
588
|
+
EditAppFeatures: 'EditAppFeatures',
|
|
589
|
+
ViewTeammates: 'ViewTeammates',
|
|
590
|
+
EditTeammates: 'EditTeammates',
|
|
591
|
+
CreateTeammateOwner: 'CreateTeammateOwner',
|
|
592
|
+
CreateTeammateManagedOwner: 'CreateTeammateManagedOwner',
|
|
593
|
+
CreateTeammateStoreOwner: 'CreateTeammateStoreOwner',
|
|
594
|
+
CreateTeammateStoreManager: 'CreateTeammateStoreManager',
|
|
595
|
+
CreateTeammateStoreStaff: 'CreateTeammateStoreStaff',
|
|
596
|
+
CreateTeammateStoreReadAccess: 'CreateTeammateStoreReadAccess',
|
|
597
|
+
CreateTeammateFinanceManager: 'CreateTeammateFinanceManager',
|
|
598
|
+
CreateTeammateIntegrator: 'CreateTeammateIntegrator',
|
|
599
|
+
CreateTeammateOnboarding: 'CreateTeammateOnboarding',
|
|
600
|
+
CreateTeammatePropertyManager: 'CreateTeammatePropertyManager',
|
|
601
|
+
CreateTeammatePropertyOwner: 'CreateTeammatePropertyOwner',
|
|
602
|
+
ViewApmConfigurations: 'ViewApmConfigurations',
|
|
603
|
+
EditApmConfigurations: 'EditApmConfigurations',
|
|
604
|
+
ViewCampaignsConfigurations: 'ViewCampaignsConfigurations',
|
|
605
|
+
CreateCampaignsConfigurations: 'CreateCampaignsConfigurations',
|
|
606
|
+
UpdateCampaignsConfigurations: 'UpdateCampaignsConfigurations',
|
|
607
|
+
DeleteCampaignsConfigurations: 'DeleteCampaignsConfigurations',
|
|
608
|
+
StampLoyaltyCardAgainstCampaignsConfigurations: 'StampLoyaltyCardAgainstCampaignsConfigurations',
|
|
609
|
+
ViewDevelopersSettings: 'ViewDevelopersSettings',
|
|
610
|
+
EditDevelopersSettings: 'EditDevelopersSettings',
|
|
611
|
+
ViewOrders: 'ViewOrders',
|
|
612
|
+
UpdateOrdersAccept: 'UpdateOrdersAccept',
|
|
613
|
+
UpdateOrdersReject: 'UpdateOrdersReject',
|
|
614
|
+
UpdateOrdersRefund: 'UpdateOrdersRefund',
|
|
615
|
+
UpdateOrdersDispatch: 'UpdateOrdersDispatch',
|
|
616
|
+
ViewStores: 'ViewStores',
|
|
617
|
+
CreateStores: 'CreateStores',
|
|
618
|
+
EditStores: 'EditStores',
|
|
619
|
+
ViewStoresOpeningHours: 'ViewStoresOpeningHours',
|
|
620
|
+
UpdateStoresOpenForCollectionOrDelivery: 'UpdateStoresOpenForCollectionOrDelivery',
|
|
621
|
+
UpdateStoresOpeningHours: 'UpdateStoresOpeningHours',
|
|
622
|
+
ViewStoresOpeningHoursOverride: 'ViewStoresOpeningHoursOverride',
|
|
623
|
+
EditStoresOpeningHoursOverride: 'EditStoresOpeningHoursOverride',
|
|
624
|
+
EditStoresOpeningHoursOverrideTemporary: 'EditStoresOpeningHoursOverrideTemporary',
|
|
625
|
+
UpdateStoresName: 'UpdateStoresName',
|
|
626
|
+
EditStoreKioskSettings: 'EditStoreKioskSettings',
|
|
627
|
+
EditStoreOrderCapacity: 'EditStoreOrderCapacity',
|
|
628
|
+
EditStoreNotifications: 'EditStoreNotifications',
|
|
629
|
+
ArchiveStores: 'ArchiveStores',
|
|
630
|
+
PublishStores: 'PublishStores',
|
|
631
|
+
UpdatePrinterTerminalsAssign: 'UpdatePrinterTerminalsAssign',
|
|
632
|
+
UpdatePrinterTerminalsToggle: 'UpdatePrinterTerminalsToggle',
|
|
633
|
+
ViewStoreGroups: 'ViewStoreGroups',
|
|
634
|
+
CreateStoreGroups: 'CreateStoreGroups',
|
|
635
|
+
UpdateStoreGroups: 'UpdateStoreGroups',
|
|
636
|
+
DeleteStoreGroups: 'DeleteStoreGroups',
|
|
637
|
+
ViewDeliveryZones: 'ViewDeliveryZones',
|
|
638
|
+
CreateDeliveryZones: 'CreateDeliveryZones',
|
|
639
|
+
UpdateDeliveryZones: 'UpdateDeliveryZones',
|
|
640
|
+
DeleteDeliveryZones: 'DeleteDeliveryZones',
|
|
641
|
+
ViewMenu: 'ViewMenu',
|
|
642
|
+
CreateMenu: 'CreateMenu',
|
|
643
|
+
UpdateMenu: 'UpdateMenu',
|
|
644
|
+
DeleteMenu: 'DeleteMenu',
|
|
645
|
+
UpdateMenuLock: 'UpdateMenuLock',
|
|
646
|
+
UpdateMenuItemsHideTemporarily: 'UpdateMenuItemsHideTemporarily',
|
|
647
|
+
EditMenuImage: 'EditMenuImage',
|
|
648
|
+
ViewVouchers: 'ViewVouchers',
|
|
649
|
+
EditVouchers: 'EditVouchers',
|
|
650
|
+
ViewWebsiteContent: 'ViewWebsiteContent',
|
|
651
|
+
EditWebsiteContent: 'EditWebsiteContent',
|
|
652
|
+
ViewWebsiteDnsVerified: 'ViewWebsiteDnsVerified',
|
|
653
|
+
ViewWebsiteCertificateCreated: 'ViewWebsiteCertificateCreated',
|
|
654
|
+
ViewWebsiteCertificateRenewed: 'ViewWebsiteCertificateRenewed',
|
|
655
|
+
ViewBankAccounts: 'ViewBankAccounts',
|
|
656
|
+
CreateBankAccounts: 'CreateBankAccounts',
|
|
657
|
+
UpdateBankAccounts: 'UpdateBankAccounts',
|
|
658
|
+
UpdateBankAccountsAssign: 'UpdateBankAccountsAssign',
|
|
659
|
+
ViewAssignedBankAccount: 'ViewAssignedBankAccount',
|
|
660
|
+
VerifyBankAccounts: 'VerifyBankAccounts',
|
|
661
|
+
ViewServiceChargeConfigurations: 'ViewServiceChargeConfigurations',
|
|
662
|
+
EditServiceChargeConfigurations: 'EditServiceChargeConfigurations',
|
|
663
|
+
EditStoreDeliveryZoneFees: 'EditStoreDeliveryZoneFees',
|
|
664
|
+
EditStoreDeliveryFeesLimited: 'EditStoreDeliveryFeesLimited',
|
|
665
|
+
ViewHydraConfig: 'ViewHydraConfig',
|
|
666
|
+
UpdateHydraConfigManage: 'UpdateHydraConfigManage',
|
|
667
|
+
InitiateBluetoothPairingMode: 'InitiateBluetoothPairingMode',
|
|
668
|
+
DeleteTerminal: 'DeleteTerminal',
|
|
669
|
+
ViewKioskTelemetry: 'ViewKioskTelemetry',
|
|
670
|
+
ViewCustomers: 'ViewCustomers',
|
|
671
|
+
EditCustomers: 'EditCustomers',
|
|
672
|
+
CreateCustomers: 'CreateCustomers',
|
|
673
|
+
CreateCatalogElements: 'CreateCatalogElements',
|
|
674
|
+
UpdateCatalogElements: 'UpdateCatalogElements',
|
|
675
|
+
ViewCatalogElements: 'ViewCatalogElements',
|
|
676
|
+
DeleteCatalogElements: 'DeleteCatalogElements',
|
|
677
|
+
ViewMetafieldDefinitions: 'ViewMetafieldDefinitions',
|
|
678
|
+
CreateMetafieldDefinitions: 'CreateMetafieldDefinitions',
|
|
679
|
+
UpdateMetafieldDefinitions: 'UpdateMetafieldDefinitions',
|
|
680
|
+
DeleteMetafieldDefinitions: 'DeleteMetafieldDefinitions',
|
|
681
|
+
UpdateMetafields: 'UpdateMetafields',
|
|
682
|
+
ViewCatalogMenuChanges: 'ViewCatalogMenuChanges',
|
|
683
|
+
PublishCatalogMenuChanges: 'PublishCatalogMenuChanges',
|
|
684
|
+
ViewAppStatistics: 'ViewAppStatistics',
|
|
685
|
+
ViewApmStatistics: 'ViewApmStatistics',
|
|
686
|
+
ViewCampaignsStatistics: 'ViewCampaignsStatistics',
|
|
687
|
+
ViewCustomerStatistics: 'ViewCustomerStatistics',
|
|
688
|
+
ViewLiveStatistics: 'ViewLiveStatistics',
|
|
689
|
+
ViewOrderStatistics: 'ViewOrderStatistics',
|
|
690
|
+
ViewSalesStatistics: 'ViewSalesStatistics',
|
|
691
|
+
ViewSalesEndOfDayStatistics: 'ViewSalesEndOfDayStatistics',
|
|
692
|
+
ViewVouchersStatistics: 'ViewVouchersStatistics',
|
|
693
|
+
DownloadCustomerCsvExport: 'DownloadCustomerCsvExport',
|
|
694
|
+
ViewApmAuditLogs: 'ViewApmAuditLogs',
|
|
695
|
+
ViewStoreAuditLogs: 'ViewStoreAuditLogs',
|
|
696
|
+
ViewMenuAuditLogs: 'ViewMenuAuditLogs',
|
|
697
|
+
ViewBankAccountAuditLogs: 'ViewBankAccountAuditLogs',
|
|
698
|
+
ViewFeeConfigurationsAuditLogs: 'ViewFeeConfigurationsAuditLogs',
|
|
699
|
+
ViewOrdersAuditLogs: 'ViewOrdersAuditLogs',
|
|
700
|
+
ViewVouchersAuditLogs: 'ViewVouchersAuditLogs',
|
|
701
|
+
ViewUserEventsAuditLogs: 'ViewUserEventsAuditLogs',
|
|
702
|
+
ViewCampaignsAuditLogs: 'ViewCampaignsAuditLogs',
|
|
703
|
+
ViewTeammatesAuditLogs: 'ViewTeammatesAuditLogs',
|
|
704
|
+
ViewAppAuditLogs: 'ViewAppAuditLogs',
|
|
705
|
+
ViewCustomerAuditLogs: 'ViewCustomerAuditLogs',
|
|
706
|
+
ViewPrinterAuditLogs: 'ViewPrinterAuditLogs',
|
|
707
|
+
ViewHydraAuditLogs: 'ViewHydraAuditLogs',
|
|
708
|
+
ViewPushNotificationAuditLogs: 'ViewPushNotificationAuditLogs',
|
|
709
|
+
ViewStripeCustomConnectedAccountAuditLogs: 'ViewStripeCustomConnectedAccountAuditLogs',
|
|
710
|
+
ViewKioskBluetoothDeviceAuditLogs: 'ViewKioskBluetoothDeviceAuditLogs',
|
|
711
|
+
ViewExternalAuditLogs: 'ViewExternalAuditLogs',
|
|
712
|
+
CreateExternalAuditLogEvents: 'CreateExternalAuditLogEvents',
|
|
713
|
+
ViewCatalogAuditLogs: 'ViewCatalogAuditLogs',
|
|
714
|
+
ViewOrderFulfillmentAuditLogs: 'ViewOrderFulfillmentAuditLogs',
|
|
715
|
+
ViewChannelAuditLogs: 'ViewChannelAuditLogs',
|
|
716
|
+
ViewAppStoreAuditLogs: 'ViewAppStoreAuditLogs',
|
|
717
|
+
SendPushNotificationToCustomer: 'SendPushNotificationToCustomer',
|
|
718
|
+
InviteDriverToApp: 'InviteDriverToApp',
|
|
719
|
+
GetDriverForApp: 'GetDriverForApp',
|
|
720
|
+
RemoveDriverFromApp: 'RemoveDriverFromApp',
|
|
721
|
+
AssignDriverToOrder: 'AssignDriverToOrder',
|
|
722
|
+
UnassignDriverFromOrder: 'UnassignDriverFromOrder',
|
|
723
|
+
UpdateOrdersDeliveryTrackingStatus: 'UpdateOrdersDeliveryTrackingStatus',
|
|
724
|
+
UpdateOrderFulfillmentStatus: 'UpdateOrderFulfillmentStatus',
|
|
725
|
+
ViewFulfillmentStatesConfiguration: 'ViewFulfillmentStatesConfiguration',
|
|
726
|
+
CreateFulfillmentStatesConfiguration: 'CreateFulfillmentStatesConfiguration',
|
|
727
|
+
UpdateFulfillmentStatesConfiguration: 'UpdateFulfillmentStatesConfiguration',
|
|
728
|
+
DeleteFulfillmentStatesConfiguration: 'DeleteFulfillmentStatesConfiguration',
|
|
729
|
+
ViewPayouts: 'ViewPayouts',
|
|
730
|
+
ViewChannels: 'ViewChannels',
|
|
731
|
+
ViewOnboarding: 'ViewOnboarding',
|
|
732
|
+
UpdateOnboarding: 'UpdateOnboarding',
|
|
733
|
+
ViewClientDevices: 'ViewClientDevices',
|
|
734
|
+
UpdateClientDevices: 'UpdateClientDevices',
|
|
735
|
+
EnrollClientDevices: 'EnrollClientDevices',
|
|
736
|
+
AssignClientDevices: 'AssignClientDevices',
|
|
737
|
+
ViewClientAuditLogs: 'ViewClientAuditLogs',
|
|
738
|
+
CreateAppStoreAppConfiguration: 'CreateAppStoreAppConfiguration',
|
|
739
|
+
ViewAppStoreAppConfiguration: 'ViewAppStoreAppConfiguration',
|
|
740
|
+
UpdateAppStoreAppConfiguration: 'UpdateAppStoreAppConfiguration',
|
|
741
|
+
DeleteAppStoreAppConfiguration: 'DeleteAppStoreAppConfiguration',
|
|
742
|
+
UpdateAppStoreAppConfigurationSettings: 'UpdateAppStoreAppConfigurationSettings',
|
|
743
|
+
CreateAppStoreSubscription: 'CreateAppStoreSubscription',
|
|
744
|
+
UpdateAppStoreSubscription: 'UpdateAppStoreSubscription',
|
|
745
|
+
DeleteAppStoreSubscription: 'DeleteAppStoreSubscription',
|
|
746
|
+
ViewSalesChannels: 'ViewSalesChannels',
|
|
747
|
+
EditSalesChannels: 'EditSalesChannels',
|
|
748
|
+
CreateSalesChannel: 'CreateSalesChannel',
|
|
749
|
+
ArchiveSalesChannel: 'ArchiveSalesChannel',
|
|
750
|
+
UnarchiveSalesChannel: 'UnarchiveSalesChannel',
|
|
751
|
+
PublishSalesChannel: 'PublishSalesChannel',
|
|
752
|
+
UnpublishSalesChannel: 'UnpublishSalesChannel',
|
|
753
|
+
CloneSalesChannel: 'CloneSalesChannel',
|
|
754
|
+
ViewPayGreenWhiteLabelConfiguration: 'ViewPayGreenWhiteLabelConfiguration',
|
|
755
|
+
CreatePayGreenWhiteLabelConfiguration: 'CreatePayGreenWhiteLabelConfiguration',
|
|
756
|
+
UpdatePayGreenWhiteLabelConfiguration: 'UpdatePayGreenWhiteLabelConfiguration',
|
|
757
|
+
UpdatePayGreenStoreConfiguration: 'UpdatePayGreenStoreConfiguration',
|
|
758
|
+
ViewSubscriptions: 'ViewSubscriptions',
|
|
759
|
+
ViewInvoices: 'ViewInvoices',
|
|
760
|
+
EditAccountsBills: 'EditAccountsBills',
|
|
761
|
+
ViewAccountsBills: 'ViewAccountsBills',
|
|
762
|
+
EditAccountsCategories: 'EditAccountsCategories',
|
|
763
|
+
ViewAccountsCategories: 'ViewAccountsCategories',
|
|
764
|
+
EditAccountsCreditAccounts: 'EditAccountsCreditAccounts',
|
|
765
|
+
ViewAccountsCreditAccounts: 'ViewAccountsCreditAccounts',
|
|
766
|
+
EditAccountsCreditBooks: 'EditAccountsCreditBooks',
|
|
767
|
+
ViewAccountsCreditBooks: 'ViewAccountsCreditBooks',
|
|
768
|
+
EditAccountsExpenses: 'EditAccountsExpenses',
|
|
769
|
+
ViewAccountsExpenses: 'ViewAccountsExpenses',
|
|
770
|
+
EditAccountsTransactionAccounts: 'EditAccountsTransactionAccounts',
|
|
771
|
+
ViewAccountsTransactionAccounts: 'ViewAccountsTransactionAccounts',
|
|
772
|
+
EditDocumentExplorer: 'EditDocumentExplorer',
|
|
773
|
+
ViewDocumentExplorer: 'ViewDocumentExplorer',
|
|
774
|
+
ViewInventoryReports: 'ViewInventoryReports',
|
|
775
|
+
EditInventoryPurchaseOrders: 'EditInventoryPurchaseOrders',
|
|
776
|
+
ViewInventoryPurchaseOrders: 'ViewInventoryPurchaseOrders',
|
|
777
|
+
EditInventoryStockItems: 'EditInventoryStockItems',
|
|
778
|
+
ViewInventoryStockItems: 'ViewInventoryStockItems',
|
|
779
|
+
EditInventorySupplier: 'EditInventorySupplier',
|
|
780
|
+
ViewInventorySupplier: 'ViewInventorySupplier',
|
|
781
|
+
EditInventoryTrackingProfiles: 'EditInventoryTrackingProfiles',
|
|
782
|
+
ViewInventoryTrackingProfiles: 'ViewInventoryTrackingProfiles',
|
|
783
|
+
ViewPayrollReports: 'ViewPayrollReports',
|
|
784
|
+
EditPayrollHoliday: 'EditPayrollHoliday',
|
|
785
|
+
ViewPayrollHoliday: 'ViewPayrollHoliday',
|
|
786
|
+
EditPayrollRota: 'EditPayrollRota',
|
|
787
|
+
ViewPayrollRota: 'ViewPayrollRota',
|
|
788
|
+
EditPayrollStaff: 'EditPayrollStaff',
|
|
789
|
+
ViewPayrollStaff: 'ViewPayrollStaff',
|
|
790
|
+
ViewSalesReports: 'ViewSalesReports',
|
|
791
|
+
ViewCostReports: 'ViewCostReports',
|
|
792
|
+
ViewMenuReports: 'ViewMenuReports',
|
|
793
|
+
ViewBrand: 'ViewBrand',
|
|
794
|
+
EditBrand: 'EditBrand',
|
|
795
|
+
CreateBrand: 'CreateBrand',
|
|
796
|
+
TransferBrand: 'TransferBrand',
|
|
797
|
+
ViewProperty: 'ViewProperty',
|
|
798
|
+
EditProperty: 'EditProperty',
|
|
799
|
+
CreateProperty: 'CreateProperty',
|
|
800
|
+
ArchiveProperty: 'ArchiveProperty',
|
|
801
|
+
ViewEntityFeatureFlags: 'ViewEntityFeatureFlags',
|
|
802
|
+
EditEntityFeatureFlags: 'EditEntityFeatureFlags',
|
|
803
|
+
CreateOrg: 'CreateOrg',
|
|
804
|
+
EditOrg: 'EditOrg',
|
|
805
|
+
ViewOrg: 'ViewOrg',
|
|
806
|
+
ViewWebhooks: 'ViewWebhooks',
|
|
807
|
+
EditWebhooks: 'EditWebhooks'
|
|
808
|
+
} as const;
|
|
809
|
+
|
|
810
|
+
export type GetAuthorizedBrandsRequestActionEnum = typeof GetAuthorizedBrandsRequestActionEnum[keyof typeof GetAuthorizedBrandsRequestActionEnum];
|
|
811
|
+
|
|
812
|
+
/**
|
|
813
|
+
* Response containing the authorized brands
|
|
814
|
+
* @export
|
|
815
|
+
* @interface GetAuthorizedBrandsResponse
|
|
816
|
+
*/
|
|
817
|
+
export interface GetAuthorizedBrandsResponse {
|
|
818
|
+
/**
|
|
819
|
+
*
|
|
820
|
+
* @type {AuthorizationBatchResponseRequest}
|
|
821
|
+
* @memberof GetAuthorizedBrandsResponse
|
|
822
|
+
*/
|
|
823
|
+
'request': AuthorizationBatchResponseRequest;
|
|
824
|
+
/**
|
|
825
|
+
* Array of allowed resources
|
|
826
|
+
* @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
|
|
827
|
+
* @memberof GetAuthorizedBrandsResponse
|
|
828
|
+
*/
|
|
829
|
+
'allowedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
|
|
830
|
+
/**
|
|
831
|
+
* Array of denied resources
|
|
832
|
+
* @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
|
|
833
|
+
* @memberof GetAuthorizedBrandsResponse
|
|
834
|
+
*/
|
|
835
|
+
'deniedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
|
|
836
|
+
}
|
|
837
|
+
/**
|
|
838
|
+
* Request to get authorized orgs for a principal or the authenticated user based on the headers. Either principal or headers must be provided, but not both. If both are provided, the principal will be used.
|
|
839
|
+
* @export
|
|
840
|
+
* @interface GetAuthorizedOrgsRequest
|
|
841
|
+
*/
|
|
842
|
+
export interface GetAuthorizedOrgsRequest {
|
|
843
|
+
/**
|
|
844
|
+
*
|
|
845
|
+
* @type {GetAuthorizedOrgsRequestPrincipal}
|
|
846
|
+
* @memberof GetAuthorizedOrgsRequest
|
|
847
|
+
*/
|
|
848
|
+
'principal'?: GetAuthorizedOrgsRequestPrincipal;
|
|
849
|
+
/**
|
|
850
|
+
* Incoming request headers to be used for authentication
|
|
851
|
+
* @type {{ [key: string]: any; }}
|
|
852
|
+
* @memberof GetAuthorizedOrgsRequest
|
|
853
|
+
*/
|
|
854
|
+
'headers'?: { [key: string]: any; };
|
|
855
|
+
/**
|
|
856
|
+
* The action to check authorisation for
|
|
857
|
+
* @type {string}
|
|
858
|
+
* @memberof GetAuthorizedOrgsRequest
|
|
859
|
+
*/
|
|
860
|
+
'action': GetAuthorizedOrgsRequestActionEnum;
|
|
861
|
+
}
|
|
862
|
+
|
|
863
|
+
export const GetAuthorizedOrgsRequestActionEnum = {
|
|
864
|
+
AnyAuditLogs: 'AnyAuditLogs',
|
|
865
|
+
ViewApp: 'ViewApp',
|
|
866
|
+
CreateApp: 'CreateApp',
|
|
867
|
+
UpdateApp: 'UpdateApp',
|
|
868
|
+
ViewAppName: 'ViewAppName',
|
|
869
|
+
EditAppAssets: 'EditAppAssets',
|
|
870
|
+
EditAppFeatures: 'EditAppFeatures',
|
|
871
|
+
ViewTeammates: 'ViewTeammates',
|
|
872
|
+
EditTeammates: 'EditTeammates',
|
|
873
|
+
CreateTeammateOwner: 'CreateTeammateOwner',
|
|
874
|
+
CreateTeammateManagedOwner: 'CreateTeammateManagedOwner',
|
|
875
|
+
CreateTeammateStoreOwner: 'CreateTeammateStoreOwner',
|
|
876
|
+
CreateTeammateStoreManager: 'CreateTeammateStoreManager',
|
|
877
|
+
CreateTeammateStoreStaff: 'CreateTeammateStoreStaff',
|
|
878
|
+
CreateTeammateStoreReadAccess: 'CreateTeammateStoreReadAccess',
|
|
879
|
+
CreateTeammateFinanceManager: 'CreateTeammateFinanceManager',
|
|
880
|
+
CreateTeammateIntegrator: 'CreateTeammateIntegrator',
|
|
881
|
+
CreateTeammateOnboarding: 'CreateTeammateOnboarding',
|
|
882
|
+
CreateTeammatePropertyManager: 'CreateTeammatePropertyManager',
|
|
883
|
+
CreateTeammatePropertyOwner: 'CreateTeammatePropertyOwner',
|
|
884
|
+
ViewApmConfigurations: 'ViewApmConfigurations',
|
|
885
|
+
EditApmConfigurations: 'EditApmConfigurations',
|
|
886
|
+
ViewCampaignsConfigurations: 'ViewCampaignsConfigurations',
|
|
887
|
+
CreateCampaignsConfigurations: 'CreateCampaignsConfigurations',
|
|
888
|
+
UpdateCampaignsConfigurations: 'UpdateCampaignsConfigurations',
|
|
889
|
+
DeleteCampaignsConfigurations: 'DeleteCampaignsConfigurations',
|
|
890
|
+
StampLoyaltyCardAgainstCampaignsConfigurations: 'StampLoyaltyCardAgainstCampaignsConfigurations',
|
|
891
|
+
ViewDevelopersSettings: 'ViewDevelopersSettings',
|
|
892
|
+
EditDevelopersSettings: 'EditDevelopersSettings',
|
|
893
|
+
ViewOrders: 'ViewOrders',
|
|
894
|
+
UpdateOrdersAccept: 'UpdateOrdersAccept',
|
|
895
|
+
UpdateOrdersReject: 'UpdateOrdersReject',
|
|
896
|
+
UpdateOrdersRefund: 'UpdateOrdersRefund',
|
|
897
|
+
UpdateOrdersDispatch: 'UpdateOrdersDispatch',
|
|
898
|
+
ViewStores: 'ViewStores',
|
|
899
|
+
CreateStores: 'CreateStores',
|
|
900
|
+
EditStores: 'EditStores',
|
|
901
|
+
ViewStoresOpeningHours: 'ViewStoresOpeningHours',
|
|
902
|
+
UpdateStoresOpenForCollectionOrDelivery: 'UpdateStoresOpenForCollectionOrDelivery',
|
|
903
|
+
UpdateStoresOpeningHours: 'UpdateStoresOpeningHours',
|
|
904
|
+
ViewStoresOpeningHoursOverride: 'ViewStoresOpeningHoursOverride',
|
|
905
|
+
EditStoresOpeningHoursOverride: 'EditStoresOpeningHoursOverride',
|
|
906
|
+
EditStoresOpeningHoursOverrideTemporary: 'EditStoresOpeningHoursOverrideTemporary',
|
|
907
|
+
UpdateStoresName: 'UpdateStoresName',
|
|
908
|
+
EditStoreKioskSettings: 'EditStoreKioskSettings',
|
|
909
|
+
EditStoreOrderCapacity: 'EditStoreOrderCapacity',
|
|
910
|
+
EditStoreNotifications: 'EditStoreNotifications',
|
|
911
|
+
ArchiveStores: 'ArchiveStores',
|
|
912
|
+
PublishStores: 'PublishStores',
|
|
913
|
+
UpdatePrinterTerminalsAssign: 'UpdatePrinterTerminalsAssign',
|
|
914
|
+
UpdatePrinterTerminalsToggle: 'UpdatePrinterTerminalsToggle',
|
|
915
|
+
ViewStoreGroups: 'ViewStoreGroups',
|
|
916
|
+
CreateStoreGroups: 'CreateStoreGroups',
|
|
917
|
+
UpdateStoreGroups: 'UpdateStoreGroups',
|
|
918
|
+
DeleteStoreGroups: 'DeleteStoreGroups',
|
|
919
|
+
ViewDeliveryZones: 'ViewDeliveryZones',
|
|
920
|
+
CreateDeliveryZones: 'CreateDeliveryZones',
|
|
921
|
+
UpdateDeliveryZones: 'UpdateDeliveryZones',
|
|
922
|
+
DeleteDeliveryZones: 'DeleteDeliveryZones',
|
|
923
|
+
ViewMenu: 'ViewMenu',
|
|
924
|
+
CreateMenu: 'CreateMenu',
|
|
925
|
+
UpdateMenu: 'UpdateMenu',
|
|
926
|
+
DeleteMenu: 'DeleteMenu',
|
|
927
|
+
UpdateMenuLock: 'UpdateMenuLock',
|
|
928
|
+
UpdateMenuItemsHideTemporarily: 'UpdateMenuItemsHideTemporarily',
|
|
929
|
+
EditMenuImage: 'EditMenuImage',
|
|
930
|
+
ViewVouchers: 'ViewVouchers',
|
|
931
|
+
EditVouchers: 'EditVouchers',
|
|
932
|
+
ViewWebsiteContent: 'ViewWebsiteContent',
|
|
933
|
+
EditWebsiteContent: 'EditWebsiteContent',
|
|
934
|
+
ViewWebsiteDnsVerified: 'ViewWebsiteDnsVerified',
|
|
935
|
+
ViewWebsiteCertificateCreated: 'ViewWebsiteCertificateCreated',
|
|
936
|
+
ViewWebsiteCertificateRenewed: 'ViewWebsiteCertificateRenewed',
|
|
937
|
+
ViewBankAccounts: 'ViewBankAccounts',
|
|
938
|
+
CreateBankAccounts: 'CreateBankAccounts',
|
|
939
|
+
UpdateBankAccounts: 'UpdateBankAccounts',
|
|
940
|
+
UpdateBankAccountsAssign: 'UpdateBankAccountsAssign',
|
|
941
|
+
ViewAssignedBankAccount: 'ViewAssignedBankAccount',
|
|
942
|
+
VerifyBankAccounts: 'VerifyBankAccounts',
|
|
943
|
+
ViewServiceChargeConfigurations: 'ViewServiceChargeConfigurations',
|
|
944
|
+
EditServiceChargeConfigurations: 'EditServiceChargeConfigurations',
|
|
945
|
+
EditStoreDeliveryZoneFees: 'EditStoreDeliveryZoneFees',
|
|
946
|
+
EditStoreDeliveryFeesLimited: 'EditStoreDeliveryFeesLimited',
|
|
947
|
+
ViewHydraConfig: 'ViewHydraConfig',
|
|
948
|
+
UpdateHydraConfigManage: 'UpdateHydraConfigManage',
|
|
949
|
+
InitiateBluetoothPairingMode: 'InitiateBluetoothPairingMode',
|
|
950
|
+
DeleteTerminal: 'DeleteTerminal',
|
|
951
|
+
ViewKioskTelemetry: 'ViewKioskTelemetry',
|
|
952
|
+
ViewCustomers: 'ViewCustomers',
|
|
953
|
+
EditCustomers: 'EditCustomers',
|
|
954
|
+
CreateCustomers: 'CreateCustomers',
|
|
955
|
+
CreateCatalogElements: 'CreateCatalogElements',
|
|
956
|
+
UpdateCatalogElements: 'UpdateCatalogElements',
|
|
957
|
+
ViewCatalogElements: 'ViewCatalogElements',
|
|
958
|
+
DeleteCatalogElements: 'DeleteCatalogElements',
|
|
959
|
+
ViewMetafieldDefinitions: 'ViewMetafieldDefinitions',
|
|
960
|
+
CreateMetafieldDefinitions: 'CreateMetafieldDefinitions',
|
|
961
|
+
UpdateMetafieldDefinitions: 'UpdateMetafieldDefinitions',
|
|
962
|
+
DeleteMetafieldDefinitions: 'DeleteMetafieldDefinitions',
|
|
963
|
+
UpdateMetafields: 'UpdateMetafields',
|
|
964
|
+
ViewCatalogMenuChanges: 'ViewCatalogMenuChanges',
|
|
965
|
+
PublishCatalogMenuChanges: 'PublishCatalogMenuChanges',
|
|
966
|
+
ViewAppStatistics: 'ViewAppStatistics',
|
|
967
|
+
ViewApmStatistics: 'ViewApmStatistics',
|
|
968
|
+
ViewCampaignsStatistics: 'ViewCampaignsStatistics',
|
|
969
|
+
ViewCustomerStatistics: 'ViewCustomerStatistics',
|
|
970
|
+
ViewLiveStatistics: 'ViewLiveStatistics',
|
|
971
|
+
ViewOrderStatistics: 'ViewOrderStatistics',
|
|
972
|
+
ViewSalesStatistics: 'ViewSalesStatistics',
|
|
973
|
+
ViewSalesEndOfDayStatistics: 'ViewSalesEndOfDayStatistics',
|
|
974
|
+
ViewVouchersStatistics: 'ViewVouchersStatistics',
|
|
975
|
+
DownloadCustomerCsvExport: 'DownloadCustomerCsvExport',
|
|
976
|
+
ViewApmAuditLogs: 'ViewApmAuditLogs',
|
|
977
|
+
ViewStoreAuditLogs: 'ViewStoreAuditLogs',
|
|
978
|
+
ViewMenuAuditLogs: 'ViewMenuAuditLogs',
|
|
979
|
+
ViewBankAccountAuditLogs: 'ViewBankAccountAuditLogs',
|
|
980
|
+
ViewFeeConfigurationsAuditLogs: 'ViewFeeConfigurationsAuditLogs',
|
|
981
|
+
ViewOrdersAuditLogs: 'ViewOrdersAuditLogs',
|
|
982
|
+
ViewVouchersAuditLogs: 'ViewVouchersAuditLogs',
|
|
983
|
+
ViewUserEventsAuditLogs: 'ViewUserEventsAuditLogs',
|
|
984
|
+
ViewCampaignsAuditLogs: 'ViewCampaignsAuditLogs',
|
|
985
|
+
ViewTeammatesAuditLogs: 'ViewTeammatesAuditLogs',
|
|
986
|
+
ViewAppAuditLogs: 'ViewAppAuditLogs',
|
|
987
|
+
ViewCustomerAuditLogs: 'ViewCustomerAuditLogs',
|
|
988
|
+
ViewPrinterAuditLogs: 'ViewPrinterAuditLogs',
|
|
989
|
+
ViewHydraAuditLogs: 'ViewHydraAuditLogs',
|
|
990
|
+
ViewPushNotificationAuditLogs: 'ViewPushNotificationAuditLogs',
|
|
991
|
+
ViewStripeCustomConnectedAccountAuditLogs: 'ViewStripeCustomConnectedAccountAuditLogs',
|
|
992
|
+
ViewKioskBluetoothDeviceAuditLogs: 'ViewKioskBluetoothDeviceAuditLogs',
|
|
993
|
+
ViewExternalAuditLogs: 'ViewExternalAuditLogs',
|
|
994
|
+
CreateExternalAuditLogEvents: 'CreateExternalAuditLogEvents',
|
|
995
|
+
ViewCatalogAuditLogs: 'ViewCatalogAuditLogs',
|
|
996
|
+
ViewOrderFulfillmentAuditLogs: 'ViewOrderFulfillmentAuditLogs',
|
|
997
|
+
ViewChannelAuditLogs: 'ViewChannelAuditLogs',
|
|
998
|
+
ViewAppStoreAuditLogs: 'ViewAppStoreAuditLogs',
|
|
999
|
+
SendPushNotificationToCustomer: 'SendPushNotificationToCustomer',
|
|
1000
|
+
InviteDriverToApp: 'InviteDriverToApp',
|
|
1001
|
+
GetDriverForApp: 'GetDriverForApp',
|
|
1002
|
+
RemoveDriverFromApp: 'RemoveDriverFromApp',
|
|
1003
|
+
AssignDriverToOrder: 'AssignDriverToOrder',
|
|
1004
|
+
UnassignDriverFromOrder: 'UnassignDriverFromOrder',
|
|
1005
|
+
UpdateOrdersDeliveryTrackingStatus: 'UpdateOrdersDeliveryTrackingStatus',
|
|
1006
|
+
UpdateOrderFulfillmentStatus: 'UpdateOrderFulfillmentStatus',
|
|
1007
|
+
ViewFulfillmentStatesConfiguration: 'ViewFulfillmentStatesConfiguration',
|
|
1008
|
+
CreateFulfillmentStatesConfiguration: 'CreateFulfillmentStatesConfiguration',
|
|
1009
|
+
UpdateFulfillmentStatesConfiguration: 'UpdateFulfillmentStatesConfiguration',
|
|
1010
|
+
DeleteFulfillmentStatesConfiguration: 'DeleteFulfillmentStatesConfiguration',
|
|
1011
|
+
ViewPayouts: 'ViewPayouts',
|
|
1012
|
+
ViewChannels: 'ViewChannels',
|
|
1013
|
+
ViewOnboarding: 'ViewOnboarding',
|
|
1014
|
+
UpdateOnboarding: 'UpdateOnboarding',
|
|
1015
|
+
ViewClientDevices: 'ViewClientDevices',
|
|
1016
|
+
UpdateClientDevices: 'UpdateClientDevices',
|
|
1017
|
+
EnrollClientDevices: 'EnrollClientDevices',
|
|
1018
|
+
AssignClientDevices: 'AssignClientDevices',
|
|
1019
|
+
ViewClientAuditLogs: 'ViewClientAuditLogs',
|
|
1020
|
+
CreateAppStoreAppConfiguration: 'CreateAppStoreAppConfiguration',
|
|
1021
|
+
ViewAppStoreAppConfiguration: 'ViewAppStoreAppConfiguration',
|
|
1022
|
+
UpdateAppStoreAppConfiguration: 'UpdateAppStoreAppConfiguration',
|
|
1023
|
+
DeleteAppStoreAppConfiguration: 'DeleteAppStoreAppConfiguration',
|
|
1024
|
+
UpdateAppStoreAppConfigurationSettings: 'UpdateAppStoreAppConfigurationSettings',
|
|
1025
|
+
CreateAppStoreSubscription: 'CreateAppStoreSubscription',
|
|
1026
|
+
UpdateAppStoreSubscription: 'UpdateAppStoreSubscription',
|
|
1027
|
+
DeleteAppStoreSubscription: 'DeleteAppStoreSubscription',
|
|
1028
|
+
ViewSalesChannels: 'ViewSalesChannels',
|
|
1029
|
+
EditSalesChannels: 'EditSalesChannels',
|
|
1030
|
+
CreateSalesChannel: 'CreateSalesChannel',
|
|
1031
|
+
ArchiveSalesChannel: 'ArchiveSalesChannel',
|
|
1032
|
+
UnarchiveSalesChannel: 'UnarchiveSalesChannel',
|
|
1033
|
+
PublishSalesChannel: 'PublishSalesChannel',
|
|
1034
|
+
UnpublishSalesChannel: 'UnpublishSalesChannel',
|
|
1035
|
+
CloneSalesChannel: 'CloneSalesChannel',
|
|
1036
|
+
ViewPayGreenWhiteLabelConfiguration: 'ViewPayGreenWhiteLabelConfiguration',
|
|
1037
|
+
CreatePayGreenWhiteLabelConfiguration: 'CreatePayGreenWhiteLabelConfiguration',
|
|
1038
|
+
UpdatePayGreenWhiteLabelConfiguration: 'UpdatePayGreenWhiteLabelConfiguration',
|
|
1039
|
+
UpdatePayGreenStoreConfiguration: 'UpdatePayGreenStoreConfiguration',
|
|
1040
|
+
ViewSubscriptions: 'ViewSubscriptions',
|
|
1041
|
+
ViewInvoices: 'ViewInvoices',
|
|
1042
|
+
EditAccountsBills: 'EditAccountsBills',
|
|
1043
|
+
ViewAccountsBills: 'ViewAccountsBills',
|
|
1044
|
+
EditAccountsCategories: 'EditAccountsCategories',
|
|
1045
|
+
ViewAccountsCategories: 'ViewAccountsCategories',
|
|
1046
|
+
EditAccountsCreditAccounts: 'EditAccountsCreditAccounts',
|
|
1047
|
+
ViewAccountsCreditAccounts: 'ViewAccountsCreditAccounts',
|
|
1048
|
+
EditAccountsCreditBooks: 'EditAccountsCreditBooks',
|
|
1049
|
+
ViewAccountsCreditBooks: 'ViewAccountsCreditBooks',
|
|
1050
|
+
EditAccountsExpenses: 'EditAccountsExpenses',
|
|
1051
|
+
ViewAccountsExpenses: 'ViewAccountsExpenses',
|
|
1052
|
+
EditAccountsTransactionAccounts: 'EditAccountsTransactionAccounts',
|
|
1053
|
+
ViewAccountsTransactionAccounts: 'ViewAccountsTransactionAccounts',
|
|
1054
|
+
EditDocumentExplorer: 'EditDocumentExplorer',
|
|
1055
|
+
ViewDocumentExplorer: 'ViewDocumentExplorer',
|
|
1056
|
+
ViewInventoryReports: 'ViewInventoryReports',
|
|
1057
|
+
EditInventoryPurchaseOrders: 'EditInventoryPurchaseOrders',
|
|
1058
|
+
ViewInventoryPurchaseOrders: 'ViewInventoryPurchaseOrders',
|
|
1059
|
+
EditInventoryStockItems: 'EditInventoryStockItems',
|
|
1060
|
+
ViewInventoryStockItems: 'ViewInventoryStockItems',
|
|
1061
|
+
EditInventorySupplier: 'EditInventorySupplier',
|
|
1062
|
+
ViewInventorySupplier: 'ViewInventorySupplier',
|
|
1063
|
+
EditInventoryTrackingProfiles: 'EditInventoryTrackingProfiles',
|
|
1064
|
+
ViewInventoryTrackingProfiles: 'ViewInventoryTrackingProfiles',
|
|
1065
|
+
ViewPayrollReports: 'ViewPayrollReports',
|
|
1066
|
+
EditPayrollHoliday: 'EditPayrollHoliday',
|
|
1067
|
+
ViewPayrollHoliday: 'ViewPayrollHoliday',
|
|
1068
|
+
EditPayrollRota: 'EditPayrollRota',
|
|
1069
|
+
ViewPayrollRota: 'ViewPayrollRota',
|
|
1070
|
+
EditPayrollStaff: 'EditPayrollStaff',
|
|
1071
|
+
ViewPayrollStaff: 'ViewPayrollStaff',
|
|
1072
|
+
ViewSalesReports: 'ViewSalesReports',
|
|
1073
|
+
ViewCostReports: 'ViewCostReports',
|
|
1074
|
+
ViewMenuReports: 'ViewMenuReports',
|
|
1075
|
+
ViewBrand: 'ViewBrand',
|
|
1076
|
+
EditBrand: 'EditBrand',
|
|
1077
|
+
CreateBrand: 'CreateBrand',
|
|
1078
|
+
TransferBrand: 'TransferBrand',
|
|
1079
|
+
ViewProperty: 'ViewProperty',
|
|
1080
|
+
EditProperty: 'EditProperty',
|
|
1081
|
+
CreateProperty: 'CreateProperty',
|
|
1082
|
+
ArchiveProperty: 'ArchiveProperty',
|
|
1083
|
+
ViewEntityFeatureFlags: 'ViewEntityFeatureFlags',
|
|
1084
|
+
EditEntityFeatureFlags: 'EditEntityFeatureFlags',
|
|
1085
|
+
CreateOrg: 'CreateOrg',
|
|
1086
|
+
EditOrg: 'EditOrg',
|
|
1087
|
+
ViewOrg: 'ViewOrg',
|
|
1088
|
+
ViewWebhooks: 'ViewWebhooks',
|
|
1089
|
+
EditWebhooks: 'EditWebhooks'
|
|
1090
|
+
} as const;
|
|
1091
|
+
|
|
1092
|
+
export type GetAuthorizedOrgsRequestActionEnum = typeof GetAuthorizedOrgsRequestActionEnum[keyof typeof GetAuthorizedOrgsRequestActionEnum];
|
|
1093
|
+
|
|
1094
|
+
/**
|
|
1095
|
+
* The principal to get authorized entities for
|
|
1096
|
+
* @export
|
|
1097
|
+
* @interface GetAuthorizedOrgsRequestPrincipal
|
|
1098
|
+
*/
|
|
1099
|
+
export interface GetAuthorizedOrgsRequestPrincipal {
|
|
1100
|
+
/**
|
|
1101
|
+
*
|
|
1102
|
+
* @type {string}
|
|
1103
|
+
* @memberof GetAuthorizedOrgsRequestPrincipal
|
|
1104
|
+
*/
|
|
1105
|
+
'type': GetAuthorizedOrgsRequestPrincipalTypeEnum;
|
|
1106
|
+
/**
|
|
1107
|
+
*
|
|
1108
|
+
* @type {string}
|
|
1109
|
+
* @memberof GetAuthorizedOrgsRequestPrincipal
|
|
1110
|
+
*/
|
|
1111
|
+
'id': string;
|
|
1112
|
+
/**
|
|
1113
|
+
*
|
|
1114
|
+
* @type {string}
|
|
1115
|
+
* @memberof GetAuthorizedOrgsRequestPrincipal
|
|
1116
|
+
*/
|
|
1117
|
+
'name'?: string;
|
|
1118
|
+
/**
|
|
1119
|
+
*
|
|
1120
|
+
* @type {string}
|
|
1121
|
+
* @memberof GetAuthorizedOrgsRequestPrincipal
|
|
1122
|
+
*/
|
|
1123
|
+
'email'?: string;
|
|
1124
|
+
/**
|
|
1125
|
+
*
|
|
1126
|
+
* @type {string}
|
|
1127
|
+
* @memberof GetAuthorizedOrgsRequestPrincipal
|
|
1128
|
+
*/
|
|
1129
|
+
'phone'?: string;
|
|
1130
|
+
}
|
|
1131
|
+
|
|
1132
|
+
export const GetAuthorizedOrgsRequestPrincipalTypeEnum = {
|
|
1133
|
+
User: 'User',
|
|
1134
|
+
Automation: 'Automation'
|
|
1135
|
+
} as const;
|
|
1136
|
+
|
|
1137
|
+
export type GetAuthorizedOrgsRequestPrincipalTypeEnum = typeof GetAuthorizedOrgsRequestPrincipalTypeEnum[keyof typeof GetAuthorizedOrgsRequestPrincipalTypeEnum];
|
|
1138
|
+
|
|
1139
|
+
/**
|
|
1140
|
+
* Response containing the authorized orgs
|
|
1141
|
+
* @export
|
|
1142
|
+
* @interface GetAuthorizedOrgsResponse
|
|
1143
|
+
*/
|
|
1144
|
+
export interface GetAuthorizedOrgsResponse {
|
|
1145
|
+
/**
|
|
1146
|
+
*
|
|
1147
|
+
* @type {AuthorizationBatchResponseRequest}
|
|
1148
|
+
* @memberof GetAuthorizedOrgsResponse
|
|
1149
|
+
*/
|
|
1150
|
+
'request': AuthorizationBatchResponseRequest;
|
|
1151
|
+
/**
|
|
1152
|
+
* Array of allowed resources
|
|
1153
|
+
* @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
|
|
1154
|
+
* @memberof GetAuthorizedOrgsResponse
|
|
1155
|
+
*/
|
|
1156
|
+
'allowedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
|
|
1157
|
+
/**
|
|
1158
|
+
* Array of denied resources
|
|
1159
|
+
* @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
|
|
1160
|
+
* @memberof GetAuthorizedOrgsResponse
|
|
1161
|
+
*/
|
|
1162
|
+
'deniedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
|
|
1163
|
+
}
|
|
1164
|
+
/**
|
|
1165
|
+
* Request to get authorized properties for a principal or the authenticated user based on the headers. Either principal or headers must be provided, but not both. If both are provided, the principal will be used.
|
|
1166
|
+
* @export
|
|
1167
|
+
* @interface GetAuthorizedPropertiesRequest
|
|
1168
|
+
*/
|
|
1169
|
+
export interface GetAuthorizedPropertiesRequest {
|
|
1170
|
+
/**
|
|
1171
|
+
*
|
|
1172
|
+
* @type {GetAuthorizedOrgsRequestPrincipal}
|
|
1173
|
+
* @memberof GetAuthorizedPropertiesRequest
|
|
1174
|
+
*/
|
|
1175
|
+
'principal'?: GetAuthorizedOrgsRequestPrincipal;
|
|
1176
|
+
/**
|
|
1177
|
+
* Incoming request headers to be used for authentication
|
|
1178
|
+
* @type {{ [key: string]: any; }}
|
|
1179
|
+
* @memberof GetAuthorizedPropertiesRequest
|
|
1180
|
+
*/
|
|
1181
|
+
'headers'?: { [key: string]: any; };
|
|
1182
|
+
/**
|
|
1183
|
+
* The action to check authorisation for
|
|
1184
|
+
* @type {string}
|
|
1185
|
+
* @memberof GetAuthorizedPropertiesRequest
|
|
1186
|
+
*/
|
|
1187
|
+
'action': GetAuthorizedPropertiesRequestActionEnum;
|
|
1188
|
+
}
|
|
1189
|
+
|
|
1190
|
+
export const GetAuthorizedPropertiesRequestActionEnum = {
|
|
1191
|
+
AnyAuditLogs: 'AnyAuditLogs',
|
|
1192
|
+
ViewApp: 'ViewApp',
|
|
1193
|
+
CreateApp: 'CreateApp',
|
|
1194
|
+
UpdateApp: 'UpdateApp',
|
|
1195
|
+
ViewAppName: 'ViewAppName',
|
|
1196
|
+
EditAppAssets: 'EditAppAssets',
|
|
1197
|
+
EditAppFeatures: 'EditAppFeatures',
|
|
1198
|
+
ViewTeammates: 'ViewTeammates',
|
|
1199
|
+
EditTeammates: 'EditTeammates',
|
|
1200
|
+
CreateTeammateOwner: 'CreateTeammateOwner',
|
|
1201
|
+
CreateTeammateManagedOwner: 'CreateTeammateManagedOwner',
|
|
1202
|
+
CreateTeammateStoreOwner: 'CreateTeammateStoreOwner',
|
|
1203
|
+
CreateTeammateStoreManager: 'CreateTeammateStoreManager',
|
|
1204
|
+
CreateTeammateStoreStaff: 'CreateTeammateStoreStaff',
|
|
1205
|
+
CreateTeammateStoreReadAccess: 'CreateTeammateStoreReadAccess',
|
|
1206
|
+
CreateTeammateFinanceManager: 'CreateTeammateFinanceManager',
|
|
1207
|
+
CreateTeammateIntegrator: 'CreateTeammateIntegrator',
|
|
1208
|
+
CreateTeammateOnboarding: 'CreateTeammateOnboarding',
|
|
1209
|
+
CreateTeammatePropertyManager: 'CreateTeammatePropertyManager',
|
|
1210
|
+
CreateTeammatePropertyOwner: 'CreateTeammatePropertyOwner',
|
|
1211
|
+
ViewApmConfigurations: 'ViewApmConfigurations',
|
|
1212
|
+
EditApmConfigurations: 'EditApmConfigurations',
|
|
1213
|
+
ViewCampaignsConfigurations: 'ViewCampaignsConfigurations',
|
|
1214
|
+
CreateCampaignsConfigurations: 'CreateCampaignsConfigurations',
|
|
1215
|
+
UpdateCampaignsConfigurations: 'UpdateCampaignsConfigurations',
|
|
1216
|
+
DeleteCampaignsConfigurations: 'DeleteCampaignsConfigurations',
|
|
1217
|
+
StampLoyaltyCardAgainstCampaignsConfigurations: 'StampLoyaltyCardAgainstCampaignsConfigurations',
|
|
1218
|
+
ViewDevelopersSettings: 'ViewDevelopersSettings',
|
|
1219
|
+
EditDevelopersSettings: 'EditDevelopersSettings',
|
|
1220
|
+
ViewOrders: 'ViewOrders',
|
|
1221
|
+
UpdateOrdersAccept: 'UpdateOrdersAccept',
|
|
1222
|
+
UpdateOrdersReject: 'UpdateOrdersReject',
|
|
1223
|
+
UpdateOrdersRefund: 'UpdateOrdersRefund',
|
|
1224
|
+
UpdateOrdersDispatch: 'UpdateOrdersDispatch',
|
|
1225
|
+
ViewStores: 'ViewStores',
|
|
1226
|
+
CreateStores: 'CreateStores',
|
|
1227
|
+
EditStores: 'EditStores',
|
|
1228
|
+
ViewStoresOpeningHours: 'ViewStoresOpeningHours',
|
|
1229
|
+
UpdateStoresOpenForCollectionOrDelivery: 'UpdateStoresOpenForCollectionOrDelivery',
|
|
1230
|
+
UpdateStoresOpeningHours: 'UpdateStoresOpeningHours',
|
|
1231
|
+
ViewStoresOpeningHoursOverride: 'ViewStoresOpeningHoursOverride',
|
|
1232
|
+
EditStoresOpeningHoursOverride: 'EditStoresOpeningHoursOverride',
|
|
1233
|
+
EditStoresOpeningHoursOverrideTemporary: 'EditStoresOpeningHoursOverrideTemporary',
|
|
1234
|
+
UpdateStoresName: 'UpdateStoresName',
|
|
1235
|
+
EditStoreKioskSettings: 'EditStoreKioskSettings',
|
|
1236
|
+
EditStoreOrderCapacity: 'EditStoreOrderCapacity',
|
|
1237
|
+
EditStoreNotifications: 'EditStoreNotifications',
|
|
1238
|
+
ArchiveStores: 'ArchiveStores',
|
|
1239
|
+
PublishStores: 'PublishStores',
|
|
1240
|
+
UpdatePrinterTerminalsAssign: 'UpdatePrinterTerminalsAssign',
|
|
1241
|
+
UpdatePrinterTerminalsToggle: 'UpdatePrinterTerminalsToggle',
|
|
1242
|
+
ViewStoreGroups: 'ViewStoreGroups',
|
|
1243
|
+
CreateStoreGroups: 'CreateStoreGroups',
|
|
1244
|
+
UpdateStoreGroups: 'UpdateStoreGroups',
|
|
1245
|
+
DeleteStoreGroups: 'DeleteStoreGroups',
|
|
1246
|
+
ViewDeliveryZones: 'ViewDeliveryZones',
|
|
1247
|
+
CreateDeliveryZones: 'CreateDeliveryZones',
|
|
1248
|
+
UpdateDeliveryZones: 'UpdateDeliveryZones',
|
|
1249
|
+
DeleteDeliveryZones: 'DeleteDeliveryZones',
|
|
1250
|
+
ViewMenu: 'ViewMenu',
|
|
1251
|
+
CreateMenu: 'CreateMenu',
|
|
1252
|
+
UpdateMenu: 'UpdateMenu',
|
|
1253
|
+
DeleteMenu: 'DeleteMenu',
|
|
1254
|
+
UpdateMenuLock: 'UpdateMenuLock',
|
|
1255
|
+
UpdateMenuItemsHideTemporarily: 'UpdateMenuItemsHideTemporarily',
|
|
1256
|
+
EditMenuImage: 'EditMenuImage',
|
|
1257
|
+
ViewVouchers: 'ViewVouchers',
|
|
1258
|
+
EditVouchers: 'EditVouchers',
|
|
1259
|
+
ViewWebsiteContent: 'ViewWebsiteContent',
|
|
1260
|
+
EditWebsiteContent: 'EditWebsiteContent',
|
|
1261
|
+
ViewWebsiteDnsVerified: 'ViewWebsiteDnsVerified',
|
|
1262
|
+
ViewWebsiteCertificateCreated: 'ViewWebsiteCertificateCreated',
|
|
1263
|
+
ViewWebsiteCertificateRenewed: 'ViewWebsiteCertificateRenewed',
|
|
1264
|
+
ViewBankAccounts: 'ViewBankAccounts',
|
|
1265
|
+
CreateBankAccounts: 'CreateBankAccounts',
|
|
1266
|
+
UpdateBankAccounts: 'UpdateBankAccounts',
|
|
1267
|
+
UpdateBankAccountsAssign: 'UpdateBankAccountsAssign',
|
|
1268
|
+
ViewAssignedBankAccount: 'ViewAssignedBankAccount',
|
|
1269
|
+
VerifyBankAccounts: 'VerifyBankAccounts',
|
|
1270
|
+
ViewServiceChargeConfigurations: 'ViewServiceChargeConfigurations',
|
|
1271
|
+
EditServiceChargeConfigurations: 'EditServiceChargeConfigurations',
|
|
1272
|
+
EditStoreDeliveryZoneFees: 'EditStoreDeliveryZoneFees',
|
|
1273
|
+
EditStoreDeliveryFeesLimited: 'EditStoreDeliveryFeesLimited',
|
|
1274
|
+
ViewHydraConfig: 'ViewHydraConfig',
|
|
1275
|
+
UpdateHydraConfigManage: 'UpdateHydraConfigManage',
|
|
1276
|
+
InitiateBluetoothPairingMode: 'InitiateBluetoothPairingMode',
|
|
1277
|
+
DeleteTerminal: 'DeleteTerminal',
|
|
1278
|
+
ViewKioskTelemetry: 'ViewKioskTelemetry',
|
|
1279
|
+
ViewCustomers: 'ViewCustomers',
|
|
1280
|
+
EditCustomers: 'EditCustomers',
|
|
1281
|
+
CreateCustomers: 'CreateCustomers',
|
|
1282
|
+
CreateCatalogElements: 'CreateCatalogElements',
|
|
1283
|
+
UpdateCatalogElements: 'UpdateCatalogElements',
|
|
1284
|
+
ViewCatalogElements: 'ViewCatalogElements',
|
|
1285
|
+
DeleteCatalogElements: 'DeleteCatalogElements',
|
|
1286
|
+
ViewMetafieldDefinitions: 'ViewMetafieldDefinitions',
|
|
1287
|
+
CreateMetafieldDefinitions: 'CreateMetafieldDefinitions',
|
|
1288
|
+
UpdateMetafieldDefinitions: 'UpdateMetafieldDefinitions',
|
|
1289
|
+
DeleteMetafieldDefinitions: 'DeleteMetafieldDefinitions',
|
|
1290
|
+
UpdateMetafields: 'UpdateMetafields',
|
|
1291
|
+
ViewCatalogMenuChanges: 'ViewCatalogMenuChanges',
|
|
1292
|
+
PublishCatalogMenuChanges: 'PublishCatalogMenuChanges',
|
|
1293
|
+
ViewAppStatistics: 'ViewAppStatistics',
|
|
1294
|
+
ViewApmStatistics: 'ViewApmStatistics',
|
|
1295
|
+
ViewCampaignsStatistics: 'ViewCampaignsStatistics',
|
|
1296
|
+
ViewCustomerStatistics: 'ViewCustomerStatistics',
|
|
1297
|
+
ViewLiveStatistics: 'ViewLiveStatistics',
|
|
1298
|
+
ViewOrderStatistics: 'ViewOrderStatistics',
|
|
1299
|
+
ViewSalesStatistics: 'ViewSalesStatistics',
|
|
1300
|
+
ViewSalesEndOfDayStatistics: 'ViewSalesEndOfDayStatistics',
|
|
1301
|
+
ViewVouchersStatistics: 'ViewVouchersStatistics',
|
|
1302
|
+
DownloadCustomerCsvExport: 'DownloadCustomerCsvExport',
|
|
1303
|
+
ViewApmAuditLogs: 'ViewApmAuditLogs',
|
|
1304
|
+
ViewStoreAuditLogs: 'ViewStoreAuditLogs',
|
|
1305
|
+
ViewMenuAuditLogs: 'ViewMenuAuditLogs',
|
|
1306
|
+
ViewBankAccountAuditLogs: 'ViewBankAccountAuditLogs',
|
|
1307
|
+
ViewFeeConfigurationsAuditLogs: 'ViewFeeConfigurationsAuditLogs',
|
|
1308
|
+
ViewOrdersAuditLogs: 'ViewOrdersAuditLogs',
|
|
1309
|
+
ViewVouchersAuditLogs: 'ViewVouchersAuditLogs',
|
|
1310
|
+
ViewUserEventsAuditLogs: 'ViewUserEventsAuditLogs',
|
|
1311
|
+
ViewCampaignsAuditLogs: 'ViewCampaignsAuditLogs',
|
|
1312
|
+
ViewTeammatesAuditLogs: 'ViewTeammatesAuditLogs',
|
|
1313
|
+
ViewAppAuditLogs: 'ViewAppAuditLogs',
|
|
1314
|
+
ViewCustomerAuditLogs: 'ViewCustomerAuditLogs',
|
|
1315
|
+
ViewPrinterAuditLogs: 'ViewPrinterAuditLogs',
|
|
1316
|
+
ViewHydraAuditLogs: 'ViewHydraAuditLogs',
|
|
1317
|
+
ViewPushNotificationAuditLogs: 'ViewPushNotificationAuditLogs',
|
|
1318
|
+
ViewStripeCustomConnectedAccountAuditLogs: 'ViewStripeCustomConnectedAccountAuditLogs',
|
|
1319
|
+
ViewKioskBluetoothDeviceAuditLogs: 'ViewKioskBluetoothDeviceAuditLogs',
|
|
1320
|
+
ViewExternalAuditLogs: 'ViewExternalAuditLogs',
|
|
1321
|
+
CreateExternalAuditLogEvents: 'CreateExternalAuditLogEvents',
|
|
1322
|
+
ViewCatalogAuditLogs: 'ViewCatalogAuditLogs',
|
|
1323
|
+
ViewOrderFulfillmentAuditLogs: 'ViewOrderFulfillmentAuditLogs',
|
|
1324
|
+
ViewChannelAuditLogs: 'ViewChannelAuditLogs',
|
|
1325
|
+
ViewAppStoreAuditLogs: 'ViewAppStoreAuditLogs',
|
|
1326
|
+
SendPushNotificationToCustomer: 'SendPushNotificationToCustomer',
|
|
1327
|
+
InviteDriverToApp: 'InviteDriverToApp',
|
|
1328
|
+
GetDriverForApp: 'GetDriverForApp',
|
|
1329
|
+
RemoveDriverFromApp: 'RemoveDriverFromApp',
|
|
1330
|
+
AssignDriverToOrder: 'AssignDriverToOrder',
|
|
1331
|
+
UnassignDriverFromOrder: 'UnassignDriverFromOrder',
|
|
1332
|
+
UpdateOrdersDeliveryTrackingStatus: 'UpdateOrdersDeliveryTrackingStatus',
|
|
1333
|
+
UpdateOrderFulfillmentStatus: 'UpdateOrderFulfillmentStatus',
|
|
1334
|
+
ViewFulfillmentStatesConfiguration: 'ViewFulfillmentStatesConfiguration',
|
|
1335
|
+
CreateFulfillmentStatesConfiguration: 'CreateFulfillmentStatesConfiguration',
|
|
1336
|
+
UpdateFulfillmentStatesConfiguration: 'UpdateFulfillmentStatesConfiguration',
|
|
1337
|
+
DeleteFulfillmentStatesConfiguration: 'DeleteFulfillmentStatesConfiguration',
|
|
1338
|
+
ViewPayouts: 'ViewPayouts',
|
|
1339
|
+
ViewChannels: 'ViewChannels',
|
|
1340
|
+
ViewOnboarding: 'ViewOnboarding',
|
|
1341
|
+
UpdateOnboarding: 'UpdateOnboarding',
|
|
1342
|
+
ViewClientDevices: 'ViewClientDevices',
|
|
1343
|
+
UpdateClientDevices: 'UpdateClientDevices',
|
|
1344
|
+
EnrollClientDevices: 'EnrollClientDevices',
|
|
1345
|
+
AssignClientDevices: 'AssignClientDevices',
|
|
1346
|
+
ViewClientAuditLogs: 'ViewClientAuditLogs',
|
|
1347
|
+
CreateAppStoreAppConfiguration: 'CreateAppStoreAppConfiguration',
|
|
1348
|
+
ViewAppStoreAppConfiguration: 'ViewAppStoreAppConfiguration',
|
|
1349
|
+
UpdateAppStoreAppConfiguration: 'UpdateAppStoreAppConfiguration',
|
|
1350
|
+
DeleteAppStoreAppConfiguration: 'DeleteAppStoreAppConfiguration',
|
|
1351
|
+
UpdateAppStoreAppConfigurationSettings: 'UpdateAppStoreAppConfigurationSettings',
|
|
1352
|
+
CreateAppStoreSubscription: 'CreateAppStoreSubscription',
|
|
1353
|
+
UpdateAppStoreSubscription: 'UpdateAppStoreSubscription',
|
|
1354
|
+
DeleteAppStoreSubscription: 'DeleteAppStoreSubscription',
|
|
1355
|
+
ViewSalesChannels: 'ViewSalesChannels',
|
|
1356
|
+
EditSalesChannels: 'EditSalesChannels',
|
|
1357
|
+
CreateSalesChannel: 'CreateSalesChannel',
|
|
1358
|
+
ArchiveSalesChannel: 'ArchiveSalesChannel',
|
|
1359
|
+
UnarchiveSalesChannel: 'UnarchiveSalesChannel',
|
|
1360
|
+
PublishSalesChannel: 'PublishSalesChannel',
|
|
1361
|
+
UnpublishSalesChannel: 'UnpublishSalesChannel',
|
|
1362
|
+
CloneSalesChannel: 'CloneSalesChannel',
|
|
1363
|
+
ViewPayGreenWhiteLabelConfiguration: 'ViewPayGreenWhiteLabelConfiguration',
|
|
1364
|
+
CreatePayGreenWhiteLabelConfiguration: 'CreatePayGreenWhiteLabelConfiguration',
|
|
1365
|
+
UpdatePayGreenWhiteLabelConfiguration: 'UpdatePayGreenWhiteLabelConfiguration',
|
|
1366
|
+
UpdatePayGreenStoreConfiguration: 'UpdatePayGreenStoreConfiguration',
|
|
1367
|
+
ViewSubscriptions: 'ViewSubscriptions',
|
|
1368
|
+
ViewInvoices: 'ViewInvoices',
|
|
1369
|
+
EditAccountsBills: 'EditAccountsBills',
|
|
1370
|
+
ViewAccountsBills: 'ViewAccountsBills',
|
|
1371
|
+
EditAccountsCategories: 'EditAccountsCategories',
|
|
1372
|
+
ViewAccountsCategories: 'ViewAccountsCategories',
|
|
1373
|
+
EditAccountsCreditAccounts: 'EditAccountsCreditAccounts',
|
|
1374
|
+
ViewAccountsCreditAccounts: 'ViewAccountsCreditAccounts',
|
|
1375
|
+
EditAccountsCreditBooks: 'EditAccountsCreditBooks',
|
|
1376
|
+
ViewAccountsCreditBooks: 'ViewAccountsCreditBooks',
|
|
1377
|
+
EditAccountsExpenses: 'EditAccountsExpenses',
|
|
1378
|
+
ViewAccountsExpenses: 'ViewAccountsExpenses',
|
|
1379
|
+
EditAccountsTransactionAccounts: 'EditAccountsTransactionAccounts',
|
|
1380
|
+
ViewAccountsTransactionAccounts: 'ViewAccountsTransactionAccounts',
|
|
1381
|
+
EditDocumentExplorer: 'EditDocumentExplorer',
|
|
1382
|
+
ViewDocumentExplorer: 'ViewDocumentExplorer',
|
|
1383
|
+
ViewInventoryReports: 'ViewInventoryReports',
|
|
1384
|
+
EditInventoryPurchaseOrders: 'EditInventoryPurchaseOrders',
|
|
1385
|
+
ViewInventoryPurchaseOrders: 'ViewInventoryPurchaseOrders',
|
|
1386
|
+
EditInventoryStockItems: 'EditInventoryStockItems',
|
|
1387
|
+
ViewInventoryStockItems: 'ViewInventoryStockItems',
|
|
1388
|
+
EditInventorySupplier: 'EditInventorySupplier',
|
|
1389
|
+
ViewInventorySupplier: 'ViewInventorySupplier',
|
|
1390
|
+
EditInventoryTrackingProfiles: 'EditInventoryTrackingProfiles',
|
|
1391
|
+
ViewInventoryTrackingProfiles: 'ViewInventoryTrackingProfiles',
|
|
1392
|
+
ViewPayrollReports: 'ViewPayrollReports',
|
|
1393
|
+
EditPayrollHoliday: 'EditPayrollHoliday',
|
|
1394
|
+
ViewPayrollHoliday: 'ViewPayrollHoliday',
|
|
1395
|
+
EditPayrollRota: 'EditPayrollRota',
|
|
1396
|
+
ViewPayrollRota: 'ViewPayrollRota',
|
|
1397
|
+
EditPayrollStaff: 'EditPayrollStaff',
|
|
1398
|
+
ViewPayrollStaff: 'ViewPayrollStaff',
|
|
1399
|
+
ViewSalesReports: 'ViewSalesReports',
|
|
1400
|
+
ViewCostReports: 'ViewCostReports',
|
|
1401
|
+
ViewMenuReports: 'ViewMenuReports',
|
|
1402
|
+
ViewBrand: 'ViewBrand',
|
|
1403
|
+
EditBrand: 'EditBrand',
|
|
1404
|
+
CreateBrand: 'CreateBrand',
|
|
1405
|
+
TransferBrand: 'TransferBrand',
|
|
1406
|
+
ViewProperty: 'ViewProperty',
|
|
1407
|
+
EditProperty: 'EditProperty',
|
|
1408
|
+
CreateProperty: 'CreateProperty',
|
|
1409
|
+
ArchiveProperty: 'ArchiveProperty',
|
|
1410
|
+
ViewEntityFeatureFlags: 'ViewEntityFeatureFlags',
|
|
1411
|
+
EditEntityFeatureFlags: 'EditEntityFeatureFlags',
|
|
1412
|
+
CreateOrg: 'CreateOrg',
|
|
1413
|
+
EditOrg: 'EditOrg',
|
|
1414
|
+
ViewOrg: 'ViewOrg',
|
|
1415
|
+
ViewWebhooks: 'ViewWebhooks',
|
|
1416
|
+
EditWebhooks: 'EditWebhooks'
|
|
1417
|
+
} as const;
|
|
1418
|
+
|
|
1419
|
+
export type GetAuthorizedPropertiesRequestActionEnum = typeof GetAuthorizedPropertiesRequestActionEnum[keyof typeof GetAuthorizedPropertiesRequestActionEnum];
|
|
1420
|
+
|
|
1421
|
+
/**
|
|
1422
|
+
* Response containing the authorized properties
|
|
1423
|
+
* @export
|
|
1424
|
+
* @interface GetAuthorizedPropertiesResponse
|
|
1425
|
+
*/
|
|
1426
|
+
export interface GetAuthorizedPropertiesResponse {
|
|
1427
|
+
/**
|
|
1428
|
+
*
|
|
1429
|
+
* @type {AuthorizationBatchResponseRequest}
|
|
1430
|
+
* @memberof GetAuthorizedPropertiesResponse
|
|
1431
|
+
*/
|
|
1432
|
+
'request': AuthorizationBatchResponseRequest;
|
|
1433
|
+
/**
|
|
1434
|
+
* Array of allowed resources
|
|
1435
|
+
* @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
|
|
1436
|
+
* @memberof GetAuthorizedPropertiesResponse
|
|
1437
|
+
*/
|
|
1438
|
+
'allowedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
|
|
1439
|
+
/**
|
|
1440
|
+
* Array of denied resources
|
|
1441
|
+
* @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
|
|
1442
|
+
* @memberof GetAuthorizedPropertiesResponse
|
|
1443
|
+
*/
|
|
1444
|
+
'deniedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
|
|
1445
|
+
}
|
|
555
1446
|
/**
|
|
556
1447
|
* Successful permissions retrieval response
|
|
557
1448
|
* @export
|
|
@@ -1955,6 +2846,275 @@ export class AuthorizationApi extends BaseAPI {
|
|
|
1955
2846
|
|
|
1956
2847
|
|
|
1957
2848
|
|
|
2849
|
+
/**
|
|
2850
|
+
* AuthorizedEntitiesApi - axios parameter creator
|
|
2851
|
+
* @export
|
|
2852
|
+
*/
|
|
2853
|
+
export const AuthorizedEntitiesApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
2854
|
+
return {
|
|
2855
|
+
/**
|
|
2856
|
+
* Get the authorized brands for a given org
|
|
2857
|
+
* @summary Get Authorized Brands
|
|
2858
|
+
* @param {string} orgId
|
|
2859
|
+
* @param {GetAuthorizedBrandsRequest} [getAuthorizedBrandsRequest]
|
|
2860
|
+
* @param {*} [options] Override http request option.
|
|
2861
|
+
* @throws {RequiredError}
|
|
2862
|
+
*/
|
|
2863
|
+
getAuthorizedBrands: async (orgId: string, getAuthorizedBrandsRequest?: GetAuthorizedBrandsRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2864
|
+
// verify required parameter 'orgId' is not null or undefined
|
|
2865
|
+
assertParamExists('getAuthorizedBrands', 'orgId', orgId)
|
|
2866
|
+
const localVarPath = `/orgs/{orgId}/getAuthorizedBrands`
|
|
2867
|
+
.replace(`{${"orgId"}}`, encodeURIComponent(String(orgId)));
|
|
2868
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2869
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2870
|
+
let baseOptions;
|
|
2871
|
+
if (configuration) {
|
|
2872
|
+
baseOptions = configuration.baseOptions;
|
|
2873
|
+
}
|
|
2874
|
+
|
|
2875
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
2876
|
+
const localVarHeaderParameter = {} as any;
|
|
2877
|
+
const localVarQueryParameter = {} as any;
|
|
2878
|
+
|
|
2879
|
+
// authentication ApiKeyAuth required
|
|
2880
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
2881
|
+
|
|
2882
|
+
|
|
2883
|
+
|
|
2884
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
2885
|
+
|
|
2886
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2887
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2888
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
2889
|
+
localVarRequestOptions.data = serializeDataIfNeeded(getAuthorizedBrandsRequest, localVarRequestOptions, configuration)
|
|
2890
|
+
|
|
2891
|
+
return {
|
|
2892
|
+
url: toPathString(localVarUrlObj),
|
|
2893
|
+
options: localVarRequestOptions,
|
|
2894
|
+
};
|
|
2895
|
+
},
|
|
2896
|
+
/**
|
|
2897
|
+
* Get the authorized orgs for a given principal
|
|
2898
|
+
* @summary Get Authorized Orgs
|
|
2899
|
+
* @param {GetAuthorizedOrgsRequest} [getAuthorizedOrgsRequest]
|
|
2900
|
+
* @param {*} [options] Override http request option.
|
|
2901
|
+
* @throws {RequiredError}
|
|
2902
|
+
*/
|
|
2903
|
+
getAuthorizedOrgs: async (getAuthorizedOrgsRequest?: GetAuthorizedOrgsRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2904
|
+
const localVarPath = `/getAuthorizedOrgs`;
|
|
2905
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2906
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2907
|
+
let baseOptions;
|
|
2908
|
+
if (configuration) {
|
|
2909
|
+
baseOptions = configuration.baseOptions;
|
|
2910
|
+
}
|
|
2911
|
+
|
|
2912
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
2913
|
+
const localVarHeaderParameter = {} as any;
|
|
2914
|
+
const localVarQueryParameter = {} as any;
|
|
2915
|
+
|
|
2916
|
+
// authentication ApiKeyAuth required
|
|
2917
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
2918
|
+
|
|
2919
|
+
|
|
2920
|
+
|
|
2921
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
2922
|
+
|
|
2923
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2924
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2925
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
2926
|
+
localVarRequestOptions.data = serializeDataIfNeeded(getAuthorizedOrgsRequest, localVarRequestOptions, configuration)
|
|
2927
|
+
|
|
2928
|
+
return {
|
|
2929
|
+
url: toPathString(localVarUrlObj),
|
|
2930
|
+
options: localVarRequestOptions,
|
|
2931
|
+
};
|
|
2932
|
+
},
|
|
2933
|
+
/**
|
|
2934
|
+
* Get the authorized properties for a given org
|
|
2935
|
+
* @summary Get Authorized Properties
|
|
2936
|
+
* @param {string} orgId
|
|
2937
|
+
* @param {GetAuthorizedPropertiesRequest} [getAuthorizedPropertiesRequest]
|
|
2938
|
+
* @param {*} [options] Override http request option.
|
|
2939
|
+
* @throws {RequiredError}
|
|
2940
|
+
*/
|
|
2941
|
+
getAuthorizedProperties: async (orgId: string, getAuthorizedPropertiesRequest?: GetAuthorizedPropertiesRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2942
|
+
// verify required parameter 'orgId' is not null or undefined
|
|
2943
|
+
assertParamExists('getAuthorizedProperties', 'orgId', orgId)
|
|
2944
|
+
const localVarPath = `/orgs/{orgId}/getAuthorizedProperties`
|
|
2945
|
+
.replace(`{${"orgId"}}`, encodeURIComponent(String(orgId)));
|
|
2946
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2947
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2948
|
+
let baseOptions;
|
|
2949
|
+
if (configuration) {
|
|
2950
|
+
baseOptions = configuration.baseOptions;
|
|
2951
|
+
}
|
|
2952
|
+
|
|
2953
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
2954
|
+
const localVarHeaderParameter = {} as any;
|
|
2955
|
+
const localVarQueryParameter = {} as any;
|
|
2956
|
+
|
|
2957
|
+
// authentication ApiKeyAuth required
|
|
2958
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
2959
|
+
|
|
2960
|
+
|
|
2961
|
+
|
|
2962
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
2963
|
+
|
|
2964
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2965
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2966
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
2967
|
+
localVarRequestOptions.data = serializeDataIfNeeded(getAuthorizedPropertiesRequest, localVarRequestOptions, configuration)
|
|
2968
|
+
|
|
2969
|
+
return {
|
|
2970
|
+
url: toPathString(localVarUrlObj),
|
|
2971
|
+
options: localVarRequestOptions,
|
|
2972
|
+
};
|
|
2973
|
+
},
|
|
2974
|
+
}
|
|
2975
|
+
};
|
|
2976
|
+
|
|
2977
|
+
/**
|
|
2978
|
+
* AuthorizedEntitiesApi - functional programming interface
|
|
2979
|
+
* @export
|
|
2980
|
+
*/
|
|
2981
|
+
export const AuthorizedEntitiesApiFp = function(configuration?: Configuration) {
|
|
2982
|
+
const localVarAxiosParamCreator = AuthorizedEntitiesApiAxiosParamCreator(configuration)
|
|
2983
|
+
return {
|
|
2984
|
+
/**
|
|
2985
|
+
* Get the authorized brands for a given org
|
|
2986
|
+
* @summary Get Authorized Brands
|
|
2987
|
+
* @param {string} orgId
|
|
2988
|
+
* @param {GetAuthorizedBrandsRequest} [getAuthorizedBrandsRequest]
|
|
2989
|
+
* @param {*} [options] Override http request option.
|
|
2990
|
+
* @throws {RequiredError}
|
|
2991
|
+
*/
|
|
2992
|
+
async getAuthorizedBrands(orgId: string, getAuthorizedBrandsRequest?: GetAuthorizedBrandsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAuthorizedBrandsResponse>> {
|
|
2993
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getAuthorizedBrands(orgId, getAuthorizedBrandsRequest, options);
|
|
2994
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2995
|
+
const localVarOperationServerBasePath = operationServerMap['AuthorizedEntitiesApi.getAuthorizedBrands']?.[localVarOperationServerIndex]?.url;
|
|
2996
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2997
|
+
},
|
|
2998
|
+
/**
|
|
2999
|
+
* Get the authorized orgs for a given principal
|
|
3000
|
+
* @summary Get Authorized Orgs
|
|
3001
|
+
* @param {GetAuthorizedOrgsRequest} [getAuthorizedOrgsRequest]
|
|
3002
|
+
* @param {*} [options] Override http request option.
|
|
3003
|
+
* @throws {RequiredError}
|
|
3004
|
+
*/
|
|
3005
|
+
async getAuthorizedOrgs(getAuthorizedOrgsRequest?: GetAuthorizedOrgsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAuthorizedOrgsResponse>> {
|
|
3006
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getAuthorizedOrgs(getAuthorizedOrgsRequest, options);
|
|
3007
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3008
|
+
const localVarOperationServerBasePath = operationServerMap['AuthorizedEntitiesApi.getAuthorizedOrgs']?.[localVarOperationServerIndex]?.url;
|
|
3009
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3010
|
+
},
|
|
3011
|
+
/**
|
|
3012
|
+
* Get the authorized properties for a given org
|
|
3013
|
+
* @summary Get Authorized Properties
|
|
3014
|
+
* @param {string} orgId
|
|
3015
|
+
* @param {GetAuthorizedPropertiesRequest} [getAuthorizedPropertiesRequest]
|
|
3016
|
+
* @param {*} [options] Override http request option.
|
|
3017
|
+
* @throws {RequiredError}
|
|
3018
|
+
*/
|
|
3019
|
+
async getAuthorizedProperties(orgId: string, getAuthorizedPropertiesRequest?: GetAuthorizedPropertiesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAuthorizedPropertiesResponse>> {
|
|
3020
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getAuthorizedProperties(orgId, getAuthorizedPropertiesRequest, options);
|
|
3021
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3022
|
+
const localVarOperationServerBasePath = operationServerMap['AuthorizedEntitiesApi.getAuthorizedProperties']?.[localVarOperationServerIndex]?.url;
|
|
3023
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3024
|
+
},
|
|
3025
|
+
}
|
|
3026
|
+
};
|
|
3027
|
+
|
|
3028
|
+
/**
|
|
3029
|
+
* AuthorizedEntitiesApi - factory interface
|
|
3030
|
+
* @export
|
|
3031
|
+
*/
|
|
3032
|
+
export const AuthorizedEntitiesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
3033
|
+
const localVarFp = AuthorizedEntitiesApiFp(configuration)
|
|
3034
|
+
return {
|
|
3035
|
+
/**
|
|
3036
|
+
* Get the authorized brands for a given org
|
|
3037
|
+
* @summary Get Authorized Brands
|
|
3038
|
+
* @param {string} orgId
|
|
3039
|
+
* @param {GetAuthorizedBrandsRequest} [getAuthorizedBrandsRequest]
|
|
3040
|
+
* @param {*} [options] Override http request option.
|
|
3041
|
+
* @throws {RequiredError}
|
|
3042
|
+
*/
|
|
3043
|
+
getAuthorizedBrands(orgId: string, getAuthorizedBrandsRequest?: GetAuthorizedBrandsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAuthorizedBrandsResponse> {
|
|
3044
|
+
return localVarFp.getAuthorizedBrands(orgId, getAuthorizedBrandsRequest, options).then((request) => request(axios, basePath));
|
|
3045
|
+
},
|
|
3046
|
+
/**
|
|
3047
|
+
* Get the authorized orgs for a given principal
|
|
3048
|
+
* @summary Get Authorized Orgs
|
|
3049
|
+
* @param {GetAuthorizedOrgsRequest} [getAuthorizedOrgsRequest]
|
|
3050
|
+
* @param {*} [options] Override http request option.
|
|
3051
|
+
* @throws {RequiredError}
|
|
3052
|
+
*/
|
|
3053
|
+
getAuthorizedOrgs(getAuthorizedOrgsRequest?: GetAuthorizedOrgsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAuthorizedOrgsResponse> {
|
|
3054
|
+
return localVarFp.getAuthorizedOrgs(getAuthorizedOrgsRequest, options).then((request) => request(axios, basePath));
|
|
3055
|
+
},
|
|
3056
|
+
/**
|
|
3057
|
+
* Get the authorized properties for a given org
|
|
3058
|
+
* @summary Get Authorized Properties
|
|
3059
|
+
* @param {string} orgId
|
|
3060
|
+
* @param {GetAuthorizedPropertiesRequest} [getAuthorizedPropertiesRequest]
|
|
3061
|
+
* @param {*} [options] Override http request option.
|
|
3062
|
+
* @throws {RequiredError}
|
|
3063
|
+
*/
|
|
3064
|
+
getAuthorizedProperties(orgId: string, getAuthorizedPropertiesRequest?: GetAuthorizedPropertiesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAuthorizedPropertiesResponse> {
|
|
3065
|
+
return localVarFp.getAuthorizedProperties(orgId, getAuthorizedPropertiesRequest, options).then((request) => request(axios, basePath));
|
|
3066
|
+
},
|
|
3067
|
+
};
|
|
3068
|
+
};
|
|
3069
|
+
|
|
3070
|
+
/**
|
|
3071
|
+
* AuthorizedEntitiesApi - object-oriented interface
|
|
3072
|
+
* @export
|
|
3073
|
+
* @class AuthorizedEntitiesApi
|
|
3074
|
+
* @extends {BaseAPI}
|
|
3075
|
+
*/
|
|
3076
|
+
export class AuthorizedEntitiesApi extends BaseAPI {
|
|
3077
|
+
/**
|
|
3078
|
+
* Get the authorized brands for a given org
|
|
3079
|
+
* @summary Get Authorized Brands
|
|
3080
|
+
* @param {string} orgId
|
|
3081
|
+
* @param {GetAuthorizedBrandsRequest} [getAuthorizedBrandsRequest]
|
|
3082
|
+
* @param {*} [options] Override http request option.
|
|
3083
|
+
* @throws {RequiredError}
|
|
3084
|
+
* @memberof AuthorizedEntitiesApi
|
|
3085
|
+
*/
|
|
3086
|
+
public getAuthorizedBrands(orgId: string, getAuthorizedBrandsRequest?: GetAuthorizedBrandsRequest, options?: RawAxiosRequestConfig) {
|
|
3087
|
+
return AuthorizedEntitiesApiFp(this.configuration).getAuthorizedBrands(orgId, getAuthorizedBrandsRequest, options).then((request) => request(this.axios, this.basePath));
|
|
3088
|
+
}
|
|
3089
|
+
|
|
3090
|
+
/**
|
|
3091
|
+
* Get the authorized orgs for a given principal
|
|
3092
|
+
* @summary Get Authorized Orgs
|
|
3093
|
+
* @param {GetAuthorizedOrgsRequest} [getAuthorizedOrgsRequest]
|
|
3094
|
+
* @param {*} [options] Override http request option.
|
|
3095
|
+
* @throws {RequiredError}
|
|
3096
|
+
* @memberof AuthorizedEntitiesApi
|
|
3097
|
+
*/
|
|
3098
|
+
public getAuthorizedOrgs(getAuthorizedOrgsRequest?: GetAuthorizedOrgsRequest, options?: RawAxiosRequestConfig) {
|
|
3099
|
+
return AuthorizedEntitiesApiFp(this.configuration).getAuthorizedOrgs(getAuthorizedOrgsRequest, options).then((request) => request(this.axios, this.basePath));
|
|
3100
|
+
}
|
|
3101
|
+
|
|
3102
|
+
/**
|
|
3103
|
+
* Get the authorized properties for a given org
|
|
3104
|
+
* @summary Get Authorized Properties
|
|
3105
|
+
* @param {string} orgId
|
|
3106
|
+
* @param {GetAuthorizedPropertiesRequest} [getAuthorizedPropertiesRequest]
|
|
3107
|
+
* @param {*} [options] Override http request option.
|
|
3108
|
+
* @throws {RequiredError}
|
|
3109
|
+
* @memberof AuthorizedEntitiesApi
|
|
3110
|
+
*/
|
|
3111
|
+
public getAuthorizedProperties(orgId: string, getAuthorizedPropertiesRequest?: GetAuthorizedPropertiesRequest, options?: RawAxiosRequestConfig) {
|
|
3112
|
+
return AuthorizedEntitiesApiFp(this.configuration).getAuthorizedProperties(orgId, getAuthorizedPropertiesRequest, options).then((request) => request(this.axios, this.basePath));
|
|
3113
|
+
}
|
|
3114
|
+
}
|
|
3115
|
+
|
|
3116
|
+
|
|
3117
|
+
|
|
1958
3118
|
/**
|
|
1959
3119
|
* PermissionsApi - axios parameter creator
|
|
1960
3120
|
* @export
|