@flipdish/authorization 0.2.53 → 0.2.54-rc.1788876166

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.
@@ -1,5 +1,6 @@
1
1
  .gitignore
2
2
  .npmignore
3
+ .openapi-generator-ignore
3
4
  README.md
4
5
  api.ts
5
6
  base.ts
package/api.ts CHANGED
@@ -1971,6 +1971,84 @@ export interface ListPrincipalAccessBlocksResponse {
1971
1971
  */
1972
1972
  'items': Array<AccessBlockStateResponse>;
1973
1973
  }
1974
+ /**
1975
+ * Successful role definitions retrieval response
1976
+ * @export
1977
+ * @interface ListRoleDefinitionsSuccessResponse
1978
+ */
1979
+ export interface ListRoleDefinitionsSuccessResponse {
1980
+ /**
1981
+ * Roles and the permissions they grant at each hierarchy level
1982
+ * @type {Array<ListRoleDefinitionsSuccessResponseRolesInner>}
1983
+ * @memberof ListRoleDefinitionsSuccessResponse
1984
+ */
1985
+ 'roles': Array<ListRoleDefinitionsSuccessResponseRolesInner>;
1986
+ }
1987
+ /**
1988
+ *
1989
+ * @export
1990
+ * @interface ListRoleDefinitionsSuccessResponseRolesInner
1991
+ */
1992
+ export interface ListRoleDefinitionsSuccessResponseRolesInner {
1993
+ /**
1994
+ * Name of the role
1995
+ * @type {string}
1996
+ * @memberof ListRoleDefinitionsSuccessResponseRolesInner
1997
+ */
1998
+ 'name': ListRoleDefinitionsSuccessResponseRolesInnerNameEnum;
1999
+ /**
2000
+ *
2001
+ * @type {RoleLevels}
2002
+ * @memberof ListRoleDefinitionsSuccessResponseRolesInner
2003
+ */
2004
+ 'levels': RoleLevels;
2005
+ /**
2006
+ * Permission sets that can be granted on top of the role
2007
+ * @type {Array<ListRoleDefinitionsSuccessResponseRolesInnerOptionalPermissionSetsInner>}
2008
+ * @memberof ListRoleDefinitionsSuccessResponseRolesInner
2009
+ */
2010
+ 'optionalPermissionSets': Array<ListRoleDefinitionsSuccessResponseRolesInnerOptionalPermissionSetsInner>;
2011
+ }
2012
+
2013
+ export const ListRoleDefinitionsSuccessResponseRolesInnerNameEnum = {
2014
+ Owner: 'Owner',
2015
+ PropertyOwner: 'PropertyOwner',
2016
+ ManagedOwner: 'ManagedOwner',
2017
+ Integrator: 'Integrator',
2018
+ PropertyManager: 'PropertyManager',
2019
+ FinanceManager: 'FinanceManager',
2020
+ StaffMember: 'StaffMember',
2021
+ Kiosk: 'Kiosk',
2022
+ Terminal: 'Terminal'
2023
+ } as const;
2024
+
2025
+ export type ListRoleDefinitionsSuccessResponseRolesInnerNameEnum = typeof ListRoleDefinitionsSuccessResponseRolesInnerNameEnum[keyof typeof ListRoleDefinitionsSuccessResponseRolesInnerNameEnum];
2026
+
2027
+ /**
2028
+ *
2029
+ * @export
2030
+ * @interface ListRoleDefinitionsSuccessResponseRolesInnerOptionalPermissionSetsInner
2031
+ */
2032
+ export interface ListRoleDefinitionsSuccessResponseRolesInnerOptionalPermissionSetsInner {
2033
+ /**
2034
+ * Key used to add this permission set to a role assignment
2035
+ * @type {string}
2036
+ * @memberof ListRoleDefinitionsSuccessResponseRolesInnerOptionalPermissionSetsInner
2037
+ */
2038
+ 'key': string;
2039
+ /**
2040
+ * Human readable name of the permission set
2041
+ * @type {string}
2042
+ * @memberof ListRoleDefinitionsSuccessResponseRolesInnerOptionalPermissionSetsInner
2043
+ */
2044
+ 'name': string;
2045
+ /**
2046
+ *
2047
+ * @type {RoleLevels}
2048
+ * @memberof ListRoleDefinitionsSuccessResponseRolesInnerOptionalPermissionSetsInner
2049
+ */
2050
+ 'levels': RoleLevels;
2051
+ }
1974
2052
  /**
1975
2053
  * Successful roles retrieval response
1976
2054
  * @export
@@ -2237,6 +2315,26 @@ export const Permissions = {
2237
2315
  ViewWebhooks: 'ViewWebhooks',
2238
2316
  EditWebhooks: 'EditWebhooks',
2239
2317
  ViewOwnPermissions: 'ViewOwnPermissions',
2318
+ CreatePosSale: 'CreatePosSale',
2319
+ ComplimentPosItems: 'ComplimentPosItems',
2320
+ ApplyPosDiscounts: 'ApplyPosDiscounts',
2321
+ CancelPosSales: 'CancelPosSales',
2322
+ DeliverSale: 'DeliverSale',
2323
+ PerformCashingUp: 'PerformCashingUp',
2324
+ OpenCashDrawer: 'OpenCashDrawer',
2325
+ EditPosSettings: 'EditPosSettings',
2326
+ EditPosLayout: 'EditPosLayout',
2327
+ ViewPosDailySummaryReport: 'ViewPosDailySummaryReport',
2328
+ ViewPosDriverSalesReport: 'ViewPosDriverSalesReport',
2329
+ CreatePurchaseOrder: 'CreatePurchaseOrder',
2330
+ SubmitPurchaseOrder: 'SubmitPurchaseOrder',
2331
+ ReceivePurchaseOrder: 'ReceivePurchaseOrder',
2332
+ ViewBusinessInsights: 'ViewBusinessInsights',
2333
+ SnoozePosMenu: 'SnoozePosMenu',
2334
+ SnoozePosMenuIndefinitely: 'SnoozePosMenuIndefinitely',
2335
+ SnoozePosItem: 'SnoozePosItem',
2336
+ SnoozePosItemIndefinitely: 'SnoozePosItemIndefinitely',
2337
+ SnoozePosProperty: 'SnoozePosProperty',
2240
2338
  RoleAdmin: 'RoleAdmin',
2241
2339
  RoleFactory: 'RoleFactory',
2242
2340
  RoleAuthDeveloper: 'RoleAuthDeveloper',
@@ -2690,6 +2788,76 @@ export interface RoleAssignmentSuccessResponse {
2690
2788
  */
2691
2789
  'message': string;
2692
2790
  }
2791
+ /**
2792
+ * Permissions granted at a single hierarchy level
2793
+ * @export
2794
+ * @interface RoleLevelDefinition
2795
+ */
2796
+ export interface RoleLevelDefinition {
2797
+ /**
2798
+ * input grants the permissions on the resources named in the assignment, all grants them on every resource of that level in the org
2799
+ * @type {string}
2800
+ * @memberof RoleLevelDefinition
2801
+ */
2802
+ 'scope': RoleLevelDefinitionScopeEnum;
2803
+ /**
2804
+ * Permissions granted at this hierarchy level
2805
+ * @type {Array<Permissions>}
2806
+ * @memberof RoleLevelDefinition
2807
+ */
2808
+ 'permissions': Array<Permissions>;
2809
+ }
2810
+
2811
+ export const RoleLevelDefinitionScopeEnum = {
2812
+ Input: 'input',
2813
+ All: 'all'
2814
+ } as const;
2815
+
2816
+ export type RoleLevelDefinitionScopeEnum = typeof RoleLevelDefinitionScopeEnum[keyof typeof RoleLevelDefinitionScopeEnum];
2817
+
2818
+ /**
2819
+ * Permissions granted, keyed by hierarchy level
2820
+ * @export
2821
+ * @interface RoleLevels
2822
+ */
2823
+ export interface RoleLevels {
2824
+ /**
2825
+ *
2826
+ * @type {RoleLevelDefinition}
2827
+ * @memberof RoleLevels
2828
+ */
2829
+ 'org'?: RoleLevelDefinition;
2830
+ /**
2831
+ *
2832
+ * @type {RoleLevelDefinition}
2833
+ * @memberof RoleLevels
2834
+ */
2835
+ 'brand'?: RoleLevelDefinition;
2836
+ /**
2837
+ *
2838
+ * @type {RoleLevelDefinition}
2839
+ * @memberof RoleLevels
2840
+ */
2841
+ 'property'?: RoleLevelDefinition;
2842
+ /**
2843
+ *
2844
+ * @type {RoleLevelDefinition}
2845
+ * @memberof RoleLevels
2846
+ */
2847
+ 'salesChannel'?: RoleLevelDefinition;
2848
+ /**
2849
+ *
2850
+ * @type {RoleLevelDefinition}
2851
+ * @memberof RoleLevels
2852
+ */
2853
+ 'global'?: RoleLevelDefinition;
2854
+ /**
2855
+ *
2856
+ * @type {RoleLevelDefinition}
2857
+ * @memberof RoleLevels
2858
+ */
2859
+ 'self'?: RoleLevelDefinition;
2860
+ }
2693
2861
  /**
2694
2862
  * Role names
2695
2863
  * @export
@@ -4382,6 +4550,39 @@ export const ConfigurationDataApiAxiosParamCreator = function (configuration?: C
4382
4550
 
4383
4551
 
4384
4552
 
4553
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
4554
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
4555
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
4556
+
4557
+ return {
4558
+ url: toPathString(localVarUrlObj),
4559
+ options: localVarRequestOptions,
4560
+ };
4561
+ },
4562
+ /**
4563
+ * List the teammate roles with the permissions they grant at each hierarchy level, including optional permission sets
4564
+ * @summary List Role Definitions
4565
+ * @param {*} [options] Override http request option.
4566
+ * @throws {RequiredError}
4567
+ */
4568
+ listRoleDefinitions: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
4569
+ const localVarPath = `/config/roleDefinitions`;
4570
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
4571
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
4572
+ let baseOptions;
4573
+ if (configuration) {
4574
+ baseOptions = configuration.baseOptions;
4575
+ }
4576
+
4577
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
4578
+ const localVarHeaderParameter = {} as any;
4579
+ const localVarQueryParameter = {} as any;
4580
+
4581
+ // authentication ApiKeyAuth required
4582
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
4583
+
4584
+
4585
+
4385
4586
  setSearchParams(localVarUrlObj, localVarQueryParameter);
4386
4587
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
4387
4588
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -4446,6 +4647,18 @@ export const ConfigurationDataApiFp = function(configuration?: Configuration) {
4446
4647
  const localVarOperationServerBasePath = operationServerMap['ConfigurationDataApi.listPermissions']?.[localVarOperationServerIndex]?.url;
4447
4648
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
4448
4649
  },
4650
+ /**
4651
+ * List the teammate roles with the permissions they grant at each hierarchy level, including optional permission sets
4652
+ * @summary List Role Definitions
4653
+ * @param {*} [options] Override http request option.
4654
+ * @throws {RequiredError}
4655
+ */
4656
+ async listRoleDefinitions(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListRoleDefinitionsSuccessResponse>> {
4657
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listRoleDefinitions(options);
4658
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
4659
+ const localVarOperationServerBasePath = operationServerMap['ConfigurationDataApi.listRoleDefinitions']?.[localVarOperationServerIndex]?.url;
4660
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
4661
+ },
4449
4662
  /**
4450
4663
  * List the available roles
4451
4664
  * @summary List Roles
@@ -4477,6 +4690,15 @@ export const ConfigurationDataApiFactory = function (configuration?: Configurati
4477
4690
  listPermissions(options?: RawAxiosRequestConfig): AxiosPromise<ListPermissionsSuccessResponse> {
4478
4691
  return localVarFp.listPermissions(options).then((request) => request(axios, basePath));
4479
4692
  },
4693
+ /**
4694
+ * List the teammate roles with the permissions they grant at each hierarchy level, including optional permission sets
4695
+ * @summary List Role Definitions
4696
+ * @param {*} [options] Override http request option.
4697
+ * @throws {RequiredError}
4698
+ */
4699
+ listRoleDefinitions(options?: RawAxiosRequestConfig): AxiosPromise<ListRoleDefinitionsSuccessResponse> {
4700
+ return localVarFp.listRoleDefinitions(options).then((request) => request(axios, basePath));
4701
+ },
4480
4702
  /**
4481
4703
  * List the available roles
4482
4704
  * @summary List Roles
@@ -4507,6 +4729,17 @@ export class ConfigurationDataApi extends BaseAPI {
4507
4729
  return ConfigurationDataApiFp(this.configuration).listPermissions(options).then((request) => request(this.axios, this.basePath));
4508
4730
  }
4509
4731
 
4732
+ /**
4733
+ * List the teammate roles with the permissions they grant at each hierarchy level, including optional permission sets
4734
+ * @summary List Role Definitions
4735
+ * @param {*} [options] Override http request option.
4736
+ * @throws {RequiredError}
4737
+ * @memberof ConfigurationDataApi
4738
+ */
4739
+ public listRoleDefinitions(options?: RawAxiosRequestConfig) {
4740
+ return ConfigurationDataApiFp(this.configuration).listRoleDefinitions(options).then((request) => request(this.axios, this.basePath));
4741
+ }
4742
+
4510
4743
  /**
4511
4744
  * List the available roles
4512
4745
  * @summary List Roles
package/configuration.ts CHANGED
@@ -100,7 +100,7 @@ export class Configuration {
100
100
 
101
101
  const extraHeaders = param.useDefaultUserAgent ? {} : {
102
102
  headers: {
103
- "user-agent": "Flipdish authorization typescript SDK / 0.2.53"
103
+ "user-agent": "Flipdish authorization typescript SDK / 0.2.54-rc.1788876166"
104
104
  }
105
105
  };
106
106
 
package/dist/api.d.ts CHANGED
@@ -1888,6 +1888,81 @@ export interface ListPrincipalAccessBlocksResponse {
1888
1888
  */
1889
1889
  'items': Array<AccessBlockStateResponse>;
1890
1890
  }
1891
+ /**
1892
+ * Successful role definitions retrieval response
1893
+ * @export
1894
+ * @interface ListRoleDefinitionsSuccessResponse
1895
+ */
1896
+ export interface ListRoleDefinitionsSuccessResponse {
1897
+ /**
1898
+ * Roles and the permissions they grant at each hierarchy level
1899
+ * @type {Array<ListRoleDefinitionsSuccessResponseRolesInner>}
1900
+ * @memberof ListRoleDefinitionsSuccessResponse
1901
+ */
1902
+ 'roles': Array<ListRoleDefinitionsSuccessResponseRolesInner>;
1903
+ }
1904
+ /**
1905
+ *
1906
+ * @export
1907
+ * @interface ListRoleDefinitionsSuccessResponseRolesInner
1908
+ */
1909
+ export interface ListRoleDefinitionsSuccessResponseRolesInner {
1910
+ /**
1911
+ * Name of the role
1912
+ * @type {string}
1913
+ * @memberof ListRoleDefinitionsSuccessResponseRolesInner
1914
+ */
1915
+ 'name': ListRoleDefinitionsSuccessResponseRolesInnerNameEnum;
1916
+ /**
1917
+ *
1918
+ * @type {RoleLevels}
1919
+ * @memberof ListRoleDefinitionsSuccessResponseRolesInner
1920
+ */
1921
+ 'levels': RoleLevels;
1922
+ /**
1923
+ * Permission sets that can be granted on top of the role
1924
+ * @type {Array<ListRoleDefinitionsSuccessResponseRolesInnerOptionalPermissionSetsInner>}
1925
+ * @memberof ListRoleDefinitionsSuccessResponseRolesInner
1926
+ */
1927
+ 'optionalPermissionSets': Array<ListRoleDefinitionsSuccessResponseRolesInnerOptionalPermissionSetsInner>;
1928
+ }
1929
+ export declare const ListRoleDefinitionsSuccessResponseRolesInnerNameEnum: {
1930
+ readonly Owner: "Owner";
1931
+ readonly PropertyOwner: "PropertyOwner";
1932
+ readonly ManagedOwner: "ManagedOwner";
1933
+ readonly Integrator: "Integrator";
1934
+ readonly PropertyManager: "PropertyManager";
1935
+ readonly FinanceManager: "FinanceManager";
1936
+ readonly StaffMember: "StaffMember";
1937
+ readonly Kiosk: "Kiosk";
1938
+ readonly Terminal: "Terminal";
1939
+ };
1940
+ export type ListRoleDefinitionsSuccessResponseRolesInnerNameEnum = typeof ListRoleDefinitionsSuccessResponseRolesInnerNameEnum[keyof typeof ListRoleDefinitionsSuccessResponseRolesInnerNameEnum];
1941
+ /**
1942
+ *
1943
+ * @export
1944
+ * @interface ListRoleDefinitionsSuccessResponseRolesInnerOptionalPermissionSetsInner
1945
+ */
1946
+ export interface ListRoleDefinitionsSuccessResponseRolesInnerOptionalPermissionSetsInner {
1947
+ /**
1948
+ * Key used to add this permission set to a role assignment
1949
+ * @type {string}
1950
+ * @memberof ListRoleDefinitionsSuccessResponseRolesInnerOptionalPermissionSetsInner
1951
+ */
1952
+ 'key': string;
1953
+ /**
1954
+ * Human readable name of the permission set
1955
+ * @type {string}
1956
+ * @memberof ListRoleDefinitionsSuccessResponseRolesInnerOptionalPermissionSetsInner
1957
+ */
1958
+ 'name': string;
1959
+ /**
1960
+ *
1961
+ * @type {RoleLevels}
1962
+ * @memberof ListRoleDefinitionsSuccessResponseRolesInnerOptionalPermissionSetsInner
1963
+ */
1964
+ 'levels': RoleLevels;
1965
+ }
1891
1966
  /**
1892
1967
  * Successful roles retrieval response
1893
1968
  * @export
@@ -2153,6 +2228,26 @@ export declare const Permissions: {
2153
2228
  readonly ViewWebhooks: "ViewWebhooks";
2154
2229
  readonly EditWebhooks: "EditWebhooks";
2155
2230
  readonly ViewOwnPermissions: "ViewOwnPermissions";
2231
+ readonly CreatePosSale: "CreatePosSale";
2232
+ readonly ComplimentPosItems: "ComplimentPosItems";
2233
+ readonly ApplyPosDiscounts: "ApplyPosDiscounts";
2234
+ readonly CancelPosSales: "CancelPosSales";
2235
+ readonly DeliverSale: "DeliverSale";
2236
+ readonly PerformCashingUp: "PerformCashingUp";
2237
+ readonly OpenCashDrawer: "OpenCashDrawer";
2238
+ readonly EditPosSettings: "EditPosSettings";
2239
+ readonly EditPosLayout: "EditPosLayout";
2240
+ readonly ViewPosDailySummaryReport: "ViewPosDailySummaryReport";
2241
+ readonly ViewPosDriverSalesReport: "ViewPosDriverSalesReport";
2242
+ readonly CreatePurchaseOrder: "CreatePurchaseOrder";
2243
+ readonly SubmitPurchaseOrder: "SubmitPurchaseOrder";
2244
+ readonly ReceivePurchaseOrder: "ReceivePurchaseOrder";
2245
+ readonly ViewBusinessInsights: "ViewBusinessInsights";
2246
+ readonly SnoozePosMenu: "SnoozePosMenu";
2247
+ readonly SnoozePosMenuIndefinitely: "SnoozePosMenuIndefinitely";
2248
+ readonly SnoozePosItem: "SnoozePosItem";
2249
+ readonly SnoozePosItemIndefinitely: "SnoozePosItemIndefinitely";
2250
+ readonly SnoozePosProperty: "SnoozePosProperty";
2156
2251
  readonly RoleAdmin: "RoleAdmin";
2157
2252
  readonly RoleFactory: "RoleFactory";
2158
2253
  readonly RoleAuthDeveloper: "RoleAuthDeveloper";
@@ -2585,6 +2680,73 @@ export interface RoleAssignmentSuccessResponse {
2585
2680
  */
2586
2681
  'message': string;
2587
2682
  }
2683
+ /**
2684
+ * Permissions granted at a single hierarchy level
2685
+ * @export
2686
+ * @interface RoleLevelDefinition
2687
+ */
2688
+ export interface RoleLevelDefinition {
2689
+ /**
2690
+ * input grants the permissions on the resources named in the assignment, all grants them on every resource of that level in the org
2691
+ * @type {string}
2692
+ * @memberof RoleLevelDefinition
2693
+ */
2694
+ 'scope': RoleLevelDefinitionScopeEnum;
2695
+ /**
2696
+ * Permissions granted at this hierarchy level
2697
+ * @type {Array<Permissions>}
2698
+ * @memberof RoleLevelDefinition
2699
+ */
2700
+ 'permissions': Array<Permissions>;
2701
+ }
2702
+ export declare const RoleLevelDefinitionScopeEnum: {
2703
+ readonly Input: "input";
2704
+ readonly All: "all";
2705
+ };
2706
+ export type RoleLevelDefinitionScopeEnum = typeof RoleLevelDefinitionScopeEnum[keyof typeof RoleLevelDefinitionScopeEnum];
2707
+ /**
2708
+ * Permissions granted, keyed by hierarchy level
2709
+ * @export
2710
+ * @interface RoleLevels
2711
+ */
2712
+ export interface RoleLevels {
2713
+ /**
2714
+ *
2715
+ * @type {RoleLevelDefinition}
2716
+ * @memberof RoleLevels
2717
+ */
2718
+ 'org'?: RoleLevelDefinition;
2719
+ /**
2720
+ *
2721
+ * @type {RoleLevelDefinition}
2722
+ * @memberof RoleLevels
2723
+ */
2724
+ 'brand'?: RoleLevelDefinition;
2725
+ /**
2726
+ *
2727
+ * @type {RoleLevelDefinition}
2728
+ * @memberof RoleLevels
2729
+ */
2730
+ 'property'?: RoleLevelDefinition;
2731
+ /**
2732
+ *
2733
+ * @type {RoleLevelDefinition}
2734
+ * @memberof RoleLevels
2735
+ */
2736
+ 'salesChannel'?: RoleLevelDefinition;
2737
+ /**
2738
+ *
2739
+ * @type {RoleLevelDefinition}
2740
+ * @memberof RoleLevels
2741
+ */
2742
+ 'global'?: RoleLevelDefinition;
2743
+ /**
2744
+ *
2745
+ * @type {RoleLevelDefinition}
2746
+ * @memberof RoleLevels
2747
+ */
2748
+ 'self'?: RoleLevelDefinition;
2749
+ }
2588
2750
  /**
2589
2751
  * Role names
2590
2752
  * @export
@@ -3556,6 +3718,13 @@ export declare const ConfigurationDataApiAxiosParamCreator: (configuration?: Con
3556
3718
  * @throws {RequiredError}
3557
3719
  */
3558
3720
  listPermissions: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3721
+ /**
3722
+ * List the teammate roles with the permissions they grant at each hierarchy level, including optional permission sets
3723
+ * @summary List Role Definitions
3724
+ * @param {*} [options] Override http request option.
3725
+ * @throws {RequiredError}
3726
+ */
3727
+ listRoleDefinitions: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3559
3728
  /**
3560
3729
  * List the available roles
3561
3730
  * @summary List Roles
@@ -3576,6 +3745,13 @@ export declare const ConfigurationDataApiFp: (configuration?: Configuration) =>
3576
3745
  * @throws {RequiredError}
3577
3746
  */
3578
3747
  listPermissions(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPermissionsSuccessResponse>>;
3748
+ /**
3749
+ * List the teammate roles with the permissions they grant at each hierarchy level, including optional permission sets
3750
+ * @summary List Role Definitions
3751
+ * @param {*} [options] Override http request option.
3752
+ * @throws {RequiredError}
3753
+ */
3754
+ listRoleDefinitions(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListRoleDefinitionsSuccessResponse>>;
3579
3755
  /**
3580
3756
  * List the available roles
3581
3757
  * @summary List Roles
@@ -3596,6 +3772,13 @@ export declare const ConfigurationDataApiFactory: (configuration?: Configuration
3596
3772
  * @throws {RequiredError}
3597
3773
  */
3598
3774
  listPermissions(options?: RawAxiosRequestConfig): AxiosPromise<ListPermissionsSuccessResponse>;
3775
+ /**
3776
+ * List the teammate roles with the permissions they grant at each hierarchy level, including optional permission sets
3777
+ * @summary List Role Definitions
3778
+ * @param {*} [options] Override http request option.
3779
+ * @throws {RequiredError}
3780
+ */
3781
+ listRoleDefinitions(options?: RawAxiosRequestConfig): AxiosPromise<ListRoleDefinitionsSuccessResponse>;
3599
3782
  /**
3600
3783
  * List the available roles
3601
3784
  * @summary List Roles
@@ -3619,6 +3802,14 @@ export declare class ConfigurationDataApi extends BaseAPI {
3619
3802
  * @memberof ConfigurationDataApi
3620
3803
  */
3621
3804
  listPermissions(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPermissionsSuccessResponse, any, {}, any>>;
3805
+ /**
3806
+ * List the teammate roles with the permissions they grant at each hierarchy level, including optional permission sets
3807
+ * @summary List Role Definitions
3808
+ * @param {*} [options] Override http request option.
3809
+ * @throws {RequiredError}
3810
+ * @memberof ConfigurationDataApi
3811
+ */
3812
+ listRoleDefinitions(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListRoleDefinitionsSuccessResponse, any, {}, any>>;
3622
3813
  /**
3623
3814
  * List the available roles
3624
3815
  * @summary List Roles
package/dist/api.js CHANGED
@@ -84,8 +84,8 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
84
84
  return to.concat(ar || Array.prototype.slice.call(from));
85
85
  };
86
86
  Object.defineProperty(exports, "__esModule", { value: true });
87
- exports.AuthorizationApiFp = exports.AuthorizationApiAxiosParamCreator = exports.AuthenticationApi = exports.AuthenticationApiFactory = exports.AuthenticationApiFp = exports.AuthenticationApiAxiosParamCreator = exports.ListGlobalApiKeysStatusEnum = exports.APIKeysApi = exports.APIKeysApiFactory = exports.APIKeysApiFp = exports.APIKeysApiAxiosParamCreator = exports.UnblockPrincipalAccessResponseStatusEnum = exports.TimedAccessGrantResponseStatusEnum = exports.TimedAccessGrantResponsePrincipalTypeEnum = exports.TimedAccessGrantRequestBodyRoleNameEnum = exports.TimedAccessGrantStatusEnum = exports.TimedAccessGrantPrincipalTypeEnum = exports.RoleNames = exports.RoleAssignmentRequestBodyPrincipalTypeEnum = exports.RoleAssignmentRequestBodyActorTypeEnum = exports.RoleAssignmentRequestBodyRoleNameEnum = exports.RemoveTeammateRequestBodyPrincipalTypeEnum = exports.RemoveTeammateRequestBodyActorTypeEnum = exports.PrincipalInOrgTypeEnum = exports.Permissions = exports.ListOrgRolesSuccessResponseValueRolesEnum = exports.JoinAccessErrorResponseCodeEnum = exports.IsInRoleRequestCheckModeEnum = exports.InviteTokenResponseRoleNameEnum = exports.GlobalApiKeyStateResponseUpdatedStatusEnum = exports.GlobalApiKeyStateResponseRevokedStatusEnum = exports.GlobalApiKeyStateResponseStatusEnum = exports.GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum = exports.GetJoinAccessRequest200ResponseRoleNameEnum = exports.GetJoinAccessRequest200ResponseStateEnum = exports.GetAuthorizedOrgsRequestPrincipalTypeEnum = exports.AuthorizationRequestResourceOneOf3TypeEnum = exports.AuthorizationRequestResourceOneOf2TypeEnum = exports.AuthorizationRequestResourceOneOf1TypeEnum = exports.AuthorizationRequestResourceOneOfTypeEnum = exports.AuthorizationRequestPrincipalTypeEnum = exports.AuthorizationRequestCheckModeEnum = exports.AuthorizationBatchResponseAllowedResourcesInnerPrincipalTypeEnum = exports.AuthenticateApiKey200ResponseOkEnum = exports.AuthenticateAndCheckIsInRoleRequestCheckModeEnum = exports.AuthenticateAndAuthorizeRequestCheckModeEnum = exports.AccessRequestResponseRoleNameEnum = exports.AccessRequestResponseStateEnum = exports.AccessBlockStateResponseBlockedPrincipalTypeEnum = exports.AcceptJoinRequestRoleNameEnum = void 0;
88
- exports.UserPermissionsApi = exports.UserPermissionsApiFactory = exports.UserPermissionsApiFp = exports.UserPermissionsApiAxiosParamCreator = exports.UserManagementApi = exports.UserManagementApiFactory = exports.UserManagementApiFp = exports.UserManagementApiAxiosParamCreator = exports.ListMyTimedAccessGrantsStatusEnum = exports.TimedAccessApi = exports.TimedAccessApiFactory = exports.TimedAccessApiFp = exports.TimedAccessApiAxiosParamCreator = exports.RoleAssignmentApi = exports.RoleAssignmentApiFactory = exports.RoleAssignmentApiFp = exports.RoleAssignmentApiAxiosParamCreator = exports.ListPrincipalAccessBlocksTypeEnum = exports.GetPrincipalAccessBlockTypeEnum = exports.PrincipalAccessBlockApi = exports.PrincipalAccessBlockApiFactory = exports.PrincipalAccessBlockApiFp = exports.PrincipalAccessBlockApiAxiosParamCreator = exports.JoinAccessApi = exports.JoinAccessApiFactory = exports.JoinAccessApiFp = exports.JoinAccessApiAxiosParamCreator = exports.ConfigurationDataApi = exports.ConfigurationDataApiFactory = exports.ConfigurationDataApiFp = exports.ConfigurationDataApiAxiosParamCreator = exports.AuthorizedEntitiesApi = exports.AuthorizedEntitiesApiFactory = exports.AuthorizedEntitiesApiFp = exports.AuthorizedEntitiesApiAxiosParamCreator = exports.AuthorizationApi = exports.AuthorizationApiFactory = void 0;
87
+ exports.AuthenticationApi = exports.AuthenticationApiFactory = exports.AuthenticationApiFp = exports.AuthenticationApiAxiosParamCreator = exports.ListGlobalApiKeysStatusEnum = exports.APIKeysApi = exports.APIKeysApiFactory = exports.APIKeysApiFp = exports.APIKeysApiAxiosParamCreator = exports.UnblockPrincipalAccessResponseStatusEnum = exports.TimedAccessGrantResponseStatusEnum = exports.TimedAccessGrantResponsePrincipalTypeEnum = exports.TimedAccessGrantRequestBodyRoleNameEnum = exports.TimedAccessGrantStatusEnum = exports.TimedAccessGrantPrincipalTypeEnum = exports.RoleNames = exports.RoleLevelDefinitionScopeEnum = exports.RoleAssignmentRequestBodyPrincipalTypeEnum = exports.RoleAssignmentRequestBodyActorTypeEnum = exports.RoleAssignmentRequestBodyRoleNameEnum = exports.RemoveTeammateRequestBodyPrincipalTypeEnum = exports.RemoveTeammateRequestBodyActorTypeEnum = exports.PrincipalInOrgTypeEnum = exports.Permissions = exports.ListRoleDefinitionsSuccessResponseRolesInnerNameEnum = exports.ListOrgRolesSuccessResponseValueRolesEnum = exports.JoinAccessErrorResponseCodeEnum = exports.IsInRoleRequestCheckModeEnum = exports.InviteTokenResponseRoleNameEnum = exports.GlobalApiKeyStateResponseUpdatedStatusEnum = exports.GlobalApiKeyStateResponseRevokedStatusEnum = exports.GlobalApiKeyStateResponseStatusEnum = exports.GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum = exports.GetJoinAccessRequest200ResponseRoleNameEnum = exports.GetJoinAccessRequest200ResponseStateEnum = exports.GetAuthorizedOrgsRequestPrincipalTypeEnum = exports.AuthorizationRequestResourceOneOf3TypeEnum = exports.AuthorizationRequestResourceOneOf2TypeEnum = exports.AuthorizationRequestResourceOneOf1TypeEnum = exports.AuthorizationRequestResourceOneOfTypeEnum = exports.AuthorizationRequestPrincipalTypeEnum = exports.AuthorizationRequestCheckModeEnum = exports.AuthorizationBatchResponseAllowedResourcesInnerPrincipalTypeEnum = exports.AuthenticateApiKey200ResponseOkEnum = exports.AuthenticateAndCheckIsInRoleRequestCheckModeEnum = exports.AuthenticateAndAuthorizeRequestCheckModeEnum = exports.AccessRequestResponseRoleNameEnum = exports.AccessRequestResponseStateEnum = exports.AccessBlockStateResponseBlockedPrincipalTypeEnum = exports.AcceptJoinRequestRoleNameEnum = void 0;
88
+ exports.UserPermissionsApi = exports.UserPermissionsApiFactory = exports.UserPermissionsApiFp = exports.UserPermissionsApiAxiosParamCreator = exports.UserManagementApi = exports.UserManagementApiFactory = exports.UserManagementApiFp = exports.UserManagementApiAxiosParamCreator = exports.ListMyTimedAccessGrantsStatusEnum = exports.TimedAccessApi = exports.TimedAccessApiFactory = exports.TimedAccessApiFp = exports.TimedAccessApiAxiosParamCreator = exports.RoleAssignmentApi = exports.RoleAssignmentApiFactory = exports.RoleAssignmentApiFp = exports.RoleAssignmentApiAxiosParamCreator = exports.ListPrincipalAccessBlocksTypeEnum = exports.GetPrincipalAccessBlockTypeEnum = exports.PrincipalAccessBlockApi = exports.PrincipalAccessBlockApiFactory = exports.PrincipalAccessBlockApiFp = exports.PrincipalAccessBlockApiAxiosParamCreator = exports.JoinAccessApi = exports.JoinAccessApiFactory = exports.JoinAccessApiFp = exports.JoinAccessApiAxiosParamCreator = exports.ConfigurationDataApi = exports.ConfigurationDataApiFactory = exports.ConfigurationDataApiFp = exports.ConfigurationDataApiAxiosParamCreator = exports.AuthorizedEntitiesApi = exports.AuthorizedEntitiesApiFactory = exports.AuthorizedEntitiesApiFp = exports.AuthorizedEntitiesApiAxiosParamCreator = exports.AuthorizationApi = exports.AuthorizationApiFactory = exports.AuthorizationApiFp = exports.AuthorizationApiAxiosParamCreator = void 0;
89
89
  var axios_1 = require("axios");
90
90
  // Some imports not used depending on template conditions
91
91
  // @ts-ignore
@@ -235,6 +235,17 @@ exports.ListOrgRolesSuccessResponseValueRolesEnum = {
235
235
  Kiosk: 'Kiosk',
236
236
  Terminal: 'Terminal'
237
237
  };
238
+ exports.ListRoleDefinitionsSuccessResponseRolesInnerNameEnum = {
239
+ Owner: 'Owner',
240
+ PropertyOwner: 'PropertyOwner',
241
+ ManagedOwner: 'ManagedOwner',
242
+ Integrator: 'Integrator',
243
+ PropertyManager: 'PropertyManager',
244
+ FinanceManager: 'FinanceManager',
245
+ StaffMember: 'StaffMember',
246
+ Kiosk: 'Kiosk',
247
+ Terminal: 'Terminal'
248
+ };
238
249
  /**
239
250
  * Permissions
240
251
  * @export
@@ -474,6 +485,26 @@ exports.Permissions = {
474
485
  ViewWebhooks: 'ViewWebhooks',
475
486
  EditWebhooks: 'EditWebhooks',
476
487
  ViewOwnPermissions: 'ViewOwnPermissions',
488
+ CreatePosSale: 'CreatePosSale',
489
+ ComplimentPosItems: 'ComplimentPosItems',
490
+ ApplyPosDiscounts: 'ApplyPosDiscounts',
491
+ CancelPosSales: 'CancelPosSales',
492
+ DeliverSale: 'DeliverSale',
493
+ PerformCashingUp: 'PerformCashingUp',
494
+ OpenCashDrawer: 'OpenCashDrawer',
495
+ EditPosSettings: 'EditPosSettings',
496
+ EditPosLayout: 'EditPosLayout',
497
+ ViewPosDailySummaryReport: 'ViewPosDailySummaryReport',
498
+ ViewPosDriverSalesReport: 'ViewPosDriverSalesReport',
499
+ CreatePurchaseOrder: 'CreatePurchaseOrder',
500
+ SubmitPurchaseOrder: 'SubmitPurchaseOrder',
501
+ ReceivePurchaseOrder: 'ReceivePurchaseOrder',
502
+ ViewBusinessInsights: 'ViewBusinessInsights',
503
+ SnoozePosMenu: 'SnoozePosMenu',
504
+ SnoozePosMenuIndefinitely: 'SnoozePosMenuIndefinitely',
505
+ SnoozePosItem: 'SnoozePosItem',
506
+ SnoozePosItemIndefinitely: 'SnoozePosItemIndefinitely',
507
+ SnoozePosProperty: 'SnoozePosProperty',
477
508
  RoleAdmin: 'RoleAdmin',
478
509
  RoleFactory: 'RoleFactory',
479
510
  RoleAuthDeveloper: 'RoleAuthDeveloper',
@@ -520,6 +551,10 @@ exports.RoleAssignmentRequestBodyPrincipalTypeEnum = {
520
551
  Kiosk: 'Kiosk',
521
552
  Terminal: 'Terminal'
522
553
  };
554
+ exports.RoleLevelDefinitionScopeEnum = {
555
+ Input: 'input',
556
+ All: 'all'
557
+ };
523
558
  /**
524
559
  * Role names
525
560
  * @export
@@ -2228,6 +2263,47 @@ var ConfigurationDataApiAxiosParamCreator = function (configuration) {
2228
2263
  });
2229
2264
  });
2230
2265
  },
2266
+ /**
2267
+ * List the teammate roles with the permissions they grant at each hierarchy level, including optional permission sets
2268
+ * @summary List Role Definitions
2269
+ * @param {*} [options] Override http request option.
2270
+ * @throws {RequiredError}
2271
+ */
2272
+ listRoleDefinitions: function () {
2273
+ var args_1 = [];
2274
+ for (var _i = 0; _i < arguments.length; _i++) {
2275
+ args_1[_i] = arguments[_i];
2276
+ }
2277
+ return __awaiter(_this, __spreadArray([], args_1, true), void 0, function (options) {
2278
+ var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
2279
+ if (options === void 0) { options = {}; }
2280
+ return __generator(this, function (_a) {
2281
+ switch (_a.label) {
2282
+ case 0:
2283
+ localVarPath = "/config/roleDefinitions";
2284
+ localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
2285
+ if (configuration) {
2286
+ baseOptions = configuration.baseOptions;
2287
+ }
2288
+ localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
2289
+ localVarHeaderParameter = {};
2290
+ localVarQueryParameter = {};
2291
+ // authentication ApiKeyAuth required
2292
+ return [4 /*yield*/, (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration)];
2293
+ case 1:
2294
+ // authentication ApiKeyAuth required
2295
+ _a.sent();
2296
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
2297
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2298
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
2299
+ return [2 /*return*/, {
2300
+ url: (0, common_1.toPathString)(localVarUrlObj),
2301
+ options: localVarRequestOptions,
2302
+ }];
2303
+ }
2304
+ });
2305
+ });
2306
+ },
2231
2307
  /**
2232
2308
  * List the available roles
2233
2309
  * @summary List Roles
@@ -2301,6 +2377,28 @@ var ConfigurationDataApiFp = function (configuration) {
2301
2377
  });
2302
2378
  });
2303
2379
  },
2380
+ /**
2381
+ * List the teammate roles with the permissions they grant at each hierarchy level, including optional permission sets
2382
+ * @summary List Role Definitions
2383
+ * @param {*} [options] Override http request option.
2384
+ * @throws {RequiredError}
2385
+ */
2386
+ listRoleDefinitions: function (options) {
2387
+ return __awaiter(this, void 0, void 0, function () {
2388
+ var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
2389
+ var _a, _b, _c;
2390
+ return __generator(this, function (_d) {
2391
+ switch (_d.label) {
2392
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.listRoleDefinitions(options)];
2393
+ case 1:
2394
+ localVarAxiosArgs = _d.sent();
2395
+ localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
2396
+ localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ConfigurationDataApi.listRoleDefinitions']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
2397
+ return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
2398
+ }
2399
+ });
2400
+ });
2401
+ },
2304
2402
  /**
2305
2403
  * List the available roles
2306
2404
  * @summary List Roles
@@ -2342,6 +2440,15 @@ var ConfigurationDataApiFactory = function (configuration, basePath, axios) {
2342
2440
  listPermissions: function (options) {
2343
2441
  return localVarFp.listPermissions(options).then(function (request) { return request(axios, basePath); });
2344
2442
  },
2443
+ /**
2444
+ * List the teammate roles with the permissions they grant at each hierarchy level, including optional permission sets
2445
+ * @summary List Role Definitions
2446
+ * @param {*} [options] Override http request option.
2447
+ * @throws {RequiredError}
2448
+ */
2449
+ listRoleDefinitions: function (options) {
2450
+ return localVarFp.listRoleDefinitions(options).then(function (request) { return request(axios, basePath); });
2451
+ },
2345
2452
  /**
2346
2453
  * List the available roles
2347
2454
  * @summary List Roles
@@ -2376,6 +2483,17 @@ var ConfigurationDataApi = /** @class */ (function (_super) {
2376
2483
  var _this = this;
2377
2484
  return (0, exports.ConfigurationDataApiFp)(this.configuration).listPermissions(options).then(function (request) { return request(_this.axios, _this.basePath); });
2378
2485
  };
2486
+ /**
2487
+ * List the teammate roles with the permissions they grant at each hierarchy level, including optional permission sets
2488
+ * @summary List Role Definitions
2489
+ * @param {*} [options] Override http request option.
2490
+ * @throws {RequiredError}
2491
+ * @memberof ConfigurationDataApi
2492
+ */
2493
+ ConfigurationDataApi.prototype.listRoleDefinitions = function (options) {
2494
+ var _this = this;
2495
+ return (0, exports.ConfigurationDataApiFp)(this.configuration).listRoleDefinitions(options).then(function (request) { return request(_this.axios, _this.basePath); });
2496
+ };
2379
2497
  /**
2380
2498
  * List the available roles
2381
2499
  * @summary List Roles
@@ -36,7 +36,7 @@ var Configuration = /** @class */ (function () {
36
36
  this.serverIndex = param.serverIndex;
37
37
  var extraHeaders = param.useDefaultUserAgent ? {} : {
38
38
  headers: {
39
- "user-agent": "Flipdish authorization typescript SDK / 0.2.53"
39
+ "user-agent": "Flipdish authorization typescript SDK / 0.2.54-rc.1788876166"
40
40
  }
41
41
  };
42
42
  this.baseOptions = __assign(__assign({}, extraHeaders), param.baseOptions);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@flipdish/authorization",
3
- "version": "0.2.53",
3
+ "version": "0.2.54-rc.1788876166",
4
4
  "description": "OpenAPI client for @flipdish/authorization",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {