@flexbe/sdk 0.2.11 → 0.2.12

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 (6) hide show
  1. package/dist/browser/client/pages.js +12 -12
  2. package/dist/cjs/client/pages.js +12 -12
  3. package/dist/esm/client/pages.js +12 -12
  4. package/dist/types/client/pages.d.ts +12 -12
  5. package/dist/types/types/pages.d.ts +3 -3
  6. package/package.json +1 -1
package/dist/browser/client/pages.js CHANGED
@@ -79,8 +79,8 @@ export class Pages {
79
79
  * Update a folder's properties
80
80
  * @param id - ID of the folder to update
81
81
  * @param data - Update parameters:
82
- * - title: New title for the folder
83
- * - sortIndex: New position in the folder list
82
+ * - name: New name for the folder (max 50 characters)
83
+ * - sortIndex: New position in the folder list (minimum 0)
84
84
  * @throws {UnauthorizedException} When the API key is invalid or expired
85
85
  * @throws {NotFoundException} When the folder is not found
86
86
  * @throws {ForbiddenException} When the folder does not belong to the site
@@ -97,8 +97,8 @@ export class Pages {
97
97
  /**
98
98
  * Create a new folder
99
99
  * @param data - Create parameters:
100
- * - title: Title of the new folder (required)
101
- * - sortIndex: Position in the folder list (optional)
100
+ * - name: Name of the new folder (required, max 50 characters)
101
+ * - sortIndex: Position in the folder list (optional, minimum 0)
102
102
  * @throws {UnauthorizedException} When the API key is invalid or expired
103
103
  * @throws {ForbiddenException} When the site is not accessible
104
104
  * @throws {BadRequestException} When the create parameters are invalid
@@ -143,18 +143,18 @@ export class Pages {
143
143
  * @param pageId - ID of the page to update
144
144
  * @param data - Update parameters including:
145
145
  * - status: New status for the page
146
- * - name: New name for the page
147
- * - uri: New URI for the page
146
+ * - name: New name for the page (max 150 characters)
147
+ * - uri: New URI for the page (max 255 characters, automatically normalized with leading and trailing slashes)
148
148
  * - language: New language for the page
149
149
  * - folderId: New folder ID for the page
150
150
  * - sortIndex: New position in the page list
151
151
  * - meta: Meta information for the page:
152
- * - title: Page title
153
- * - description: Meta description for SEO
154
- * - keywords: Meta keywords for SEO
152
+ * - title: Page title (max 200 characters)
153
+ * - description: Meta description for SEO (max 1000 characters)
154
+ * - keywords: Meta keywords for SEO (max 1000 characters)
155
155
  * - ogImage: Open Graph image URL for social sharing
156
- * - ogTitle: Open Graph title for social sharing
157
- * - ogDescription: Open Graph description for social sharing
156
+ * - ogTitle: Open Graph title for social sharing (max 200 characters)
157
+ * - ogDescription: Open Graph description for social sharing (max 1000 characters)
158
158
  * - noindex: Whether to prevent search engine indexing
159
159
  * - grid: Grid configuration for the page
160
160
  * @throws {UnauthorizedException} When the API key is invalid or expired
@@ -200,7 +200,7 @@ export class Pages {
200
200
  * Bulk update multiple folders
201
201
  * @param updates - Array of folder updates, each containing:
202
202
  * - folderId: ID of the folder to update
203
- * - title: New title for the folder
203
+ * - name: New name for the folder
204
204
  * - sortIndex: New position in the folder list
205
205
  * @returns Object containing:
206
206
  * - updated: Array of successfully updated folders
package/dist/cjs/client/pages.js CHANGED
@@ -69,8 +69,8 @@ class Pages {
69
69
  * Update a folder's properties
70
70
  * @param id - ID of the folder to update
71
71
  * @param data - Update parameters:
72
- * - title: New title for the folder
73
- * - sortIndex: New position in the folder list
72
+ * - name: New name for the folder (max 50 characters)
73
+ * - sortIndex: New position in the folder list (minimum 0)
74
74
  * @throws {UnauthorizedException} When the API key is invalid or expired
75
75
  * @throws {NotFoundException} When the folder is not found
76
76
  * @throws {ForbiddenException} When the folder does not belong to the site
@@ -85,8 +85,8 @@ class Pages {
85
85
  /**
86
86
  * Create a new folder
87
87
  * @param data - Create parameters:
88
- * - title: Title of the new folder (required)
89
- * - sortIndex: Position in the folder list (optional)
88
+ * - name: Name of the new folder (required, max 50 characters)
89
+ * - sortIndex: Position in the folder list (optional, minimum 0)
90
90
  * @throws {UnauthorizedException} When the API key is invalid or expired
91
91
  * @throws {ForbiddenException} When the site is not accessible
92
92
  * @throws {BadRequestException} When the create parameters are invalid
@@ -125,18 +125,18 @@ class Pages {
125
125
  * @param pageId - ID of the page to update
126
126
  * @param data - Update parameters including:
127
127
  * - status: New status for the page
128
- * - name: New name for the page
129
- * - uri: New URI for the page
128
+ * - name: New name for the page (max 150 characters)
129
+ * - uri: New URI for the page (max 255 characters, automatically normalized with leading and trailing slashes)
130
130
  * - language: New language for the page
131
131
  * - folderId: New folder ID for the page
132
132
  * - sortIndex: New position in the page list
133
133
  * - meta: Meta information for the page:
134
- * - title: Page title
135
- * - description: Meta description for SEO
136
- * - keywords: Meta keywords for SEO
134
+ * - title: Page title (max 200 characters)
135
+ * - description: Meta description for SEO (max 1000 characters)
136
+ * - keywords: Meta keywords for SEO (max 1000 characters)
137
137
  * - ogImage: Open Graph image URL for social sharing
138
- * - ogTitle: Open Graph title for social sharing
139
- * - ogDescription: Open Graph description for social sharing
138
+ * - ogTitle: Open Graph title for social sharing (max 200 characters)
139
+ * - ogDescription: Open Graph description for social sharing (max 1000 characters)
140
140
  * - noindex: Whether to prevent search engine indexing
141
141
  * - grid: Grid configuration for the page
142
142
  * @throws {UnauthorizedException} When the API key is invalid or expired
@@ -178,7 +178,7 @@ class Pages {
178
178
  * Bulk update multiple folders
179
179
  * @param updates - Array of folder updates, each containing:
180
180
  * - folderId: ID of the folder to update
181
- * - title: New title for the folder
181
+ * - name: New name for the folder
182
182
  * - sortIndex: New position in the folder list
183
183
  * @returns Object containing:
184
184
  * - updated: Array of successfully updated folders
package/dist/esm/client/pages.js CHANGED
@@ -66,8 +66,8 @@ export class Pages {
66
66
  * Update a folder's properties
67
67
  * @param id - ID of the folder to update
68
68
  * @param data - Update parameters:
69
- * - title: New title for the folder
70
- * - sortIndex: New position in the folder list
69
+ * - name: New name for the folder (max 50 characters)
70
+ * - sortIndex: New position in the folder list (minimum 0)
71
71
  * @throws {UnauthorizedException} When the API key is invalid or expired
72
72
  * @throws {NotFoundException} When the folder is not found
73
73
  * @throws {ForbiddenException} When the folder does not belong to the site
@@ -82,8 +82,8 @@ export class Pages {
82
82
  /**
83
83
  * Create a new folder
84
84
  * @param data - Create parameters:
85
- * - title: Title of the new folder (required)
86
- * - sortIndex: Position in the folder list (optional)
85
+ * - name: Name of the new folder (required, max 50 characters)
86
+ * - sortIndex: Position in the folder list (optional, minimum 0)
87
87
  * @throws {UnauthorizedException} When the API key is invalid or expired
88
88
  * @throws {ForbiddenException} When the site is not accessible
89
89
  * @throws {BadRequestException} When the create parameters are invalid
@@ -122,18 +122,18 @@ export class Pages {
122
122
  * @param pageId - ID of the page to update
123
123
  * @param data - Update parameters including:
124
124
  * - status: New status for the page
125
- * - name: New name for the page
126
- * - uri: New URI for the page
125
+ * - name: New name for the page (max 150 characters)
126
+ * - uri: New URI for the page (max 255 characters, automatically normalized with leading and trailing slashes)
127
127
  * - language: New language for the page
128
128
  * - folderId: New folder ID for the page
129
129
  * - sortIndex: New position in the page list
130
130
  * - meta: Meta information for the page:
131
- * - title: Page title
132
- * - description: Meta description for SEO
133
- * - keywords: Meta keywords for SEO
131
+ * - title: Page title (max 200 characters)
132
+ * - description: Meta description for SEO (max 1000 characters)
133
+ * - keywords: Meta keywords for SEO (max 1000 characters)
134
134
  * - ogImage: Open Graph image URL for social sharing
135
- * - ogTitle: Open Graph title for social sharing
136
- * - ogDescription: Open Graph description for social sharing
135
+ * - ogTitle: Open Graph title for social sharing (max 200 characters)
136
+ * - ogDescription: Open Graph description for social sharing (max 1000 characters)
137
137
  * - noindex: Whether to prevent search engine indexing
138
138
  * - grid: Grid configuration for the page
139
139
  * @throws {UnauthorizedException} When the API key is invalid or expired
@@ -175,7 +175,7 @@ export class Pages {
175
175
  * Bulk update multiple folders
176
176
  * @param updates - Array of folder updates, each containing:
177
177
  * - folderId: ID of the folder to update
178
- * - title: New title for the folder
178
+ * - name: New name for the folder
179
179
  * - sortIndex: New position in the folder list
180
180
  * @returns Object containing:
181
181
  * - updated: Array of successfully updated folders
package/dist/types/client/pages.d.ts CHANGED
@@ -50,8 +50,8 @@ export declare class Pages {
50
50
  * Update a folder's properties
51
51
  * @param id - ID of the folder to update
52
52
  * @param data - Update parameters:
53
- * - title: New title for the folder
54
- * - sortIndex: New position in the folder list
53
+ * - name: New name for the folder (max 50 characters)
54
+ * - sortIndex: New position in the folder list (minimum 0)
55
55
  * @throws {UnauthorizedException} When the API key is invalid or expired
56
56
  * @throws {NotFoundException} When the folder is not found
57
57
  * @throws {ForbiddenException} When the folder does not belong to the site
@@ -63,8 +63,8 @@ export declare class Pages {
63
63
  /**
64
64
  * Create a new folder
65
65
  * @param data - Create parameters:
66
- * - title: Title of the new folder (required)
67
- * - sortIndex: Position in the folder list (optional)
66
+ * - name: Name of the new folder (required, max 50 characters)
67
+ * - sortIndex: Position in the folder list (optional, minimum 0)
68
68
  * @throws {UnauthorizedException} When the API key is invalid or expired
69
69
  * @throws {ForbiddenException} When the site is not accessible
70
70
  * @throws {BadRequestException} When the create parameters are invalid
@@ -96,18 +96,18 @@ export declare class Pages {
96
96
  * @param pageId - ID of the page to update
97
97
  * @param data - Update parameters including:
98
98
  * - status: New status for the page
99
- * - name: New name for the page
100
- * - uri: New URI for the page
99
+ * - name: New name for the page (max 150 characters)
100
+ * - uri: New URI for the page (max 255 characters, automatically normalized with leading and trailing slashes)
101
101
  * - language: New language for the page
102
102
  * - folderId: New folder ID for the page
103
103
  * - sortIndex: New position in the page list
104
104
  * - meta: Meta information for the page:
105
- * - title: Page title
106
- * - description: Meta description for SEO
107
- * - keywords: Meta keywords for SEO
105
+ * - title: Page title (max 200 characters)
106
+ * - description: Meta description for SEO (max 1000 characters)
107
+ * - keywords: Meta keywords for SEO (max 1000 characters)
108
108
  * - ogImage: Open Graph image URL for social sharing
109
- * - ogTitle: Open Graph title for social sharing
110
- * - ogDescription: Open Graph description for social sharing
109
+ * - ogTitle: Open Graph title for social sharing (max 200 characters)
110
+ * - ogDescription: Open Graph description for social sharing (max 1000 characters)
111
111
  * - noindex: Whether to prevent search engine indexing
112
112
  * - grid: Grid configuration for the page
113
113
  * @throws {UnauthorizedException} When the API key is invalid or expired
@@ -143,7 +143,7 @@ export declare class Pages {
143
143
  * Bulk update multiple folders
144
144
  * @param updates - Array of folder updates, each containing:
145
145
  * - folderId: ID of the folder to update
146
- * - title: New title for the folder
146
+ * - name: New name for the folder
147
147
  * - sortIndex: New position in the folder list
148
148
  * @returns Object containing:
149
149
  * - updated: Array of successfully updated folders
package/dist/types/types/pages.d.ts CHANGED
@@ -71,18 +71,18 @@ export interface PageListResponse {
71
71
  }
72
72
  export interface PageFolder {
73
73
  id: number;
74
- title: string;
74
+ name: string;
75
75
  sortIndex: number;
76
76
  }
77
77
  export interface PageFolderListResponse {
78
78
  list: PageFolder[];
79
79
  }
80
80
  export interface UpdateFolderParams {
81
- title?: string;
81
+ name?: string;
82
82
  sortIndex?: number;
83
83
  }
84
84
  export interface CreateFolderParams {
85
- title: string;
85
+ name: string;
86
86
  sortIndex?: number;
87
87
  }
88
88
  export interface UpdatePageParams {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@flexbe/sdk",
3
- "version": "0.2.11",
3
+ "version": "0.2.12",
4
4
  "description": "TypeScript SDK for Flexbe API",
5
5
  "main": "dist/cjs/index.js",
6
6
  "module": "dist/esm/index.js",