@parra/parra-js-sdk 0.3.252 → 0.3.256

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.
@@ -1930,6 +1930,247 @@ export interface UpdateNotificationTopicRequestBody {
1930
1930
  description?: string | null;
1931
1931
  active?: boolean;
1932
1932
  }
1933
+ export interface CreateSettingsViewRequestBody {
1934
+ title: string;
1935
+ description?: string | null;
1936
+ display_title: string;
1937
+ display_description?: string | null;
1938
+ footer_label?: string | null;
1939
+ slug: string;
1940
+ }
1941
+ export interface SettingsItemIntegerData {
1942
+ default_value?: number | null;
1943
+ min_value?: number | null;
1944
+ max_value?: number | null;
1945
+ }
1946
+ export interface SettingsItemStringDataEnumOption {
1947
+ title?: string;
1948
+ value?: string;
1949
+ }
1950
+ export interface SettingsItemStringData {
1951
+ format?: string | null;
1952
+ enum_options?: Array<SettingsItemStringDataEnumOption> | null;
1953
+ default_value?: string | null;
1954
+ }
1955
+ export interface SettingsItemBooleanData {
1956
+ format?: string | null;
1957
+ true_label?: string | null;
1958
+ false_label?: string | null;
1959
+ default_value?: boolean | null;
1960
+ }
1961
+ export type SettingsItemData = SettingsItemIntegerData | SettingsItemStringData | SettingsItemBooleanData;
1962
+ export declare enum SettingsItemType {
1963
+ string = "string",
1964
+ boolean = "boolean",
1965
+ integer = "integer"
1966
+ }
1967
+ export interface SettingsItemStub {
1968
+ id: string;
1969
+ created_at: string;
1970
+ updated_at: string;
1971
+ deleted_at?: string | null;
1972
+ title: string;
1973
+ description?: string | null;
1974
+ display_title: string;
1975
+ display_description?: string | null;
1976
+ slug: string;
1977
+ transport_type?: string | null;
1978
+ key: string;
1979
+ type: SettingsItemType;
1980
+ required: boolean;
1981
+ nullable: boolean;
1982
+ }
1983
+ export interface SettingsItem {
1984
+ id: string;
1985
+ created_at: string;
1986
+ updated_at: string;
1987
+ deleted_at?: string | null;
1988
+ title: string;
1989
+ description?: string | null;
1990
+ display_title: string;
1991
+ display_description?: string | null;
1992
+ slug: string;
1993
+ transport_type?: string | null;
1994
+ key: string;
1995
+ type: SettingsItemType;
1996
+ required: boolean;
1997
+ nullable: boolean;
1998
+ data: SettingsItemData;
1999
+ }
2000
+ export interface SettingsGroupStub {
2001
+ id: string;
2002
+ created_at: string;
2003
+ updated_at: string;
2004
+ deleted_at?: string | null;
2005
+ tenant_id?: string;
2006
+ notification_topic_id?: string | null;
2007
+ title: string;
2008
+ description?: string | null;
2009
+ display_title: string;
2010
+ display_description?: string | null;
2011
+ slug: string;
2012
+ key?: string;
2013
+ }
2014
+ export interface SettingsGroup {
2015
+ id: string;
2016
+ created_at: string;
2017
+ updated_at: string;
2018
+ deleted_at?: string | null;
2019
+ tenant_id?: string;
2020
+ notification_topic_id?: string | null;
2021
+ title: string;
2022
+ description?: string | null;
2023
+ display_title: string;
2024
+ display_description?: string | null;
2025
+ slug: string;
2026
+ key?: string;
2027
+ items: Array<SettingsItem>;
2028
+ }
2029
+ export interface SettingsViewStub {
2030
+ id: string;
2031
+ created_at: string;
2032
+ updated_at: string;
2033
+ deleted_at?: string | null;
2034
+ tenant_id?: string;
2035
+ title: string;
2036
+ description?: string | null;
2037
+ display_title: string;
2038
+ display_description?: string | null;
2039
+ footer_label?: string | null;
2040
+ slug: string;
2041
+ type?: string | null;
2042
+ managed: boolean;
2043
+ active: boolean;
2044
+ }
2045
+ export interface SettingsView {
2046
+ id: string;
2047
+ created_at: string;
2048
+ updated_at: string;
2049
+ deleted_at?: string | null;
2050
+ tenant_id?: string;
2051
+ title: string;
2052
+ description?: string | null;
2053
+ display_title: string;
2054
+ display_description?: string | null;
2055
+ footer_label?: string | null;
2056
+ slug: string;
2057
+ type?: string | null;
2058
+ managed: boolean;
2059
+ active: boolean;
2060
+ groups: Array<SettingsGroup>;
2061
+ }
2062
+ export interface SettingsViewListResponse {
2063
+ data?: Array<SettingsView>;
2064
+ }
2065
+ export interface SettingsItemIntegerDataWithValue {
2066
+ default_value?: number | null;
2067
+ min_value?: number | null;
2068
+ max_value?: number | null;
2069
+ value?: number | null;
2070
+ }
2071
+ export interface SettingsItemStringDataWithValue {
2072
+ format?: string | null;
2073
+ enum_options?: Array<SettingsItemStringDataEnumOption> | null;
2074
+ default_value?: string | null;
2075
+ value?: string | null;
2076
+ }
2077
+ export interface SettingsItemBooleanDataWithValue {
2078
+ format?: string | null;
2079
+ true_label?: string | null;
2080
+ false_label?: string | null;
2081
+ default_value?: boolean | null;
2082
+ value?: boolean | null;
2083
+ }
2084
+ export type SettingsItemDataWithValue = SettingsItemIntegerDataWithValue | SettingsItemStringDataWithValue | SettingsItemBooleanDataWithValue;
2085
+ export interface UserSettingsItem {
2086
+ id: string;
2087
+ created_at: string;
2088
+ updated_at: string;
2089
+ deleted_at?: string | null;
2090
+ title: string;
2091
+ description?: string | null;
2092
+ display_title: string;
2093
+ display_description?: string | null;
2094
+ slug: string;
2095
+ transport_type?: string | null;
2096
+ key: string;
2097
+ type: SettingsItemType;
2098
+ required: boolean;
2099
+ nullable: boolean;
2100
+ data: SettingsItemDataWithValue;
2101
+ }
2102
+ export interface UserSettingsGroup {
2103
+ id: string;
2104
+ created_at: string;
2105
+ updated_at: string;
2106
+ deleted_at?: string | null;
2107
+ tenant_id?: string;
2108
+ notification_topic_id?: string | null;
2109
+ title: string;
2110
+ description?: string | null;
2111
+ display_title: string;
2112
+ display_description?: string | null;
2113
+ slug: string;
2114
+ key?: string;
2115
+ items?: Array<UserSettingsItem>;
2116
+ }
2117
+ export interface UserSettingsView {
2118
+ id: string;
2119
+ created_at: string;
2120
+ updated_at: string;
2121
+ deleted_at?: string | null;
2122
+ tenant_id?: string;
2123
+ title: string;
2124
+ description?: string | null;
2125
+ display_title: string;
2126
+ display_description?: string | null;
2127
+ footer_label?: string | null;
2128
+ slug: string;
2129
+ type?: string | null;
2130
+ managed: boolean;
2131
+ active: boolean;
2132
+ groups?: Array<UserSettingsGroup>;
2133
+ }
2134
+ export interface UserSettingsViewListResponse {
2135
+ data?: Array<UserSettingsView>;
2136
+ }
2137
+ export interface CreateSettingsGroupRequestBody {
2138
+ title: string;
2139
+ description?: string;
2140
+ display_title: string;
2141
+ display_description?: string;
2142
+ slug: string;
2143
+ }
2144
+ export interface UpdateSettingsGroupRequestBody {
2145
+ title?: string;
2146
+ description?: string | null;
2147
+ display_title?: string;
2148
+ display_description?: string | null;
2149
+ slug?: string;
2150
+ }
2151
+ export interface CreateSettingsItemRequestBody {
2152
+ title: string;
2153
+ description?: string | null;
2154
+ display_title: string;
2155
+ display_description?: string | null;
2156
+ slug: string;
2157
+ active?: boolean;
2158
+ type: string;
2159
+ required: boolean;
2160
+ nullable: boolean;
2161
+ data: SettingsItemData;
2162
+ }
2163
+ export interface UpdateSettingsItemRequestBody {
2164
+ title?: string;
2165
+ description?: string | null;
2166
+ display_title?: string;
2167
+ display_description?: string | null;
2168
+ slug?: string;
2169
+ active?: boolean;
2170
+ required?: boolean;
2171
+ nullable?: boolean;
2172
+ data?: SettingsItemData;
2173
+ }
1933
2174
  export interface CreateExternalDomainRequestBody {
1934
2175
  context?: string | null;
1935
2176
  name: string;
@@ -3390,6 +3631,24 @@ declare class ParraAPI {
3390
3631
  listNotificationTopics: (tenant_id: string, options?: Options) => Promise<Array<NotificationTopic>>;
3391
3632
  updateNotificationTopicById: (tenant_id: string, notification_topic_id: string, body?: UpdateNotificationTopicRequestBody, options?: Options) => Promise<NotificationTopic>;
3392
3633
  deleteNotificationTopicById: (tenant_id: string, notification_topic_id: string, options?: Options) => Promise<Response>;
3634
+ createSettingsViewForTenant: (tenant_id: string, body: CreateSettingsViewRequestBody, options?: Options) => Promise<SettingsView>;
3635
+ listSettingsViewsForTenant: (tenant_id: string, query?: {
3636
+ $select?: string;
3637
+ $top?: number;
3638
+ $skip?: number;
3639
+ $orderby?: string;
3640
+ $filter?: string;
3641
+ $expand?: string;
3642
+ $search?: string;
3643
+ }, options?: Options) => Promise<SettingsViewListResponse>;
3644
+ listSettingsViewsForTenantUser: (tenant_id: string, user_id: string, options?: Options) => Promise<UserSettingsViewListResponse>;
3645
+ getSettingsViewForTenantUser: (tenant_id: string, user_id: string, settings_view_id: string, options?: Options) => Promise<UserSettingsView>;
3646
+ createSettingsGroupForSettingsView: (tenant_id: string, settings_view_id: string, body: CreateSettingsGroupRequestBody, options?: Options) => Promise<SettingsGroup>;
3647
+ updateSettingsGroupForSettingsView: (tenant_id: string, settings_view_id: string, settings_group_id: string, body?: UpdateSettingsGroupRequestBody, options?: Options) => Promise<SettingsGroup>;
3648
+ deleteSettingsGroupForSettingsView: (tenant_id: string, settings_view_id: string, settings_group_id: string, options?: Options) => Promise<Response>;
3649
+ createSettingsItemForSettingsGroup: (tenant_id: string, settings_view_id: string, settings_group_id: string, body: CreateSettingsItemRequestBody, options?: Options) => Promise<SettingsItem>;
3650
+ updateSettingsItemForSettingsGroup: (tenant_id: string, settings_view_id: string, settings_group_id: string, settings_item_id: string, body?: UpdateSettingsItemRequestBody, options?: Options) => Promise<SettingsItem>;
3651
+ deleteSettingsItemForSettingsGroup: (tenant_id: string, settings_view_id: string, settings_group_id: string, settings_item_id: string, options?: Options) => Promise<Response>;
3393
3652
  createExternalDomainForTenantById: (tenant_id: string, body: CreateExternalDomainRequestBody, options?: Options) => Promise<ExternalDomain>;
3394
3653
  getExternalDomainByIdForTenantById: (tenant_id: string, external_domain_id: string, options?: Options) => Promise<ExternalDomain>;
3395
3654
  updateExternalDomainByIdForTenantById: (tenant_id: string, external_domain_id: string, body?: UpdateExternalDomainRequestBody, options?: Options) => Promise<ExternalDomain>;
package/dist/ParraAPI.js CHANGED
@@ -11,7 +11,7 @@ var __assign = (this && this.__assign) || function () {
11
11
  return __assign.apply(this, arguments);
12
12
  };
13
13
  Object.defineProperty(exports, "__esModule", { value: true });
14
- exports.PolicyDocumentVersionStatus = exports.PolicyDocumentStatus = exports.MailTemplateStatus = exports.MailTemplateVersionStatus = exports.MailTemplateType = exports.IntegrationScope = exports.IntegrationConnectionStatus = exports.IntegrationType = exports.ConnectedAppConnectionStatus = exports.ConnectedAppType = exports.TenantOnboardingGoal = exports.DashboardChecklistItemStatus = exports.DashboardChecklistItemType = exports.RefreshTokenRotationType = exports.RefreshTokenExpirationType = exports.JwtAlgorithm = exports.GrantType = exports.PasswordlessStrategy = exports.ApnsPushType = exports.ApnsEnvironment = exports.ChannelType = exports.AppVersionStatus = exports.TicketDisplayStatus = exports.UserNoteStatus = exports.TemplateType = exports.CampaignStatus = exports.CampaignActionDisplayType = exports.CampaignActionType = exports.CardItemDisplayType = exports.CardItemType = exports.QuestionKind = exports.QuestionType = exports.FeedItemType = exports.FeedbackFormFieldType = exports.SubscriptionStatus = exports.Interval = exports.Currency = exports.IdentityType = exports.PolicyDocumentType = exports.DomainStatus = exports.DomainType = exports.ApplicationType = exports.ReleaseType = exports.ReleaseStatus = exports.TicketIconType = exports.TicketPriority = exports.TicketStatus = exports.TicketType = void 0;
14
+ exports.PolicyDocumentVersionStatus = exports.PolicyDocumentStatus = exports.MailTemplateStatus = exports.MailTemplateVersionStatus = exports.MailTemplateType = exports.IntegrationScope = exports.IntegrationConnectionStatus = exports.IntegrationType = exports.ConnectedAppConnectionStatus = exports.ConnectedAppType = exports.TenantOnboardingGoal = exports.DashboardChecklistItemStatus = exports.DashboardChecklistItemType = exports.RefreshTokenRotationType = exports.RefreshTokenExpirationType = exports.JwtAlgorithm = exports.GrantType = exports.PasswordlessStrategy = exports.SettingsItemType = exports.ApnsPushType = exports.ApnsEnvironment = exports.ChannelType = exports.AppVersionStatus = exports.TicketDisplayStatus = exports.UserNoteStatus = exports.TemplateType = exports.CampaignStatus = exports.CampaignActionDisplayType = exports.CampaignActionType = exports.CardItemDisplayType = exports.CardItemType = exports.QuestionKind = exports.QuestionType = exports.FeedItemType = exports.FeedbackFormFieldType = exports.SubscriptionStatus = exports.Interval = exports.Currency = exports.IdentityType = exports.PolicyDocumentType = exports.DomainStatus = exports.DomainType = exports.ApplicationType = exports.ReleaseType = exports.ReleaseStatus = exports.TicketIconType = exports.TicketPriority = exports.TicketStatus = exports.TicketType = void 0;
15
15
  var TicketType;
16
16
  (function (TicketType) {
17
17
  TicketType["bug"] = "bug";
@@ -220,6 +220,12 @@ var ApnsPushType;
220
220
  ApnsPushType["voip"] = "voip";
221
221
  ApnsPushType["mdm"] = "mdm";
222
222
  })(ApnsPushType || (exports.ApnsPushType = ApnsPushType = {}));
223
+ var SettingsItemType;
224
+ (function (SettingsItemType) {
225
+ SettingsItemType["string"] = "string";
226
+ SettingsItemType["boolean"] = "boolean";
227
+ SettingsItemType["integer"] = "integer";
228
+ })(SettingsItemType || (exports.SettingsItemType = SettingsItemType = {}));
223
229
  var PasswordlessStrategy;
224
230
  (function (PasswordlessStrategy) {
225
231
  PasswordlessStrategy["email"] = "email";
@@ -1005,6 +1011,56 @@ var ParraAPI = /** @class */ (function () {
1005
1011
  if (options === void 0) { options = {}; }
1006
1012
  return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/notifications/topics/").concat(notification_topic_id), __assign({ method: "delete" }, options));
1007
1013
  };
1014
+ this.createSettingsViewForTenant = function (tenant_id, body, options) {
1015
+ if (options === void 0) { options = {}; }
1016
+ return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/settings/views"), __assign({ method: "post", body: JSON.stringify(body), headers: {
1017
+ "content-type": "application/json",
1018
+ } }, options));
1019
+ };
1020
+ this.listSettingsViewsForTenant = function (tenant_id, query, options) {
1021
+ if (options === void 0) { options = {}; }
1022
+ return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/settings/views"), __assign({ method: "get", query: query }, options));
1023
+ };
1024
+ this.listSettingsViewsForTenantUser = function (tenant_id, user_id, options) {
1025
+ if (options === void 0) { options = {}; }
1026
+ return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/users/").concat(user_id, "/settings/views"), __assign({ method: "get" }, options));
1027
+ };
1028
+ this.getSettingsViewForTenantUser = function (tenant_id, user_id, settings_view_id, options) {
1029
+ if (options === void 0) { options = {}; }
1030
+ return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/users/").concat(user_id, "/settings/views/").concat(settings_view_id), __assign({ method: "get" }, options));
1031
+ };
1032
+ this.createSettingsGroupForSettingsView = function (tenant_id, settings_view_id, body, options) {
1033
+ if (options === void 0) { options = {}; }
1034
+ return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/settings/views/").concat(settings_view_id, "/groups"), __assign({ method: "post", body: JSON.stringify(body), headers: {
1035
+ "content-type": "application/json",
1036
+ } }, options));
1037
+ };
1038
+ this.updateSettingsGroupForSettingsView = function (tenant_id, settings_view_id, settings_group_id, body, options) {
1039
+ if (options === void 0) { options = {}; }
1040
+ return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/settings/views/").concat(settings_view_id, "/groups/").concat(settings_group_id), __assign({ method: "put", body: JSON.stringify(body), headers: {
1041
+ "content-type": "application/json",
1042
+ } }, options));
1043
+ };
1044
+ this.deleteSettingsGroupForSettingsView = function (tenant_id, settings_view_id, settings_group_id, options) {
1045
+ if (options === void 0) { options = {}; }
1046
+ return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/settings/views/").concat(settings_view_id, "/groups/").concat(settings_group_id), __assign({ method: "delete" }, options));
1047
+ };
1048
+ this.createSettingsItemForSettingsGroup = function (tenant_id, settings_view_id, settings_group_id, body, options) {
1049
+ if (options === void 0) { options = {}; }
1050
+ return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/settings/views/").concat(settings_view_id, "/groups/").concat(settings_group_id, "/items"), __assign({ method: "post", body: JSON.stringify(body), headers: {
1051
+ "content-type": "application/json",
1052
+ } }, options));
1053
+ };
1054
+ this.updateSettingsItemForSettingsGroup = function (tenant_id, settings_view_id, settings_group_id, settings_item_id, body, options) {
1055
+ if (options === void 0) { options = {}; }
1056
+ return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/settings/views/").concat(settings_view_id, "/groups/").concat(settings_group_id, "/items/").concat(settings_item_id), __assign({ method: "put", body: JSON.stringify(body), headers: {
1057
+ "content-type": "application/json",
1058
+ } }, options));
1059
+ };
1060
+ this.deleteSettingsItemForSettingsGroup = function (tenant_id, settings_view_id, settings_group_id, settings_item_id, options) {
1061
+ if (options === void 0) { options = {}; }
1062
+ return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/settings/views/").concat(settings_view_id, "/groups/").concat(settings_group_id, "/items/").concat(settings_item_id), __assign({ method: "delete" }, options));
1063
+ };
1008
1064
  this.createExternalDomainForTenantById = function (tenant_id, body, options) {
1009
1065
  if (options === void 0) { options = {}; }
1010
1066
  return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/domains/external"), __assign({ method: "post", body: JSON.stringify(body), headers: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@parra/parra-js-sdk",
3
- "version": "0.3.252",
3
+ "version": "0.3.256",
4
4
  "description": "",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",