featurebase-node 0.3.0 → 0.4.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.
- package/CHANGELOG.md +9 -0
- package/README.md +31 -0
- package/client.d.mts +12 -6
- package/client.d.mts.map +1 -1
- package/client.d.ts +12 -6
- package/client.d.ts.map +1 -1
- package/client.js +10 -0
- package/client.js.map +1 -1
- package/client.mjs +10 -0
- package/client.mjs.map +1 -1
- package/core/pagination.d.mts +54 -0
- package/core/pagination.d.mts.map +1 -0
- package/core/pagination.d.ts +54 -0
- package/core/pagination.d.ts.map +1 -0
- package/core/pagination.js +101 -0
- package/core/pagination.js.map +1 -0
- package/core/pagination.mjs +95 -0
- package/core/pagination.mjs.map +1 -0
- package/index.d.mts +1 -0
- package/index.d.mts.map +1 -1
- package/index.d.ts +1 -0
- package/index.d.ts.map +1 -1
- package/index.js +3 -1
- package/index.js.map +1 -1
- package/index.mjs +1 -0
- package/index.mjs.map +1 -1
- package/package.json +11 -1
- package/pagination.d.mts +2 -0
- package/pagination.d.mts.map +1 -0
- package/pagination.d.ts +2 -0
- package/pagination.d.ts.map +1 -0
- package/pagination.js +6 -0
- package/pagination.js.map +1 -0
- package/pagination.mjs +2 -0
- package/pagination.mjs.map +1 -0
- package/resources/changelogs/changelogs.d.mts +9 -53
- package/resources/changelogs/changelogs.d.mts.map +1 -1
- package/resources/changelogs/changelogs.d.ts +9 -53
- package/resources/changelogs/changelogs.d.ts.map +1 -1
- package/resources/changelogs/changelogs.js +6 -2
- package/resources/changelogs/changelogs.js.map +1 -1
- package/resources/changelogs/changelogs.mjs +6 -2
- package/resources/changelogs/changelogs.mjs.map +1 -1
- package/resources/changelogs/index.d.mts +1 -1
- package/resources/changelogs/index.d.mts.map +1 -1
- package/resources/changelogs/index.d.ts +1 -1
- package/resources/changelogs/index.d.ts.map +1 -1
- package/resources/feedback/comments.d.mts +9 -53
- package/resources/feedback/comments.d.mts.map +1 -1
- package/resources/feedback/comments.d.ts +9 -53
- package/resources/feedback/comments.d.ts.map +1 -1
- package/resources/feedback/comments.js +6 -2
- package/resources/feedback/comments.js.map +1 -1
- package/resources/feedback/comments.mjs +6 -2
- package/resources/feedback/comments.mjs.map +1 -1
- package/resources/feedback/feedback.d.mts +4 -4
- package/resources/feedback/feedback.d.mts.map +1 -1
- package/resources/feedback/feedback.d.ts +4 -4
- package/resources/feedback/feedback.d.ts.map +1 -1
- package/resources/feedback/feedback.mjs.map +1 -1
- package/resources/feedback/index.d.mts +2 -2
- package/resources/feedback/index.d.mts.map +1 -1
- package/resources/feedback/index.d.ts +2 -2
- package/resources/feedback/index.d.ts.map +1 -1
- package/resources/feedback/posts/index.d.mts +2 -2
- package/resources/feedback/posts/index.d.mts.map +1 -1
- package/resources/feedback/posts/index.d.ts +2 -2
- package/resources/feedback/posts/index.d.ts.map +1 -1
- package/resources/feedback/posts/index.js.map +1 -1
- package/resources/feedback/posts/index.mjs.map +1 -1
- package/resources/feedback/posts/posts.d.mts +11 -56
- package/resources/feedback/posts/posts.d.mts.map +1 -1
- package/resources/feedback/posts/posts.d.ts +11 -56
- package/resources/feedback/posts/posts.d.ts.map +1 -1
- package/resources/feedback/posts/posts.js +6 -2
- package/resources/feedback/posts/posts.js.map +1 -1
- package/resources/feedback/posts/posts.mjs +6 -2
- package/resources/feedback/posts/posts.mjs.map +1 -1
- package/resources/feedback/posts/voters.d.mts +79 -124
- package/resources/feedback/posts/voters.d.mts.map +1 -1
- package/resources/feedback/posts/voters.d.ts +79 -124
- package/resources/feedback/posts/voters.d.ts.map +1 -1
- package/resources/feedback/posts/voters.js +7 -3
- package/resources/feedback/posts/voters.js.map +1 -1
- package/resources/feedback/posts/voters.mjs +7 -3
- package/resources/feedback/posts/voters.mjs.map +1 -1
- package/resources/help-center/articles.d.mts +9 -27
- package/resources/help-center/articles.d.mts.map +1 -1
- package/resources/help-center/articles.d.ts +9 -27
- package/resources/help-center/articles.d.ts.map +1 -1
- package/resources/help-center/articles.js +6 -2
- package/resources/help-center/articles.js.map +1 -1
- package/resources/help-center/articles.mjs +6 -2
- package/resources/help-center/articles.mjs.map +1 -1
- package/resources/help-center/collections.d.mts +9 -28
- package/resources/help-center/collections.d.mts.map +1 -1
- package/resources/help-center/collections.d.ts +9 -28
- package/resources/help-center/collections.d.ts.map +1 -1
- package/resources/help-center/collections.js +6 -3
- package/resources/help-center/collections.js.map +1 -1
- package/resources/help-center/collections.mjs +6 -3
- package/resources/help-center/collections.mjs.map +1 -1
- package/resources/help-center/help-center.d.mts +8 -8
- package/resources/help-center/help-center.d.mts.map +1 -1
- package/resources/help-center/help-center.d.ts +8 -8
- package/resources/help-center/help-center.d.ts.map +1 -1
- package/resources/help-center/help-center.mjs.map +1 -1
- package/resources/help-center/help-centers.d.mts +9 -28
- package/resources/help-center/help-centers.d.mts.map +1 -1
- package/resources/help-center/help-centers.d.ts +9 -28
- package/resources/help-center/help-centers.d.ts.map +1 -1
- package/resources/help-center/help-centers.js +6 -3
- package/resources/help-center/help-centers.js.map +1 -1
- package/resources/help-center/help-centers.mjs +6 -3
- package/resources/help-center/help-centers.mjs.map +1 -1
- package/resources/help-center/index.d.mts +4 -4
- package/resources/help-center/index.d.mts.map +1 -1
- package/resources/help-center/index.d.ts +4 -4
- package/resources/help-center/index.d.ts.map +1 -1
- package/resources/help-center/redirect-rules.d.mts +9 -28
- package/resources/help-center/redirect-rules.d.mts.map +1 -1
- package/resources/help-center/redirect-rules.d.ts +9 -28
- package/resources/help-center/redirect-rules.d.ts.map +1 -1
- package/resources/help-center/redirect-rules.js +6 -3
- package/resources/help-center/redirect-rules.js.map +1 -1
- package/resources/help-center/redirect-rules.mjs +6 -3
- package/resources/help-center/redirect-rules.mjs.map +1 -1
- package/resources/index.d.mts +3 -3
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +3 -3
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs.map +1 -1
- package/resources/organization/brands.d.mts +5 -26
- package/resources/organization/brands.d.mts.map +1 -1
- package/resources/organization/brands.d.ts +5 -26
- package/resources/organization/brands.d.ts.map +1 -1
- package/resources/organization/brands.js +2 -1
- package/resources/organization/brands.js.map +1 -1
- package/resources/organization/brands.mjs +2 -1
- package/resources/organization/brands.mjs.map +1 -1
- package/resources/organization/index.d.mts +1 -1
- package/resources/organization/index.d.mts.map +1 -1
- package/resources/organization/index.d.ts +1 -1
- package/resources/organization/index.d.ts.map +1 -1
- package/resources/organization/organization.d.mts +2 -2
- package/resources/organization/organization.d.mts.map +1 -1
- package/resources/organization/organization.d.ts +2 -2
- package/resources/organization/organization.d.ts.map +1 -1
- package/resources/organization/organization.js.map +1 -1
- package/resources/organization/organization.mjs.map +1 -1
- package/resources/support/conversations/conversations.d.mts +9 -28
- package/resources/support/conversations/conversations.d.mts.map +1 -1
- package/resources/support/conversations/conversations.d.ts +9 -28
- package/resources/support/conversations/conversations.d.ts.map +1 -1
- package/resources/support/conversations/conversations.js +6 -3
- package/resources/support/conversations/conversations.js.map +1 -1
- package/resources/support/conversations/conversations.mjs +6 -3
- package/resources/support/conversations/conversations.mjs.map +1 -1
- package/resources/support/conversations/index.d.mts +1 -1
- package/resources/support/conversations/index.d.mts.map +1 -1
- package/resources/support/conversations/index.d.ts +1 -1
- package/resources/support/conversations/index.d.ts.map +1 -1
- package/resources/support/index.d.mts +2 -2
- package/resources/support/index.d.mts.map +1 -1
- package/resources/support/index.d.ts +2 -2
- package/resources/support/index.d.ts.map +1 -1
- package/resources/support/support.d.mts +4 -4
- package/resources/support/support.d.mts.map +1 -1
- package/resources/support/support.d.ts +4 -4
- package/resources/support/support.d.ts.map +1 -1
- package/resources/support/support.mjs.map +1 -1
- package/resources/support/tickets/index.d.mts +1 -1
- package/resources/support/tickets/index.d.mts.map +1 -1
- package/resources/support/tickets/index.d.ts +1 -1
- package/resources/support/tickets/index.d.ts.map +1 -1
- package/resources/support/tickets/tickets.d.mts +9 -27
- package/resources/support/tickets/tickets.d.mts.map +1 -1
- package/resources/support/tickets/tickets.d.ts +9 -27
- package/resources/support/tickets/tickets.d.ts.map +1 -1
- package/resources/support/tickets/tickets.js +6 -2
- package/resources/support/tickets/tickets.js.map +1 -1
- package/resources/support/tickets/tickets.mjs +6 -2
- package/resources/support/tickets/tickets.mjs.map +1 -1
- package/resources/surveys.d.mts +34 -79
- package/resources/surveys.d.mts.map +1 -1
- package/resources/surveys.d.ts +34 -79
- package/resources/surveys.d.ts.map +1 -1
- package/resources/surveys.js +4 -3
- package/resources/surveys.js.map +1 -1
- package/resources/surveys.mjs +4 -3
- package/resources/surveys.mjs.map +1 -1
- package/resources/users/companies/companies.d.mts +9 -28
- package/resources/users/companies/companies.d.mts.map +1 -1
- package/resources/users/companies/companies.d.ts +9 -28
- package/resources/users/companies/companies.d.ts.map +1 -1
- package/resources/users/companies/companies.js +6 -2
- package/resources/users/companies/companies.js.map +1 -1
- package/resources/users/companies/companies.mjs +6 -2
- package/resources/users/companies/companies.mjs.map +1 -1
- package/resources/users/companies/contacts.d.mts +11 -16
- package/resources/users/companies/contacts.d.mts.map +1 -1
- package/resources/users/companies/contacts.d.ts +11 -16
- package/resources/users/companies/contacts.d.ts.map +1 -1
- package/resources/users/companies/contacts.js +8 -5
- package/resources/users/companies/contacts.js.map +1 -1
- package/resources/users/companies/contacts.mjs +8 -5
- package/resources/users/companies/contacts.mjs.map +1 -1
- package/resources/users/companies/index.d.mts +1 -1
- package/resources/users/companies/index.d.mts.map +1 -1
- package/resources/users/companies/index.d.ts +1 -1
- package/resources/users/companies/index.d.ts.map +1 -1
- package/resources/users/contacts/contacts.d.mts +9 -13
- package/resources/users/contacts/contacts.d.mts.map +1 -1
- package/resources/users/contacts/contacts.d.ts +9 -13
- package/resources/users/contacts/contacts.d.ts.map +1 -1
- package/resources/users/contacts/contacts.js +6 -2
- package/resources/users/contacts/contacts.js.map +1 -1
- package/resources/users/contacts/contacts.mjs +6 -2
- package/resources/users/contacts/contacts.mjs.map +1 -1
- package/resources/users/contacts/index.d.mts +1 -1
- package/resources/users/contacts/index.d.mts.map +1 -1
- package/resources/users/contacts/index.d.ts +1 -1
- package/resources/users/contacts/index.d.ts.map +1 -1
- package/resources/users/contacts/index.js.map +1 -1
- package/resources/users/contacts/index.mjs.map +1 -1
- package/resources/users/index.d.mts +2 -2
- package/resources/users/index.d.mts.map +1 -1
- package/resources/users/index.d.ts +2 -2
- package/resources/users/index.d.ts.map +1 -1
- package/resources/users/index.js.map +1 -1
- package/resources/users/index.mjs.map +1 -1
- package/resources/users/users.d.mts +4 -4
- package/resources/users/users.d.mts.map +1 -1
- package/resources/users/users.d.ts +4 -4
- package/resources/users/users.d.ts.map +1 -1
- package/resources/users/users.js.map +1 -1
- package/resources/users/users.mjs.map +1 -1
- package/resources/webhooks.d.mts +9 -27
- package/resources/webhooks.d.mts.map +1 -1
- package/resources/webhooks.d.ts +9 -27
- package/resources/webhooks.d.ts.map +1 -1
- package/resources/webhooks.js +6 -2
- package/resources/webhooks.js.map +1 -1
- package/resources/webhooks.mjs +6 -2
- package/resources/webhooks.mjs.map +1 -1
- package/src/client.ts +41 -10
- package/src/core/pagination.ts +157 -0
- package/src/index.ts +1 -0
- package/src/pagination.ts +2 -0
- package/src/resources/changelogs/changelogs.ts +11 -64
- package/src/resources/changelogs/index.ts +1 -1
- package/src/resources/feedback/comments.ts +11 -64
- package/src/resources/feedback/feedback.ts +4 -4
- package/src/resources/feedback/index.ts +2 -2
- package/src/resources/feedback/posts/index.ts +2 -1
- package/src/resources/feedback/posts/posts.ts +13 -65
- package/src/resources/feedback/posts/voters.ts +87 -140
- package/src/resources/help-center/articles.ts +11 -33
- package/src/resources/help-center/collections.ts +11 -34
- package/src/resources/help-center/help-center.ts +8 -8
- package/src/resources/help-center/help-centers.ts +11 -34
- package/src/resources/help-center/index.ts +4 -4
- package/src/resources/help-center/redirect-rules.ts +11 -34
- package/src/resources/index.ts +6 -5
- package/src/resources/organization/brands.ts +7 -32
- package/src/resources/organization/index.ts +1 -1
- package/src/resources/organization/organization.ts +2 -2
- package/src/resources/support/conversations/conversations.ts +11 -34
- package/src/resources/support/conversations/index.ts +1 -1
- package/src/resources/support/index.ts +2 -2
- package/src/resources/support/support.ts +4 -4
- package/src/resources/support/tickets/index.ts +1 -1
- package/src/resources/support/tickets/tickets.ts +11 -33
- package/src/resources/surveys.ts +54 -102
- package/src/resources/users/companies/companies.ts +11 -34
- package/src/resources/users/companies/contacts.ts +24 -26
- package/src/resources/users/companies/index.ts +1 -1
- package/src/resources/users/contacts/contacts.ts +14 -15
- package/src/resources/users/contacts/index.ts +1 -0
- package/src/resources/users/index.ts +2 -1
- package/src/resources/users/users.ts +4 -2
- package/src/resources/webhooks.ts +11 -33
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
package/resources/surveys.d.mts
CHANGED
|
@@ -2,6 +2,7 @@ import { APIResource } from "../core/resource.mjs";
|
|
|
2
2
|
import * as SurveysAPI from "./surveys.mjs";
|
|
3
3
|
import * as ContactsAPI from "./users/contacts/contacts.mjs";
|
|
4
4
|
import { APIPromise } from "../core/api-promise.mjs";
|
|
5
|
+
import { CursorPage, type CursorPageParams, PagePromise } from "../core/pagination.mjs";
|
|
5
6
|
import { RequestOptions } from "../internal/request-options.mjs";
|
|
6
7
|
/**
|
|
7
8
|
* Surveys allow you to collect targeted feedback from your users within your product. Surveys can be targeted to specific user segments or pages and can contain multiple questions with conditional logic.
|
|
@@ -73,7 +74,7 @@ export declare class Surveys extends APIResource {
|
|
|
73
74
|
* - `createdAt` - ISO 8601 timestamp when created
|
|
74
75
|
* - `updatedAt` - ISO 8601 timestamp when last updated
|
|
75
76
|
*/
|
|
76
|
-
list(params?: SurveyListParams | null | undefined, options?: RequestOptions):
|
|
77
|
+
list(params?: SurveyListParams | null | undefined, options?: RequestOptions): PagePromise<SurveysCursorPage, Survey>;
|
|
77
78
|
/**
|
|
78
79
|
* Retrieves all user responses for a specific survey.
|
|
79
80
|
*
|
|
@@ -112,8 +113,10 @@ export declare class Surveys extends APIResource {
|
|
|
112
113
|
*
|
|
113
114
|
* - `404` - Survey not found in your organization
|
|
114
115
|
*/
|
|
115
|
-
|
|
116
|
+
listResponses(id: string, params?: SurveyListResponsesParams | null | undefined, options?: RequestOptions): PagePromise<SurveyListResponsesResponsesCursorPage, SurveyListResponsesResponse>;
|
|
116
117
|
}
|
|
118
|
+
export type SurveysCursorPage = CursorPage<Survey>;
|
|
119
|
+
export type SurveyListResponsesResponsesCursorPage = CursorPage<SurveyListResponsesResponse>;
|
|
117
120
|
export interface Survey {
|
|
118
121
|
/**
|
|
119
122
|
* Unique identifier
|
|
@@ -314,84 +317,54 @@ export interface SurveyNextAction {
|
|
|
314
317
|
*/
|
|
315
318
|
pageId?: string;
|
|
316
319
|
}
|
|
317
|
-
export interface
|
|
320
|
+
export interface SurveyListResponsesResponse {
|
|
318
321
|
/**
|
|
319
|
-
*
|
|
322
|
+
* Unique identifier
|
|
320
323
|
*/
|
|
321
|
-
|
|
324
|
+
id: string;
|
|
322
325
|
/**
|
|
323
|
-
*
|
|
326
|
+
* ISO 8601 timestamp when created
|
|
324
327
|
*/
|
|
325
|
-
|
|
328
|
+
createdAt: string;
|
|
326
329
|
/**
|
|
327
330
|
* Object type identifier
|
|
328
331
|
*/
|
|
329
|
-
object: '
|
|
330
|
-
}
|
|
331
|
-
export interface SurveyRetrieveResponsesResponse {
|
|
332
|
-
/**
|
|
333
|
-
* Array of survey responses
|
|
334
|
-
*/
|
|
335
|
-
data: Array<SurveyRetrieveResponsesResponse.Data>;
|
|
332
|
+
object: 'survey_response';
|
|
336
333
|
/**
|
|
337
|
-
*
|
|
334
|
+
* Individual responses to questions
|
|
338
335
|
*/
|
|
339
|
-
|
|
336
|
+
responses: Array<SurveyListResponsesResponse.Response>;
|
|
340
337
|
/**
|
|
341
|
-
*
|
|
338
|
+
* User who submitted the response
|
|
342
339
|
*/
|
|
343
|
-
|
|
340
|
+
user: ContactsAPI.Contact | null;
|
|
344
341
|
}
|
|
345
|
-
export declare namespace
|
|
346
|
-
interface
|
|
342
|
+
export declare namespace SurveyListResponsesResponse {
|
|
343
|
+
interface Response {
|
|
347
344
|
/**
|
|
348
|
-
*
|
|
345
|
+
* Page ID this response is for
|
|
349
346
|
*/
|
|
350
|
-
|
|
347
|
+
pageId: string;
|
|
351
348
|
/**
|
|
352
|
-
*
|
|
349
|
+
* Response type
|
|
353
350
|
*/
|
|
354
|
-
|
|
351
|
+
type: 'text' | 'link' | 'rating' | 'multiple-choice';
|
|
355
352
|
/**
|
|
356
|
-
*
|
|
353
|
+
* Response value
|
|
357
354
|
*/
|
|
358
|
-
|
|
355
|
+
value: string | number | boolean | Array<string>;
|
|
359
356
|
/**
|
|
360
|
-
*
|
|
357
|
+
* Response ID
|
|
361
358
|
*/
|
|
362
|
-
|
|
359
|
+
id?: string;
|
|
363
360
|
/**
|
|
364
|
-
*
|
|
361
|
+
* ISO 8601 timestamp when created
|
|
365
362
|
*/
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
* Page ID this response is for
|
|
372
|
-
*/
|
|
373
|
-
pageId: string;
|
|
374
|
-
/**
|
|
375
|
-
* Response type
|
|
376
|
-
*/
|
|
377
|
-
type: 'text' | 'link' | 'rating' | 'multiple-choice';
|
|
378
|
-
/**
|
|
379
|
-
* Response value
|
|
380
|
-
*/
|
|
381
|
-
value: string | number | boolean | Array<string>;
|
|
382
|
-
/**
|
|
383
|
-
* Response ID
|
|
384
|
-
*/
|
|
385
|
-
id?: string;
|
|
386
|
-
/**
|
|
387
|
-
* ISO 8601 timestamp when created
|
|
388
|
-
*/
|
|
389
|
-
createdAt?: string;
|
|
390
|
-
/**
|
|
391
|
-
* ISO 8601 timestamp when updated
|
|
392
|
-
*/
|
|
393
|
-
updatedAt?: string;
|
|
394
|
-
}
|
|
363
|
+
createdAt?: string;
|
|
364
|
+
/**
|
|
365
|
+
* ISO 8601 timestamp when updated
|
|
366
|
+
*/
|
|
367
|
+
updatedAt?: string;
|
|
395
368
|
}
|
|
396
369
|
}
|
|
397
370
|
export interface SurveyRetrieveParams {
|
|
@@ -401,20 +374,11 @@ export interface SurveyRetrieveParams {
|
|
|
401
374
|
*/
|
|
402
375
|
'Featurebase-Version'?: string;
|
|
403
376
|
}
|
|
404
|
-
export interface SurveyListParams {
|
|
405
|
-
/**
|
|
406
|
-
* Query param: An opaque cursor for pagination. Use the nextCursor value from a
|
|
407
|
-
* previous response to fetch the next page.
|
|
408
|
-
*/
|
|
409
|
-
cursor?: string;
|
|
377
|
+
export interface SurveyListParams extends CursorPageParams {
|
|
410
378
|
/**
|
|
411
379
|
* Query param: Filter by active status
|
|
412
380
|
*/
|
|
413
381
|
isActive?: boolean | null;
|
|
414
|
-
/**
|
|
415
|
-
* Query param: A limit on the number of objects to be returned, between 1 and 100.
|
|
416
|
-
*/
|
|
417
|
-
limit?: number;
|
|
418
382
|
/**
|
|
419
383
|
* Query param: Filter by survey page type
|
|
420
384
|
*/
|
|
@@ -425,16 +389,7 @@ export interface SurveyListParams {
|
|
|
425
389
|
*/
|
|
426
390
|
'Featurebase-Version'?: string;
|
|
427
391
|
}
|
|
428
|
-
export interface
|
|
429
|
-
/**
|
|
430
|
-
* Query param: An opaque cursor for pagination. Use the nextCursor value from a
|
|
431
|
-
* previous response to fetch the next page.
|
|
432
|
-
*/
|
|
433
|
-
cursor?: string;
|
|
434
|
-
/**
|
|
435
|
-
* Query param: A limit on the number of objects to be returned, between 1 and 100.
|
|
436
|
-
*/
|
|
437
|
-
limit?: number;
|
|
392
|
+
export interface SurveyListResponsesParams extends CursorPageParams {
|
|
438
393
|
/**
|
|
439
394
|
* Query param: Filter by survey page ID
|
|
440
395
|
*/
|
|
@@ -446,6 +401,6 @@ export interface SurveyRetrieveResponsesParams {
|
|
|
446
401
|
'Featurebase-Version'?: string;
|
|
447
402
|
}
|
|
448
403
|
export declare namespace Surveys {
|
|
449
|
-
export { type Survey as Survey, type SurveyNextAction as SurveyNextAction, type
|
|
404
|
+
export { type Survey as Survey, type SurveyNextAction as SurveyNextAction, type SurveyListResponsesResponse as SurveyListResponsesResponse, type SurveysCursorPage as SurveysCursorPage, type SurveyListResponsesResponsesCursorPage as SurveyListResponsesResponsesCursorPage, type SurveyRetrieveParams as SurveyRetrieveParams, type SurveyListParams as SurveyListParams, type SurveyListResponsesParams as SurveyListResponsesParams, };
|
|
450
405
|
}
|
|
451
406
|
//# sourceMappingURL=surveys.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"surveys.d.mts","sourceRoot":"","sources":["../src/resources/surveys.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,KAAK,WAAW;OAChB,EAAE,UAAU,EAAE;
|
|
1
|
+
{"version":3,"file":"surveys.d.mts","sourceRoot":"","sources":["../src/resources/surveys.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,KAAK,WAAW;OAChB,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAElD,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC;IAWrB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,IAAI,CACF,MAAM,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,iBAAiB,EAAE,MAAM,CAAC;IAYzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,aAAa,CACX,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,yBAAyB,GAAG,IAAI,GAAG,SAAc,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,sCAAsC,EAAE,2BAA2B,CAAC;CAepF;AAED,MAAM,MAAM,iBAAiB,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC;AAEnD,MAAM,MAAM,sCAAsC,GAAG,UAAU,CAAC,2BAA2B,CAAC,CAAC;AAE7F,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,MAAM,EAAE,QAAQ,CAAC;IAEjB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAE1B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,SAAS,CAAC;CAC9B;AAED,yBAAiB,MAAM,CAAC;IACtB,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,QAAQ,GAAG,iBAAiB,CAAC;QAErD;;WAEG;QACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;QAE9B;;WAEG;QACH,OAAO,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAE7B;;WAEG;QACH,aAAa,CAAC,EAAE,UAAU,CAAC,gBAAgB,CAAC;QAE5C;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,UAAU,CAAC,EAAE,QAAQ,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,CAAC;QAErD;;WAEG;QACH,KAAK,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAE1B;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,OAAO,CAAC,EAAE,QAAQ,GAAG,OAAO,GAAG,SAAS,GAAG,mBAAmB,GAAG,KAAK,CAAC;KACxE;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,MAAM;YACrB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,MAAM,CAAC,EAAE,MAAM,CAAC;SACjB;QAED,UAAiB,KAAK;YACpB;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,IAAI,EAAE,UAAU,CAAC,gBAAgB,CAAC;YAElC;;eAEG;YACH,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;YAEvC;;eAEG;YACH,EAAE,CAAC,EAAE,MAAM,CAAC;SACb;KACF;IAED;;OAEG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,GAAG,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QAE3B;;WAEG;QACH,aAAa,CAAC,EAAE,OAAO,CAAC;QAExB;;WAEG;QACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE3B;;WAEG;QACH,GAAG,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;KAC5B;IAED,UAAiB,SAAS,CAAC;QACzB,UAAiB,GAAG;YAClB;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;SACf;QAED,UAAiB,GAAG;YAClB;;eAEG;YACH,SAAS,EAAE,OAAO,GAAG,UAAU,GAAG,OAAO,CAAC;YAE1C;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,EAAE,CAAC,EAAE,MAAM,CAAC;SACb;KACF;CACF;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,KAAK,GAAG,MAAM,CAAC;IAE9B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,MAAM,EAAE,iBAAiB,CAAC;IAE1B;;OAEG;IACH,SAAS,EAAE,KAAK,CAAC,2BAA2B,CAAC,QAAQ,CAAC,CAAC;IAEvD;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC,OAAO,GAAG,IAAI,CAAC;CAClC;AAED,yBAAiB,2BAA2B,CAAC;IAC3C,UAAiB,QAAQ;QACvB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,QAAQ,GAAG,iBAAiB,CAAC;QAErD;;WAEG;QACH,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;QAEjD;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,gBAAiB,SAAQ,gBAAgB;IACxD;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,QAAQ,GAAG,iBAAiB,CAAC;IAEtD;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,yBAA0B,SAAQ,gBAAgB;IACjE;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,sCAAsC,IAAI,sCAAsC,EACrF,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;CACH"}
|
package/resources/surveys.d.ts
CHANGED
|
@@ -2,6 +2,7 @@ import { APIResource } from "../core/resource.js";
|
|
|
2
2
|
import * as SurveysAPI from "./surveys.js";
|
|
3
3
|
import * as ContactsAPI from "./users/contacts/contacts.js";
|
|
4
4
|
import { APIPromise } from "../core/api-promise.js";
|
|
5
|
+
import { CursorPage, type CursorPageParams, PagePromise } from "../core/pagination.js";
|
|
5
6
|
import { RequestOptions } from "../internal/request-options.js";
|
|
6
7
|
/**
|
|
7
8
|
* Surveys allow you to collect targeted feedback from your users within your product. Surveys can be targeted to specific user segments or pages and can contain multiple questions with conditional logic.
|
|
@@ -73,7 +74,7 @@ export declare class Surveys extends APIResource {
|
|
|
73
74
|
* - `createdAt` - ISO 8601 timestamp when created
|
|
74
75
|
* - `updatedAt` - ISO 8601 timestamp when last updated
|
|
75
76
|
*/
|
|
76
|
-
list(params?: SurveyListParams | null | undefined, options?: RequestOptions):
|
|
77
|
+
list(params?: SurveyListParams | null | undefined, options?: RequestOptions): PagePromise<SurveysCursorPage, Survey>;
|
|
77
78
|
/**
|
|
78
79
|
* Retrieves all user responses for a specific survey.
|
|
79
80
|
*
|
|
@@ -112,8 +113,10 @@ export declare class Surveys extends APIResource {
|
|
|
112
113
|
*
|
|
113
114
|
* - `404` - Survey not found in your organization
|
|
114
115
|
*/
|
|
115
|
-
|
|
116
|
+
listResponses(id: string, params?: SurveyListResponsesParams | null | undefined, options?: RequestOptions): PagePromise<SurveyListResponsesResponsesCursorPage, SurveyListResponsesResponse>;
|
|
116
117
|
}
|
|
118
|
+
export type SurveysCursorPage = CursorPage<Survey>;
|
|
119
|
+
export type SurveyListResponsesResponsesCursorPage = CursorPage<SurveyListResponsesResponse>;
|
|
117
120
|
export interface Survey {
|
|
118
121
|
/**
|
|
119
122
|
* Unique identifier
|
|
@@ -314,84 +317,54 @@ export interface SurveyNextAction {
|
|
|
314
317
|
*/
|
|
315
318
|
pageId?: string;
|
|
316
319
|
}
|
|
317
|
-
export interface
|
|
320
|
+
export interface SurveyListResponsesResponse {
|
|
318
321
|
/**
|
|
319
|
-
*
|
|
322
|
+
* Unique identifier
|
|
320
323
|
*/
|
|
321
|
-
|
|
324
|
+
id: string;
|
|
322
325
|
/**
|
|
323
|
-
*
|
|
326
|
+
* ISO 8601 timestamp when created
|
|
324
327
|
*/
|
|
325
|
-
|
|
328
|
+
createdAt: string;
|
|
326
329
|
/**
|
|
327
330
|
* Object type identifier
|
|
328
331
|
*/
|
|
329
|
-
object: '
|
|
330
|
-
}
|
|
331
|
-
export interface SurveyRetrieveResponsesResponse {
|
|
332
|
-
/**
|
|
333
|
-
* Array of survey responses
|
|
334
|
-
*/
|
|
335
|
-
data: Array<SurveyRetrieveResponsesResponse.Data>;
|
|
332
|
+
object: 'survey_response';
|
|
336
333
|
/**
|
|
337
|
-
*
|
|
334
|
+
* Individual responses to questions
|
|
338
335
|
*/
|
|
339
|
-
|
|
336
|
+
responses: Array<SurveyListResponsesResponse.Response>;
|
|
340
337
|
/**
|
|
341
|
-
*
|
|
338
|
+
* User who submitted the response
|
|
342
339
|
*/
|
|
343
|
-
|
|
340
|
+
user: ContactsAPI.Contact | null;
|
|
344
341
|
}
|
|
345
|
-
export declare namespace
|
|
346
|
-
interface
|
|
342
|
+
export declare namespace SurveyListResponsesResponse {
|
|
343
|
+
interface Response {
|
|
347
344
|
/**
|
|
348
|
-
*
|
|
345
|
+
* Page ID this response is for
|
|
349
346
|
*/
|
|
350
|
-
|
|
347
|
+
pageId: string;
|
|
351
348
|
/**
|
|
352
|
-
*
|
|
349
|
+
* Response type
|
|
353
350
|
*/
|
|
354
|
-
|
|
351
|
+
type: 'text' | 'link' | 'rating' | 'multiple-choice';
|
|
355
352
|
/**
|
|
356
|
-
*
|
|
353
|
+
* Response value
|
|
357
354
|
*/
|
|
358
|
-
|
|
355
|
+
value: string | number | boolean | Array<string>;
|
|
359
356
|
/**
|
|
360
|
-
*
|
|
357
|
+
* Response ID
|
|
361
358
|
*/
|
|
362
|
-
|
|
359
|
+
id?: string;
|
|
363
360
|
/**
|
|
364
|
-
*
|
|
361
|
+
* ISO 8601 timestamp when created
|
|
365
362
|
*/
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
* Page ID this response is for
|
|
372
|
-
*/
|
|
373
|
-
pageId: string;
|
|
374
|
-
/**
|
|
375
|
-
* Response type
|
|
376
|
-
*/
|
|
377
|
-
type: 'text' | 'link' | 'rating' | 'multiple-choice';
|
|
378
|
-
/**
|
|
379
|
-
* Response value
|
|
380
|
-
*/
|
|
381
|
-
value: string | number | boolean | Array<string>;
|
|
382
|
-
/**
|
|
383
|
-
* Response ID
|
|
384
|
-
*/
|
|
385
|
-
id?: string;
|
|
386
|
-
/**
|
|
387
|
-
* ISO 8601 timestamp when created
|
|
388
|
-
*/
|
|
389
|
-
createdAt?: string;
|
|
390
|
-
/**
|
|
391
|
-
* ISO 8601 timestamp when updated
|
|
392
|
-
*/
|
|
393
|
-
updatedAt?: string;
|
|
394
|
-
}
|
|
363
|
+
createdAt?: string;
|
|
364
|
+
/**
|
|
365
|
+
* ISO 8601 timestamp when updated
|
|
366
|
+
*/
|
|
367
|
+
updatedAt?: string;
|
|
395
368
|
}
|
|
396
369
|
}
|
|
397
370
|
export interface SurveyRetrieveParams {
|
|
@@ -401,20 +374,11 @@ export interface SurveyRetrieveParams {
|
|
|
401
374
|
*/
|
|
402
375
|
'Featurebase-Version'?: string;
|
|
403
376
|
}
|
|
404
|
-
export interface SurveyListParams {
|
|
405
|
-
/**
|
|
406
|
-
* Query param: An opaque cursor for pagination. Use the nextCursor value from a
|
|
407
|
-
* previous response to fetch the next page.
|
|
408
|
-
*/
|
|
409
|
-
cursor?: string;
|
|
377
|
+
export interface SurveyListParams extends CursorPageParams {
|
|
410
378
|
/**
|
|
411
379
|
* Query param: Filter by active status
|
|
412
380
|
*/
|
|
413
381
|
isActive?: boolean | null;
|
|
414
|
-
/**
|
|
415
|
-
* Query param: A limit on the number of objects to be returned, between 1 and 100.
|
|
416
|
-
*/
|
|
417
|
-
limit?: number;
|
|
418
382
|
/**
|
|
419
383
|
* Query param: Filter by survey page type
|
|
420
384
|
*/
|
|
@@ -425,16 +389,7 @@ export interface SurveyListParams {
|
|
|
425
389
|
*/
|
|
426
390
|
'Featurebase-Version'?: string;
|
|
427
391
|
}
|
|
428
|
-
export interface
|
|
429
|
-
/**
|
|
430
|
-
* Query param: An opaque cursor for pagination. Use the nextCursor value from a
|
|
431
|
-
* previous response to fetch the next page.
|
|
432
|
-
*/
|
|
433
|
-
cursor?: string;
|
|
434
|
-
/**
|
|
435
|
-
* Query param: A limit on the number of objects to be returned, between 1 and 100.
|
|
436
|
-
*/
|
|
437
|
-
limit?: number;
|
|
392
|
+
export interface SurveyListResponsesParams extends CursorPageParams {
|
|
438
393
|
/**
|
|
439
394
|
* Query param: Filter by survey page ID
|
|
440
395
|
*/
|
|
@@ -446,6 +401,6 @@ export interface SurveyRetrieveResponsesParams {
|
|
|
446
401
|
'Featurebase-Version'?: string;
|
|
447
402
|
}
|
|
448
403
|
export declare namespace Surveys {
|
|
449
|
-
export { type Survey as Survey, type SurveyNextAction as SurveyNextAction, type
|
|
404
|
+
export { type Survey as Survey, type SurveyNextAction as SurveyNextAction, type SurveyListResponsesResponse as SurveyListResponsesResponse, type SurveysCursorPage as SurveysCursorPage, type SurveyListResponsesResponsesCursorPage as SurveyListResponsesResponsesCursorPage, type SurveyRetrieveParams as SurveyRetrieveParams, type SurveyListParams as SurveyListParams, type SurveyListResponsesParams as SurveyListResponsesParams, };
|
|
450
405
|
}
|
|
451
406
|
//# sourceMappingURL=surveys.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"surveys.d.ts","sourceRoot":"","sources":["../src/resources/surveys.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,KAAK,WAAW;OAChB,EAAE,UAAU,EAAE;
|
|
1
|
+
{"version":3,"file":"surveys.d.ts","sourceRoot":"","sources":["../src/resources/surveys.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,KAAK,WAAW;OAChB,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAElD,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC;IAWrB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,IAAI,CACF,MAAM,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,iBAAiB,EAAE,MAAM,CAAC;IAYzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,aAAa,CACX,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,yBAAyB,GAAG,IAAI,GAAG,SAAc,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,sCAAsC,EAAE,2BAA2B,CAAC;CAepF;AAED,MAAM,MAAM,iBAAiB,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC;AAEnD,MAAM,MAAM,sCAAsC,GAAG,UAAU,CAAC,2BAA2B,CAAC,CAAC;AAE7F,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,MAAM,EAAE,QAAQ,CAAC;IAEjB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAE1B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,SAAS,CAAC;CAC9B;AAED,yBAAiB,MAAM,CAAC;IACtB,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,QAAQ,GAAG,iBAAiB,CAAC;QAErD;;WAEG;QACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;QAE9B;;WAEG;QACH,OAAO,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAE7B;;WAEG;QACH,aAAa,CAAC,EAAE,UAAU,CAAC,gBAAgB,CAAC;QAE5C;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,UAAU,CAAC,EAAE,QAAQ,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,CAAC;QAErD;;WAEG;QACH,KAAK,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAE1B;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,OAAO,CAAC,EAAE,QAAQ,GAAG,OAAO,GAAG,SAAS,GAAG,mBAAmB,GAAG,KAAK,CAAC;KACxE;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,MAAM;YACrB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,MAAM,CAAC,EAAE,MAAM,CAAC;SACjB;QAED,UAAiB,KAAK;YACpB;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,IAAI,EAAE,UAAU,CAAC,gBAAgB,CAAC;YAElC;;eAEG;YACH,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;YAEvC;;eAEG;YACH,EAAE,CAAC,EAAE,MAAM,CAAC;SACb;KACF;IAED;;OAEG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,GAAG,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QAE3B;;WAEG;QACH,aAAa,CAAC,EAAE,OAAO,CAAC;QAExB;;WAEG;QACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE3B;;WAEG;QACH,GAAG,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;KAC5B;IAED,UAAiB,SAAS,CAAC;QACzB,UAAiB,GAAG;YAClB;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;SACf;QAED,UAAiB,GAAG;YAClB;;eAEG;YACH,SAAS,EAAE,OAAO,GAAG,UAAU,GAAG,OAAO,CAAC;YAE1C;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,EAAE,CAAC,EAAE,MAAM,CAAC;SACb;KACF;CACF;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,KAAK,GAAG,MAAM,CAAC;IAE9B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,MAAM,EAAE,iBAAiB,CAAC;IAE1B;;OAEG;IACH,SAAS,EAAE,KAAK,CAAC,2BAA2B,CAAC,QAAQ,CAAC,CAAC;IAEvD;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC,OAAO,GAAG,IAAI,CAAC;CAClC;AAED,yBAAiB,2BAA2B,CAAC;IAC3C,UAAiB,QAAQ;QACvB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,QAAQ,GAAG,iBAAiB,CAAC;QAErD;;WAEG;QACH,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;QAEjD;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,gBAAiB,SAAQ,gBAAgB;IACxD;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,QAAQ,GAAG,iBAAiB,CAAC;IAEtD;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,yBAA0B,SAAQ,gBAAgB;IACjE;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,sCAAsC,IAAI,sCAAsC,EACrF,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;CACH"}
|
package/resources/surveys.js
CHANGED
|
@@ -3,6 +3,7 @@
|
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
4
|
exports.Surveys = void 0;
|
|
5
5
|
const resource_1 = require("../core/resource.js");
|
|
6
|
+
const pagination_1 = require("../core/pagination.js");
|
|
6
7
|
const headers_1 = require("../internal/headers.js");
|
|
7
8
|
const path_1 = require("../internal/utils/path.js");
|
|
8
9
|
/**
|
|
@@ -86,7 +87,7 @@ class Surveys extends resource_1.APIResource {
|
|
|
86
87
|
*/
|
|
87
88
|
list(params = {}, options) {
|
|
88
89
|
const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
|
|
89
|
-
return this._client.
|
|
90
|
+
return this._client.getAPIList('/v2/surveys', (pagination_1.CursorPage), {
|
|
90
91
|
query,
|
|
91
92
|
...options,
|
|
92
93
|
headers: (0, headers_1.buildHeaders)([
|
|
@@ -133,9 +134,9 @@ class Surveys extends resource_1.APIResource {
|
|
|
133
134
|
*
|
|
134
135
|
* - `404` - Survey not found in your organization
|
|
135
136
|
*/
|
|
136
|
-
|
|
137
|
+
listResponses(id, params = {}, options) {
|
|
137
138
|
const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
|
|
138
|
-
return this._client.
|
|
139
|
+
return this._client.getAPIList((0, path_1.path) `/v2/surveys/${id}/responses`, (pagination_1.CursorPage), {
|
|
139
140
|
query,
|
|
140
141
|
...options,
|
|
141
142
|
headers: (0, headers_1.buildHeaders)([
|
package/resources/surveys.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"surveys.js","sourceRoot":"","sources":["../src/resources/surveys.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,oDAAmD;AAEnD,oDAA8C;AAE9C;;GAEG;AACH,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,QAAQ,CACN,EAAU,EACV,SAAkD,EAAE,EACpD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,eAAe,EAAE,EAAE,EAAE;YAC/C,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,IAAI,CACF,SAA8C,EAAE,EAChD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,
|
|
1
|
+
{"version":3,"file":"surveys.js","sourceRoot":"","sources":["../src/resources/surveys.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,sDAAoF;AACpF,oDAAmD;AAEnD,oDAA8C;AAE9C;;GAEG;AACH,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,QAAQ,CACN,EAAU,EACV,SAAkD,EAAE,EACpD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,eAAe,EAAE,EAAE,EAAE;YAC/C,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,IAAI,CACF,SAA8C,EAAE,EAChD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,aAAa,EAAE,CAAA,uBAAkB,CAAA,EAAE;YAChE,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,aAAa,CACX,EAAU,EACV,SAAuD,EAAE,EACzD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAA,WAAI,EAAA,eAAe,EAAE,YAAY,EACjC,CAAA,uBAAuC,CAAA,EACvC;YACE,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CACF,CAAC;IACJ,CAAC;CACF;AAzJD,0BAyJC"}
|
package/resources/surveys.mjs
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
2
|
import { APIResource } from "../core/resource.mjs";
|
|
3
|
+
import { CursorPage } from "../core/pagination.mjs";
|
|
3
4
|
import { buildHeaders } from "../internal/headers.mjs";
|
|
4
5
|
import { path } from "../internal/utils/path.mjs";
|
|
5
6
|
/**
|
|
@@ -83,7 +84,7 @@ export class Surveys extends APIResource {
|
|
|
83
84
|
*/
|
|
84
85
|
list(params = {}, options) {
|
|
85
86
|
const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
|
|
86
|
-
return this._client.
|
|
87
|
+
return this._client.getAPIList('/v2/surveys', (CursorPage), {
|
|
87
88
|
query,
|
|
88
89
|
...options,
|
|
89
90
|
headers: buildHeaders([
|
|
@@ -130,9 +131,9 @@ export class Surveys extends APIResource {
|
|
|
130
131
|
*
|
|
131
132
|
* - `404` - Survey not found in your organization
|
|
132
133
|
*/
|
|
133
|
-
|
|
134
|
+
listResponses(id, params = {}, options) {
|
|
134
135
|
const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
|
|
135
|
-
return this._client.
|
|
136
|
+
return this._client.getAPIList(path `/v2/surveys/${id}/responses`, (CursorPage), {
|
|
136
137
|
query,
|
|
137
138
|
...options,
|
|
138
139
|
headers: buildHeaders([
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"surveys.mjs","sourceRoot":"","sources":["../src/resources/surveys.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAIf,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,QAAQ,CACN,EAAU,EACV,SAAkD,EAAE,EACpD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,eAAe,EAAE,EAAE,EAAE;YAC/C,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,IAAI,CACF,SAA8C,EAAE,EAChD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,
|
|
1
|
+
{"version":3,"file":"surveys.mjs","sourceRoot":"","sources":["../src/resources/surveys.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAIf,EAAE,UAAU,EAAsC;OAClD,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,QAAQ,CACN,EAAU,EACV,SAAkD,EAAE,EACpD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,eAAe,EAAE,EAAE,EAAE;YAC/C,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,IAAI,CACF,SAA8C,EAAE,EAChD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,aAAa,EAAE,CAAA,UAAkB,CAAA,EAAE;YAChE,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,aAAa,CACX,EAAU,EACV,SAAuD,EAAE,EACzD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAA,eAAe,EAAE,YAAY,EACjC,CAAA,UAAuC,CAAA,EACvC;YACE,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CACF,CAAC;IACJ,CAAC;CACF"}
|
|
@@ -2,6 +2,7 @@ import { APIResource } from "../../../core/resource.mjs";
|
|
|
2
2
|
import * as ContactsAPI from "./contacts.mjs";
|
|
3
3
|
import { ContactAttachParams, ContactAttachResponse, ContactListParams, ContactRemoveParams, ContactRemoveResponse, Contacts } from "./contacts.mjs";
|
|
4
4
|
import { APIPromise } from "../../../core/api-promise.mjs";
|
|
5
|
+
import { CursorPage, type CursorPageParams, PagePromise } from "../../../core/pagination.mjs";
|
|
5
6
|
import { RequestOptions } from "../../../internal/request-options.mjs";
|
|
6
7
|
/**
|
|
7
8
|
* Companies represent organizations or businesses that your users belong to. Use this endpoint to list and retrieve company information.
|
|
@@ -137,10 +138,13 @@ export declare class Companies extends APIResource {
|
|
|
137
138
|
*
|
|
138
139
|
* @example
|
|
139
140
|
* ```ts
|
|
140
|
-
*
|
|
141
|
+
* // Automatically fetches more pages as needed.
|
|
142
|
+
* for await (const company of client.users.companies.list()) {
|
|
143
|
+
* // ...
|
|
144
|
+
* }
|
|
141
145
|
* ```
|
|
142
146
|
*/
|
|
143
|
-
list(params?: CompanyListParams | null | undefined, options?: RequestOptions):
|
|
147
|
+
list(params?: CompanyListParams | null | undefined, options?: RequestOptions): PagePromise<CompaniesCursorPage, Company>;
|
|
144
148
|
/**
|
|
145
149
|
* Deletes a company by its Featurebase ID.
|
|
146
150
|
*
|
|
@@ -309,6 +313,7 @@ export declare class Companies extends APIResource {
|
|
|
309
313
|
*/
|
|
310
314
|
deleteByCompanyID(companyID: string, params?: CompanyDeleteByCompanyIDParams | null | undefined, options?: RequestOptions): APIPromise<DeletedCompany>;
|
|
311
315
|
}
|
|
316
|
+
export type CompaniesCursorPage = CursorPage<Company>;
|
|
312
317
|
export interface Company {
|
|
313
318
|
/**
|
|
314
319
|
* Featurebase internal ID
|
|
@@ -383,20 +388,6 @@ export interface DeletedCompany {
|
|
|
383
388
|
*/
|
|
384
389
|
object: 'company';
|
|
385
390
|
}
|
|
386
|
-
export interface CompanyListResponse {
|
|
387
|
-
/**
|
|
388
|
-
* Array of companies
|
|
389
|
-
*/
|
|
390
|
-
data: Array<Company>;
|
|
391
|
-
/**
|
|
392
|
-
* Cursor for fetching the next page (cursor-based pagination)
|
|
393
|
-
*/
|
|
394
|
-
nextCursor: string | null;
|
|
395
|
-
/**
|
|
396
|
-
* Object type identifier
|
|
397
|
-
*/
|
|
398
|
-
object: 'list';
|
|
399
|
-
}
|
|
400
391
|
export interface CompanyRetrieveParams {
|
|
401
392
|
/**
|
|
402
393
|
* API version for this request. Defaults to your organization's configured API
|
|
@@ -404,17 +395,7 @@ export interface CompanyRetrieveParams {
|
|
|
404
395
|
*/
|
|
405
396
|
'Featurebase-Version'?: string;
|
|
406
397
|
}
|
|
407
|
-
export interface CompanyListParams {
|
|
408
|
-
/**
|
|
409
|
-
* Query param: An opaque cursor for pagination. Use the nextCursor value from a
|
|
410
|
-
* previous response to fetch the next page of results.
|
|
411
|
-
*/
|
|
412
|
-
cursor?: string;
|
|
413
|
-
/**
|
|
414
|
-
* Query param: A limit on the number of companies to be returned, between 1
|
|
415
|
-
* and 100.
|
|
416
|
-
*/
|
|
417
|
-
limit?: number;
|
|
398
|
+
export interface CompanyListParams extends CursorPageParams {
|
|
418
399
|
/**
|
|
419
400
|
* Header param: API version for this request. Defaults to your organization's
|
|
420
401
|
* configured API version if not specified.
|
|
@@ -492,7 +473,7 @@ export interface CompanyDeleteByCompanyIDParams {
|
|
|
492
473
|
'Featurebase-Version'?: string;
|
|
493
474
|
}
|
|
494
475
|
export declare namespace Companies {
|
|
495
|
-
export { type Company as Company, type DeletedCompany as DeletedCompany, type
|
|
476
|
+
export { type Company as Company, type DeletedCompany as DeletedCompany, type CompaniesCursorPage as CompaniesCursorPage, type CompanyRetrieveParams as CompanyRetrieveParams, type CompanyListParams as CompanyListParams, type CompanyDeleteParams as CompanyDeleteParams, type CompanyCreateOrUpdateParams as CompanyCreateOrUpdateParams, type CompanyDeleteByCompanyIDParams as CompanyDeleteByCompanyIDParams, };
|
|
496
477
|
export { Contacts as Contacts, type ContactAttachResponse as ContactAttachResponse, type ContactRemoveResponse as ContactRemoveResponse, type ContactListParams as ContactListParams, type ContactAttachParams as ContactAttachParams, type ContactRemoveParams as ContactRemoveParams, };
|
|
497
478
|
}
|
|
498
479
|
//# sourceMappingURL=companies.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"companies.d.mts","sourceRoot":"","sources":["../../../src/resources/users/companies/companies.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,EACL,mBAAmB,EACnB,qBAAqB,EACrB,iBAAiB,EACjB,mBAAmB,EACnB,qBAAqB,EACrB,QAAQ,EACT;OACM,EAAE,UAAU,EAAE;
|
|
1
|
+
{"version":3,"file":"companies.d.mts","sourceRoot":"","sources":["../../../src/resources/users/companies/companies.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,EACL,mBAAmB,EACnB,qBAAqB,EACrB,iBAAiB,EACjB,mBAAmB,EACnB,qBAAqB,EACrB,QAAQ,EACT;OACM,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAElD,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,SAAU,SAAQ,WAAW;IACxC,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IAExE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4DG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,OAAO,CAAC;IAWtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwEG;IACH,IAAI,CACF,MAAM,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,mBAAmB,EAAE,OAAO,CAAC;IAY5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,cAAc,CAAC;IAW7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0EG;IACH,cAAc,CAAC,MAAM,EAAE,2BAA2B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAYlG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoDG;IACH,iBAAiB,CACf,SAAS,EAAE,MAAM,EACjB,MAAM,GAAE,8BAA8B,GAAG,IAAI,GAAG,SAAc,EAC9D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,cAAc,CAAC;CAU9B;AAED,MAAM,MAAM,mBAAmB,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;AAEtD,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,SAAS,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,YAAY,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CAC3C;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,IAAI,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,SAAS,CAAC;CACnB;AAED,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IACzD;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,2BAA2B;IAC1C;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,YAAY,CAAC,EAAE,2BAA2B,CAAC,YAAY,CAAC;IAExD;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,yBAAiB,2BAA2B,CAAC;IAC3C;;;OAGG;IACH,UAAiB,YAAY;QAC3B,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,8BAA8B;IAC7C;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAID,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,8BAA8B,IAAI,8BAA8B,GACtE,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
|