@flexbe/sdk 0.2.11 → 0.2.13

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