@connectedxm/admin-sdk 7.9.5 → 7.11.0

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.
Files changed (17) hide show
  1. package/.openapi-generator/FILES +4 -0
  2. package/AdminApi.ts +3 -0
  3. package/README.md +6 -0
  4. package/api.ts +341 -0
  5. package/dist/AdminApi.d.ts +2 -1
  6. package/dist/AdminApi.js +1 -0
  7. package/dist/api.d.ts +181 -0
  8. package/dist/api.js +285 -21
  9. package/dist/esm/AdminApi.d.ts +2 -1
  10. package/dist/esm/AdminApi.js +2 -1
  11. package/dist/esm/api.d.ts +181 -0
  12. package/dist/esm/api.js +260 -0
  13. package/docs/GetOrganizationLanguageOverrides200Response.md +26 -0
  14. package/docs/OrganizationLanguageOverride.md +26 -0
  15. package/docs/OrganizationLanguageOverrideUpsertInputs.md +22 -0
  16. package/docs/OrganizationLanguageoverridesApi.md +173 -0
  17. package/package.json +1 -1
package/docs/OrganizationLanguageoverridesApi.md ADDED
@@ -0,0 +1,173 @@
1
+ # OrganizationLanguageoverridesApi
2
+
3
+ All URIs are relative to *https://admin-api.connected.dev*
4
+
5
+ |Method | HTTP request | Description|
6
+ |------------- | ------------- | -------------|
7
+ |[**deleteOrganizationLanguageOverride**](#deleteorganizationlanguageoverride) | **DELETE** /organization/language-overrides | Delete a language override|
8
+ |[**getOrganizationLanguageOverrides**](#getorganizationlanguageoverrides) | **GET** /organization/language-overrides | List an organization\'s language overrides|
9
+ |[**upsertOrganizationLanguageOverride**](#upsertorganizationlanguageoverride) | **PUT** /organization/language-overrides | Create or update a language override|
10
+
11
+ # **deleteOrganizationLanguageOverride**
12
+ > SyncAccounts200Response deleteOrganizationLanguageOverride()
13
+
14
+ Deletes the organization\'s i18n string override for the given key across all locales (key sent as a query parameter since keys can contain spaces), requires the update org permission, and refreshes the language overrides list on success.
15
+
16
+ ### Example
17
+
18
+ ```typescript
19
+ import {
20
+ OrganizationLanguageoverridesApi,
21
+ Configuration
22
+ } from '@connectedxm/admin-sdk';
23
+
24
+ const configuration = new Configuration();
25
+ const apiInstance = new OrganizationLanguageoverridesApi(configuration);
26
+
27
+ let key: string; //Filter by key (default to undefined)
28
+
29
+ const { status, data } = await apiInstance.deleteOrganizationLanguageOverride(
30
+ key
31
+ );
32
+ ```
33
+
34
+ ### Parameters
35
+
36
+ |Name | Type | Description | Notes|
37
+ |------------- | ------------- | ------------- | -------------|
38
+ | **key** | [**string**] | Filter by key | defaults to undefined|
39
+
40
+
41
+ ### Return type
42
+
43
+ **SyncAccounts200Response**
44
+
45
+ ### Authorization
46
+
47
+ [ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
48
+
49
+ ### HTTP request headers
50
+
51
+ - **Content-Type**: Not defined
52
+ - **Accept**: application/json
53
+
54
+
55
+ ### HTTP response details
56
+ | Status code | Description | Response headers |
57
+ |-------------|-------------|------------------|
58
+ |**200** | Successful response | - |
59
+
60
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
61
+
62
+ # **getOrganizationLanguageOverrides**
63
+ > GetOrganizationLanguageOverrides200Response getOrganizationLanguageOverrides()
64
+
65
+ Returns a paginated list of the organization\'s i18n string overrides grouped by key, each with its per-locale values; searchable by key. Requires org read permission.
66
+
67
+ ### Example
68
+
69
+ ```typescript
70
+ import {
71
+ OrganizationLanguageoverridesApi,
72
+ Configuration
73
+ } from '@connectedxm/admin-sdk';
74
+
75
+ const configuration = new Configuration();
76
+ const apiInstance = new OrganizationLanguageoverridesApi(configuration);
77
+
78
+ let page: number; //Page number (optional) (default to 1)
79
+ let pageSize: number; //Number of items per page (optional) (default to 25)
80
+ let orderBy: string; //Field to order by (optional) (default to undefined)
81
+ let search: string; //Search query (optional) (default to undefined)
82
+
83
+ const { status, data } = await apiInstance.getOrganizationLanguageOverrides(
84
+ page,
85
+ pageSize,
86
+ orderBy,
87
+ search
88
+ );
89
+ ```
90
+
91
+ ### Parameters
92
+
93
+ |Name | Type | Description | Notes|
94
+ |------------- | ------------- | ------------- | -------------|
95
+ | **page** | [**number**] | Page number | (optional) defaults to 1|
96
+ | **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
97
+ | **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
98
+ | **search** | [**string**] | Search query | (optional) defaults to undefined|
99
+
100
+
101
+ ### Return type
102
+
103
+ **GetOrganizationLanguageOverrides200Response**
104
+
105
+ ### Authorization
106
+
107
+ [ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
108
+
109
+ ### HTTP request headers
110
+
111
+ - **Content-Type**: Not defined
112
+ - **Accept**: application/json
113
+
114
+
115
+ ### HTTP response details
116
+ | Status code | Description | Response headers |
117
+ |-------------|-------------|------------------|
118
+ |**200** | Successful response | - |
119
+
120
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
121
+
122
+ # **upsertOrganizationLanguageOverride**
123
+ > SyncAccounts200Response upsertOrganizationLanguageOverride(organizationLanguageOverrideUpsertInputs)
124
+
125
+ Upserts the organization\'s i18n string override for a key across all supplied locale values in a single request, requires the update org permission, and refreshes the language overrides list on success.
126
+
127
+ ### Example
128
+
129
+ ```typescript
130
+ import {
131
+ OrganizationLanguageoverridesApi,
132
+ Configuration,
133
+ OrganizationLanguageOverrideUpsertInputs
134
+ } from '@connectedxm/admin-sdk';
135
+
136
+ const configuration = new Configuration();
137
+ const apiInstance = new OrganizationLanguageoverridesApi(configuration);
138
+
139
+ let organizationLanguageOverrideUpsertInputs: OrganizationLanguageOverrideUpsertInputs; //
140
+
141
+ const { status, data } = await apiInstance.upsertOrganizationLanguageOverride(
142
+ organizationLanguageOverrideUpsertInputs
143
+ );
144
+ ```
145
+
146
+ ### Parameters
147
+
148
+ |Name | Type | Description | Notes|
149
+ |------------- | ------------- | ------------- | -------------|
150
+ | **organizationLanguageOverrideUpsertInputs** | **OrganizationLanguageOverrideUpsertInputs**| | |
151
+
152
+
153
+ ### Return type
154
+
155
+ **SyncAccounts200Response**
156
+
157
+ ### Authorization
158
+
159
+ [ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
160
+
161
+ ### HTTP request headers
162
+
163
+ - **Content-Type**: application/json
164
+ - **Accept**: application/json
165
+
166
+
167
+ ### HTTP response details
168
+ | Status code | Description | Response headers |
169
+ |-------------|-------------|------------------|
170
+ |**200** | Successful response | - |
171
+
172
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
173
+
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@connectedxm/admin-sdk",
3
- "version": "7.9.5",
3
+ "version": "7.11.0",
4
4
  "description": "OpenAPI client for @connectedxm/admin-sdk",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {