rcs-js 2.0.19 → 2.0.21
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/dist/cjs/Client.d.ts +3 -0
- package/dist/cjs/Client.js +19 -14
- package/dist/cjs/api/resources/forms/client/Client.d.ts +171 -0
- package/dist/cjs/api/resources/forms/client/Client.js +500 -0
- package/dist/cjs/api/resources/forms/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/forms/client/index.js +17 -0
- package/dist/cjs/api/resources/forms/client/requests/ListFormsParams.d.ts +13 -0
- package/dist/cjs/api/resources/forms/client/requests/ListFormsParams.js +3 -0
- package/dist/cjs/api/resources/forms/client/requests/UpdateFormParams.d.ts +25 -0
- package/dist/cjs/api/resources/forms/client/requests/UpdateFormParams.js +3 -0
- package/dist/cjs/api/resources/forms/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/resources/forms/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/forms/index.d.ts +3 -0
- package/dist/cjs/api/resources/forms/index.js +19 -0
- package/dist/cjs/api/resources/forms/resources/index.d.ts +2 -0
- package/dist/cjs/api/resources/forms/resources/index.js +41 -0
- package/dist/cjs/api/resources/forms/resources/submissions/client/Client.d.ts +35 -0
- package/dist/cjs/api/resources/forms/resources/submissions/client/Client.js +141 -0
- package/dist/cjs/api/resources/forms/resources/submissions/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/forms/resources/submissions/client/index.js +17 -0
- package/dist/cjs/api/resources/forms/resources/submissions/client/requests/ListFormSubmissionsParams.d.ts +13 -0
- package/dist/cjs/api/resources/forms/resources/submissions/client/requests/ListFormSubmissionsParams.js +3 -0
- package/dist/cjs/api/resources/forms/resources/submissions/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/forms/resources/submissions/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/forms/resources/submissions/index.d.ts +1 -0
- package/dist/cjs/api/resources/forms/resources/submissions/index.js +17 -0
- package/dist/cjs/api/resources/forms/types/FormsSendResponse.d.ts +2 -0
- package/dist/cjs/api/resources/forms/types/FormsSendResponse.js +3 -0
- package/dist/cjs/api/resources/forms/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/forms/types/index.js +17 -0
- package/dist/cjs/api/resources/index.d.ts +3 -0
- package/dist/cjs/api/resources/index.js +4 -1
- package/dist/cjs/api/resources/webhooks/client/requests/AttachWebhookParams.d.ts +1 -1
- package/dist/cjs/api/types/AddressField.d.ts +14 -0
- package/dist/cjs/api/types/AddressField.js +3 -0
- package/dist/cjs/api/types/AgentSummary.d.ts +16 -2
- package/dist/cjs/api/types/CampaignStatusEvent.d.ts +19 -0
- package/dist/cjs/api/types/CampaignStatusEvent.js +3 -0
- package/dist/cjs/api/types/CampaignStatusEventAgent.d.ts +9 -0
- package/dist/cjs/api/types/CampaignStatusEventAgent.js +3 -0
- package/dist/cjs/api/types/CampaignStatusEventBrand.d.ts +9 -0
- package/dist/cjs/api/types/CampaignStatusEventBrand.js +3 -0
- package/dist/cjs/api/types/CampaignStatusEventCampaign.d.ts +18 -0
- package/dist/cjs/api/types/CampaignStatusEventCampaign.js +13 -0
- package/dist/cjs/api/types/CampaignStatusEventCarrierLaunches.d.ts +48 -0
- package/dist/cjs/api/types/CampaignStatusEventCarrierLaunches.js +3 -0
- package/dist/cjs/api/types/CarrierLaunchStatus.d.ts +4 -4
- package/dist/cjs/api/types/CarrierLaunchStatus.js +4 -4
- package/dist/cjs/api/types/CarrierLaunches.d.ts +49 -9
- package/dist/cjs/api/types/CheckboxField.d.ts +12 -0
- package/dist/cjs/api/types/CheckboxField.js +3 -0
- package/dist/cjs/api/types/ColorField.d.ts +6 -0
- package/dist/cjs/api/types/ColorField.js +3 -0
- package/dist/cjs/api/types/CreateFormRequest.d.ts +5 -0
- package/dist/cjs/api/types/CreateFormRequest.js +3 -0
- package/dist/cjs/api/types/DateField.d.ts +12 -0
- package/dist/cjs/api/types/DateField.js +3 -0
- package/dist/cjs/api/types/DatetimeField.d.ts +12 -0
- package/dist/cjs/api/types/DatetimeField.js +3 -0
- package/dist/cjs/api/types/EmailField.d.ts +8 -0
- package/dist/cjs/api/types/EmailField.js +3 -0
- package/dist/cjs/api/types/FieldBase.d.ts +13 -0
- package/dist/cjs/api/types/FieldBase.js +3 -0
- package/dist/cjs/api/types/Form.d.ts +32 -0
- package/dist/cjs/api/types/Form.js +3 -0
- package/dist/cjs/api/types/FormBackground.d.ts +19 -0
- package/dist/cjs/api/types/FormBackground.js +3 -0
- package/dist/cjs/api/types/FormBackgroundGradient.d.ts +10 -0
- package/dist/cjs/api/types/FormBackgroundGradient.js +3 -0
- package/dist/cjs/api/types/FormBackgroundImage.d.ts +13 -0
- package/dist/cjs/api/types/FormBackgroundImage.js +3 -0
- package/dist/cjs/api/types/FormBackgroundPattern.d.ts +19 -0
- package/dist/cjs/api/types/FormBackgroundPattern.js +16 -0
- package/dist/cjs/api/types/FormBackgroundSolid.d.ts +24 -0
- package/dist/cjs/api/types/FormBackgroundSolid.js +3 -0
- package/dist/cjs/api/types/FormColorPalette.d.ts +11 -0
- package/dist/cjs/api/types/FormColorPalette.js +3 -0
- package/dist/cjs/api/types/FormDefinition.d.ts +18 -0
- package/dist/cjs/api/types/FormDefinition.js +3 -0
- package/dist/cjs/api/types/FormField.d.ts +55 -0
- package/dist/cjs/api/types/FormField.js +3 -0
- package/dist/cjs/api/types/FormFieldOption.d.ts +9 -0
- package/dist/cjs/api/types/FormFieldOption.js +3 -0
- package/dist/cjs/api/types/FormGradient.d.ts +19 -0
- package/dist/cjs/api/types/FormGradient.js +12 -0
- package/dist/cjs/api/types/FormIdReference.d.ts +4 -0
- package/dist/cjs/api/types/FormIdReference.js +3 -0
- package/dist/cjs/api/types/FormSubmission.d.ts +34 -0
- package/dist/cjs/api/types/FormSubmission.js +3 -0
- package/dist/cjs/api/types/FormSubmissionAnswer.d.ts +9 -0
- package/dist/cjs/api/types/FormSubmissionAnswer.js +3 -0
- package/dist/cjs/api/types/FormSubmissionEvent.d.ts +12 -0
- package/dist/cjs/api/types/FormSubmissionEvent.js +3 -0
- package/dist/cjs/api/types/FormSubmissionEventConversation.d.ts +15 -0
- package/dist/cjs/api/types/FormSubmissionEventConversation.js +3 -0
- package/dist/cjs/api/types/FormSubmissionEventForm.d.ts +11 -0
- package/dist/cjs/api/types/FormSubmissionEventForm.js +3 -0
- package/dist/cjs/api/types/FormSubmissionEventSubmission.d.ts +31 -0
- package/dist/cjs/api/types/FormSubmissionEventSubmission.js +3 -0
- package/dist/cjs/api/types/FormSubmittedField.d.ts +14 -0
- package/dist/cjs/api/types/FormSubmittedField.js +3 -0
- package/dist/cjs/api/types/FormThemeOverride.d.ts +77 -0
- package/dist/cjs/api/types/FormThemeOverride.js +33 -0
- package/dist/cjs/api/types/ListFormSubmissionsResponse.d.ts +12 -0
- package/dist/cjs/api/types/ListFormSubmissionsResponse.js +3 -0
- package/dist/cjs/api/types/ListFormsResponse.d.ts +12 -0
- package/dist/cjs/api/types/ListFormsResponse.js +3 -0
- package/dist/cjs/api/types/MessageEvent.d.ts +8 -2
- package/dist/cjs/api/types/MessageEvent.js +5 -0
- package/dist/cjs/api/types/NumberField.d.ts +14 -0
- package/dist/cjs/api/types/NumberField.js +3 -0
- package/dist/cjs/api/types/PhoneField.d.ts +8 -0
- package/dist/cjs/api/types/PhoneField.js +3 -0
- package/dist/cjs/api/types/RadioField.d.ts +8 -0
- package/dist/cjs/api/types/RadioField.js +3 -0
- package/dist/cjs/api/types/RangeField.d.ts +12 -0
- package/dist/cjs/api/types/RangeField.js +3 -0
- package/dist/cjs/api/types/RatingField.d.ts +10 -0
- package/dist/cjs/api/types/RatingField.js +3 -0
- package/dist/cjs/api/types/ScheduledFormSendResult.d.ts +20 -0
- package/dist/cjs/api/types/ScheduledFormSendResult.js +3 -0
- package/dist/cjs/api/types/SelectField.d.ts +10 -0
- package/dist/cjs/api/types/SelectField.js +3 -0
- package/dist/cjs/api/types/SendFormOptions.d.ts +18 -0
- package/dist/cjs/api/types/SendFormOptions.js +13 -0
- package/dist/cjs/api/types/SendFormParams.d.ts +9 -0
- package/dist/cjs/api/types/SendFormParams.js +3 -0
- package/dist/cjs/api/types/SendFormResult.d.ts +13 -0
- package/dist/cjs/api/types/SendFormResult.js +3 -0
- package/dist/cjs/api/types/SendFormViaRcsParams.d.ts +28 -0
- package/dist/cjs/api/types/SendFormViaRcsParams.js +3 -0
- package/dist/cjs/api/types/SendFormViaSmsParams.d.ts +15 -0
- package/dist/cjs/api/types/SendFormViaSmsParams.js +3 -0
- package/dist/cjs/api/types/TextField.d.ts +14 -0
- package/dist/cjs/api/types/TextField.js +3 -0
- package/dist/cjs/api/types/TextareaField.d.ts +14 -0
- package/dist/cjs/api/types/TextareaField.js +3 -0
- package/dist/cjs/api/types/TimeField.d.ts +12 -0
- package/dist/cjs/api/types/TimeField.js +3 -0
- package/dist/cjs/api/types/UrlField.d.ts +8 -0
- package/dist/cjs/api/types/UrlField.js +3 -0
- package/dist/cjs/api/types/UserEvent.d.ts +5 -2
- package/dist/cjs/api/types/VerificationStatus.d.ts +12 -0
- package/dist/cjs/api/types/VerificationStatus.js +15 -0
- package/dist/cjs/api/types/WebhookEventEnum.d.ts +2 -0
- package/dist/cjs/api/types/WebhookEventEnum.js +2 -0
- package/dist/cjs/api/types/index.d.ts +52 -0
- package/dist/cjs/api/types/index.js +52 -0
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/cjs/wrapper/messages/Client.d.ts +1 -1
- package/dist/esm/Client.d.mts +3 -0
- package/dist/esm/Client.mjs +7 -2
- package/dist/esm/api/resources/forms/client/Client.d.mts +171 -0
- package/dist/esm/api/resources/forms/client/Client.mjs +463 -0
- package/dist/esm/api/resources/forms/client/index.d.mts +1 -0
- package/dist/esm/api/resources/forms/client/index.mjs +1 -0
- package/dist/esm/api/resources/forms/client/requests/ListFormsParams.d.mts +13 -0
- package/dist/esm/api/resources/forms/client/requests/ListFormsParams.mjs +2 -0
- package/dist/esm/api/resources/forms/client/requests/UpdateFormParams.d.mts +25 -0
- package/dist/esm/api/resources/forms/client/requests/UpdateFormParams.mjs +2 -0
- package/dist/esm/api/resources/forms/client/requests/index.d.mts +2 -0
- package/dist/esm/api/resources/forms/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/forms/index.d.mts +3 -0
- package/dist/esm/api/resources/forms/index.mjs +3 -0
- package/dist/esm/api/resources/forms/resources/index.d.mts +2 -0
- package/dist/esm/api/resources/forms/resources/index.mjs +2 -0
- package/dist/esm/api/resources/forms/resources/submissions/client/Client.d.mts +35 -0
- package/dist/esm/api/resources/forms/resources/submissions/client/Client.mjs +104 -0
- package/dist/esm/api/resources/forms/resources/submissions/client/index.d.mts +1 -0
- package/dist/esm/api/resources/forms/resources/submissions/client/index.mjs +1 -0
- package/dist/esm/api/resources/forms/resources/submissions/client/requests/ListFormSubmissionsParams.d.mts +13 -0
- package/dist/esm/api/resources/forms/resources/submissions/client/requests/ListFormSubmissionsParams.mjs +2 -0
- package/dist/esm/api/resources/forms/resources/submissions/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/forms/resources/submissions/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/forms/resources/submissions/index.d.mts +1 -0
- package/dist/esm/api/resources/forms/resources/submissions/index.mjs +1 -0
- package/dist/esm/api/resources/forms/types/FormsSendResponse.d.mts +2 -0
- package/dist/esm/api/resources/forms/types/FormsSendResponse.mjs +2 -0
- package/dist/esm/api/resources/forms/types/index.d.mts +1 -0
- package/dist/esm/api/resources/forms/types/index.mjs +1 -0
- package/dist/esm/api/resources/index.d.mts +3 -0
- package/dist/esm/api/resources/index.mjs +3 -0
- package/dist/esm/api/resources/webhooks/client/requests/AttachWebhookParams.d.mts +1 -1
- package/dist/esm/api/types/AddressField.d.mts +14 -0
- package/dist/esm/api/types/AddressField.mjs +2 -0
- package/dist/esm/api/types/AgentSummary.d.mts +16 -2
- package/dist/esm/api/types/CampaignStatusEvent.d.mts +19 -0
- package/dist/esm/api/types/CampaignStatusEvent.mjs +2 -0
- package/dist/esm/api/types/CampaignStatusEventAgent.d.mts +9 -0
- package/dist/esm/api/types/CampaignStatusEventAgent.mjs +2 -0
- package/dist/esm/api/types/CampaignStatusEventBrand.d.mts +9 -0
- package/dist/esm/api/types/CampaignStatusEventBrand.mjs +2 -0
- package/dist/esm/api/types/CampaignStatusEventCampaign.d.mts +18 -0
- package/dist/esm/api/types/CampaignStatusEventCampaign.mjs +10 -0
- package/dist/esm/api/types/CampaignStatusEventCarrierLaunches.d.mts +48 -0
- package/dist/esm/api/types/CampaignStatusEventCarrierLaunches.mjs +2 -0
- package/dist/esm/api/types/CarrierLaunchStatus.d.mts +4 -4
- package/dist/esm/api/types/CarrierLaunchStatus.mjs +4 -4
- package/dist/esm/api/types/CarrierLaunches.d.mts +49 -9
- package/dist/esm/api/types/CheckboxField.d.mts +12 -0
- package/dist/esm/api/types/CheckboxField.mjs +2 -0
- package/dist/esm/api/types/ColorField.d.mts +6 -0
- package/dist/esm/api/types/ColorField.mjs +2 -0
- package/dist/esm/api/types/CreateFormRequest.d.mts +5 -0
- package/dist/esm/api/types/CreateFormRequest.mjs +2 -0
- package/dist/esm/api/types/DateField.d.mts +12 -0
- package/dist/esm/api/types/DateField.mjs +2 -0
- package/dist/esm/api/types/DatetimeField.d.mts +12 -0
- package/dist/esm/api/types/DatetimeField.mjs +2 -0
- package/dist/esm/api/types/EmailField.d.mts +8 -0
- package/dist/esm/api/types/EmailField.mjs +2 -0
- package/dist/esm/api/types/FieldBase.d.mts +13 -0
- package/dist/esm/api/types/FieldBase.mjs +2 -0
- package/dist/esm/api/types/Form.d.mts +32 -0
- package/dist/esm/api/types/Form.mjs +2 -0
- package/dist/esm/api/types/FormBackground.d.mts +19 -0
- package/dist/esm/api/types/FormBackground.mjs +2 -0
- package/dist/esm/api/types/FormBackgroundGradient.d.mts +10 -0
- package/dist/esm/api/types/FormBackgroundGradient.mjs +2 -0
- package/dist/esm/api/types/FormBackgroundImage.d.mts +13 -0
- package/dist/esm/api/types/FormBackgroundImage.mjs +2 -0
- package/dist/esm/api/types/FormBackgroundPattern.d.mts +19 -0
- package/dist/esm/api/types/FormBackgroundPattern.mjs +13 -0
- package/dist/esm/api/types/FormBackgroundSolid.d.mts +24 -0
- package/dist/esm/api/types/FormBackgroundSolid.mjs +2 -0
- package/dist/esm/api/types/FormColorPalette.d.mts +11 -0
- package/dist/esm/api/types/FormColorPalette.mjs +2 -0
- package/dist/esm/api/types/FormDefinition.d.mts +18 -0
- package/dist/esm/api/types/FormDefinition.mjs +2 -0
- package/dist/esm/api/types/FormField.d.mts +55 -0
- package/dist/esm/api/types/FormField.mjs +2 -0
- package/dist/esm/api/types/FormFieldOption.d.mts +9 -0
- package/dist/esm/api/types/FormFieldOption.mjs +2 -0
- package/dist/esm/api/types/FormGradient.d.mts +19 -0
- package/dist/esm/api/types/FormGradient.mjs +9 -0
- package/dist/esm/api/types/FormIdReference.d.mts +4 -0
- package/dist/esm/api/types/FormIdReference.mjs +2 -0
- package/dist/esm/api/types/FormSubmission.d.mts +34 -0
- package/dist/esm/api/types/FormSubmission.mjs +2 -0
- package/dist/esm/api/types/FormSubmissionAnswer.d.mts +9 -0
- package/dist/esm/api/types/FormSubmissionAnswer.mjs +2 -0
- package/dist/esm/api/types/FormSubmissionEvent.d.mts +12 -0
- package/dist/esm/api/types/FormSubmissionEvent.mjs +2 -0
- package/dist/esm/api/types/FormSubmissionEventConversation.d.mts +15 -0
- package/dist/esm/api/types/FormSubmissionEventConversation.mjs +2 -0
- package/dist/esm/api/types/FormSubmissionEventForm.d.mts +11 -0
- package/dist/esm/api/types/FormSubmissionEventForm.mjs +2 -0
- package/dist/esm/api/types/FormSubmissionEventSubmission.d.mts +31 -0
- package/dist/esm/api/types/FormSubmissionEventSubmission.mjs +2 -0
- package/dist/esm/api/types/FormSubmittedField.d.mts +14 -0
- package/dist/esm/api/types/FormSubmittedField.mjs +2 -0
- package/dist/esm/api/types/FormThemeOverride.d.mts +77 -0
- package/dist/esm/api/types/FormThemeOverride.mjs +30 -0
- package/dist/esm/api/types/ListFormSubmissionsResponse.d.mts +12 -0
- package/dist/esm/api/types/ListFormSubmissionsResponse.mjs +2 -0
- package/dist/esm/api/types/ListFormsResponse.d.mts +12 -0
- package/dist/esm/api/types/ListFormsResponse.mjs +2 -0
- package/dist/esm/api/types/MessageEvent.d.mts +8 -2
- package/dist/esm/api/types/MessageEvent.mjs +5 -0
- package/dist/esm/api/types/NumberField.d.mts +14 -0
- package/dist/esm/api/types/NumberField.mjs +2 -0
- package/dist/esm/api/types/PhoneField.d.mts +8 -0
- package/dist/esm/api/types/PhoneField.mjs +2 -0
- package/dist/esm/api/types/RadioField.d.mts +8 -0
- package/dist/esm/api/types/RadioField.mjs +2 -0
- package/dist/esm/api/types/RangeField.d.mts +12 -0
- package/dist/esm/api/types/RangeField.mjs +2 -0
- package/dist/esm/api/types/RatingField.d.mts +10 -0
- package/dist/esm/api/types/RatingField.mjs +2 -0
- package/dist/esm/api/types/ScheduledFormSendResult.d.mts +20 -0
- package/dist/esm/api/types/ScheduledFormSendResult.mjs +2 -0
- package/dist/esm/api/types/SelectField.d.mts +10 -0
- package/dist/esm/api/types/SelectField.mjs +2 -0
- package/dist/esm/api/types/SendFormOptions.d.mts +18 -0
- package/dist/esm/api/types/SendFormOptions.mjs +10 -0
- package/dist/esm/api/types/SendFormParams.d.mts +9 -0
- package/dist/esm/api/types/SendFormParams.mjs +2 -0
- package/dist/esm/api/types/SendFormResult.d.mts +13 -0
- package/dist/esm/api/types/SendFormResult.mjs +2 -0
- package/dist/esm/api/types/SendFormViaRcsParams.d.mts +28 -0
- package/dist/esm/api/types/SendFormViaRcsParams.mjs +2 -0
- package/dist/esm/api/types/SendFormViaSmsParams.d.mts +15 -0
- package/dist/esm/api/types/SendFormViaSmsParams.mjs +2 -0
- package/dist/esm/api/types/TextField.d.mts +14 -0
- package/dist/esm/api/types/TextField.mjs +2 -0
- package/dist/esm/api/types/TextareaField.d.mts +14 -0
- package/dist/esm/api/types/TextareaField.mjs +2 -0
- package/dist/esm/api/types/TimeField.d.mts +12 -0
- package/dist/esm/api/types/TimeField.mjs +2 -0
- package/dist/esm/api/types/UrlField.d.mts +8 -0
- package/dist/esm/api/types/UrlField.mjs +2 -0
- package/dist/esm/api/types/UserEvent.d.mts +5 -2
- package/dist/esm/api/types/VerificationStatus.d.mts +12 -0
- package/dist/esm/api/types/VerificationStatus.mjs +12 -0
- package/dist/esm/api/types/WebhookEventEnum.d.mts +2 -0
- package/dist/esm/api/types/WebhookEventEnum.mjs +2 -0
- package/dist/esm/api/types/index.d.mts +52 -0
- package/dist/esm/api/types/index.mjs +52 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/dist/esm/wrapper/messages/Client.d.mts +1 -1
- package/package.json +1 -1
- package/reference.md +481 -0
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import type { BaseClientOptions, BaseRequestOptions } from "../../../../../../BaseClient.js";
|
|
2
|
+
import * as core from "../../../../../../core/index.js";
|
|
3
|
+
import * as Pinnacle from "../../../../../index.js";
|
|
4
|
+
export declare namespace Submissions {
|
|
5
|
+
interface Options extends BaseClientOptions {
|
|
6
|
+
}
|
|
7
|
+
interface RequestOptions extends BaseRequestOptions {
|
|
8
|
+
}
|
|
9
|
+
}
|
|
10
|
+
export declare class Submissions {
|
|
11
|
+
protected readonly _options: Submissions.Options;
|
|
12
|
+
constructor(_options: Submissions.Options);
|
|
13
|
+
/**
|
|
14
|
+
* Paginated list of completed submissions for a form, newest first. Each row includes the submitted `data` keyed by field `key`, the sender/recipient, IP, user-agent, and timestamps.
|
|
15
|
+
*
|
|
16
|
+
* @param {string} id - The unique identifier of the form whose submissions you want to list.
|
|
17
|
+
* <br><br> This identifier is a string that always begins with the prefix `form_`, for example: `form_Oy2n7iUoi9CJwUU6`.
|
|
18
|
+
* @param {Pinnacle.forms.ListFormSubmissionsParams} request
|
|
19
|
+
* @param {Submissions.RequestOptions} requestOptions - Request-specific configuration.
|
|
20
|
+
*
|
|
21
|
+
* @throws {@link Pinnacle.BadRequestError}
|
|
22
|
+
* @throws {@link Pinnacle.UnauthorizedError}
|
|
23
|
+
* @throws {@link Pinnacle.NotFoundError}
|
|
24
|
+
* @throws {@link Pinnacle.InternalServerError}
|
|
25
|
+
*
|
|
26
|
+
* @example
|
|
27
|
+
* await client.forms.submissions.list("form_Oy2n7iUoi9CJwUU6", {
|
|
28
|
+
* pageIndex: 0,
|
|
29
|
+
* pageSize: 20
|
|
30
|
+
* })
|
|
31
|
+
*/
|
|
32
|
+
list(id: string, request?: Pinnacle.forms.ListFormSubmissionsParams, requestOptions?: Submissions.RequestOptions): core.HttpResponsePromise<Pinnacle.ListFormSubmissionsResponse>;
|
|
33
|
+
private __list;
|
|
34
|
+
protected _getCustomAuthorizationHeaders(): Promise<Record<string, string | undefined>>;
|
|
35
|
+
}
|
|
@@ -0,0 +1,141 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
4
|
+
if (k2 === undefined) k2 = k;
|
|
5
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
6
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
7
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
8
|
+
}
|
|
9
|
+
Object.defineProperty(o, k2, desc);
|
|
10
|
+
}) : (function(o, m, k, k2) {
|
|
11
|
+
if (k2 === undefined) k2 = k;
|
|
12
|
+
o[k2] = m[k];
|
|
13
|
+
}));
|
|
14
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
15
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
16
|
+
}) : function(o, v) {
|
|
17
|
+
o["default"] = v;
|
|
18
|
+
});
|
|
19
|
+
var __importStar = (this && this.__importStar) || (function () {
|
|
20
|
+
var ownKeys = function(o) {
|
|
21
|
+
ownKeys = Object.getOwnPropertyNames || function (o) {
|
|
22
|
+
var ar = [];
|
|
23
|
+
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
|
|
24
|
+
return ar;
|
|
25
|
+
};
|
|
26
|
+
return ownKeys(o);
|
|
27
|
+
};
|
|
28
|
+
return function (mod) {
|
|
29
|
+
if (mod && mod.__esModule) return mod;
|
|
30
|
+
var result = {};
|
|
31
|
+
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
|
|
32
|
+
__setModuleDefault(result, mod);
|
|
33
|
+
return result;
|
|
34
|
+
};
|
|
35
|
+
})();
|
|
36
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
37
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
38
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
39
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
40
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
41
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
42
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
43
|
+
});
|
|
44
|
+
};
|
|
45
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
46
|
+
exports.Submissions = void 0;
|
|
47
|
+
const headers_js_1 = require("../../../../../../core/headers.js");
|
|
48
|
+
const core = __importStar(require("../../../../../../core/index.js"));
|
|
49
|
+
const environments = __importStar(require("../../../../../../environments.js"));
|
|
50
|
+
const errors = __importStar(require("../../../../../../errors/index.js"));
|
|
51
|
+
const Pinnacle = __importStar(require("../../../../../index.js"));
|
|
52
|
+
class Submissions {
|
|
53
|
+
constructor(_options) {
|
|
54
|
+
this._options = _options;
|
|
55
|
+
}
|
|
56
|
+
/**
|
|
57
|
+
* Paginated list of completed submissions for a form, newest first. Each row includes the submitted `data` keyed by field `key`, the sender/recipient, IP, user-agent, and timestamps.
|
|
58
|
+
*
|
|
59
|
+
* @param {string} id - The unique identifier of the form whose submissions you want to list.
|
|
60
|
+
* <br><br> This identifier is a string that always begins with the prefix `form_`, for example: `form_Oy2n7iUoi9CJwUU6`.
|
|
61
|
+
* @param {Pinnacle.forms.ListFormSubmissionsParams} request
|
|
62
|
+
* @param {Submissions.RequestOptions} requestOptions - Request-specific configuration.
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link Pinnacle.BadRequestError}
|
|
65
|
+
* @throws {@link Pinnacle.UnauthorizedError}
|
|
66
|
+
* @throws {@link Pinnacle.NotFoundError}
|
|
67
|
+
* @throws {@link Pinnacle.InternalServerError}
|
|
68
|
+
*
|
|
69
|
+
* @example
|
|
70
|
+
* await client.forms.submissions.list("form_Oy2n7iUoi9CJwUU6", {
|
|
71
|
+
* pageIndex: 0,
|
|
72
|
+
* pageSize: 20
|
|
73
|
+
* })
|
|
74
|
+
*/
|
|
75
|
+
list(id, request = {}, requestOptions) {
|
|
76
|
+
return core.HttpResponsePromise.fromPromise(this.__list(id, request, requestOptions));
|
|
77
|
+
}
|
|
78
|
+
__list(id_1) {
|
|
79
|
+
return __awaiter(this, arguments, void 0, function* (id, request = {}, requestOptions) {
|
|
80
|
+
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
81
|
+
const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)(Object.assign({}, (yield this._getCustomAuthorizationHeaders()))), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
82
|
+
const _response = yield core.fetcher({
|
|
83
|
+
url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PinnacleEnvironment.Default, `forms/${core.url.encodePathParam(id)}/submissions/list`),
|
|
84
|
+
method: "POST",
|
|
85
|
+
headers: _headers,
|
|
86
|
+
contentType: "application/json",
|
|
87
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
88
|
+
requestType: "json",
|
|
89
|
+
body: request,
|
|
90
|
+
timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
|
|
91
|
+
maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
|
|
92
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
93
|
+
fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
|
|
94
|
+
logging: this._options.logging,
|
|
95
|
+
});
|
|
96
|
+
if (_response.ok) {
|
|
97
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
98
|
+
}
|
|
99
|
+
if (_response.error.reason === "status-code") {
|
|
100
|
+
switch (_response.error.statusCode) {
|
|
101
|
+
case 400:
|
|
102
|
+
throw new Pinnacle.BadRequestError(_response.error.body, _response.rawResponse);
|
|
103
|
+
case 401:
|
|
104
|
+
throw new Pinnacle.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
105
|
+
case 404:
|
|
106
|
+
throw new Pinnacle.NotFoundError(_response.error.body, _response.rawResponse);
|
|
107
|
+
case 500:
|
|
108
|
+
throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
|
|
109
|
+
default:
|
|
110
|
+
throw new errors.PinnacleError({
|
|
111
|
+
statusCode: _response.error.statusCode,
|
|
112
|
+
body: _response.error.body,
|
|
113
|
+
rawResponse: _response.rawResponse,
|
|
114
|
+
});
|
|
115
|
+
}
|
|
116
|
+
}
|
|
117
|
+
switch (_response.error.reason) {
|
|
118
|
+
case "non-json":
|
|
119
|
+
throw new errors.PinnacleError({
|
|
120
|
+
statusCode: _response.error.statusCode,
|
|
121
|
+
body: _response.error.rawBody,
|
|
122
|
+
rawResponse: _response.rawResponse,
|
|
123
|
+
});
|
|
124
|
+
case "timeout":
|
|
125
|
+
throw new errors.PinnacleTimeoutError("Timeout exceeded when calling POST /forms/{id}/submissions/list.");
|
|
126
|
+
case "unknown":
|
|
127
|
+
throw new errors.PinnacleError({
|
|
128
|
+
message: _response.error.errorMessage,
|
|
129
|
+
rawResponse: _response.rawResponse,
|
|
130
|
+
});
|
|
131
|
+
}
|
|
132
|
+
});
|
|
133
|
+
}
|
|
134
|
+
_getCustomAuthorizationHeaders() {
|
|
135
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
136
|
+
const apiKeyValue = yield core.Supplier.get(this._options.apiKey);
|
|
137
|
+
return { "PINNACLE-API-KEY": apiKeyValue };
|
|
138
|
+
});
|
|
139
|
+
}
|
|
140
|
+
}
|
|
141
|
+
exports.Submissions = Submissions;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "./requests/index.js";
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
__exportStar(require("./requests/index.js"), exports);
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @example
|
|
3
|
+
* {
|
|
4
|
+
* pageIndex: 0,
|
|
5
|
+
* pageSize: 20
|
|
6
|
+
* }
|
|
7
|
+
*/
|
|
8
|
+
export interface ListFormSubmissionsParams {
|
|
9
|
+
/** Zero-based page index. */
|
|
10
|
+
pageIndex?: number;
|
|
11
|
+
/** Number of submissions to return in a single page. Max 100. */
|
|
12
|
+
pageSize?: number;
|
|
13
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export type { ListFormSubmissionsParams } from "./ListFormSubmissionsParams.js";
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "./client/index.js";
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
__exportStar(require("./client/index.js"), exports);
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "./FormsSendResponse.js";
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
__exportStar(require("./FormsSendResponse.js"), exports);
|
|
@@ -9,6 +9,9 @@ export * as contacts from "./contacts/index.js";
|
|
|
9
9
|
export * from "./conversations/client/requests/index.js";
|
|
10
10
|
export * as conversations from "./conversations/index.js";
|
|
11
11
|
export * from "./conversations/types/index.js";
|
|
12
|
+
export * from "./forms/client/requests/index.js";
|
|
13
|
+
export * as forms from "./forms/index.js";
|
|
14
|
+
export * from "./forms/types/index.js";
|
|
12
15
|
export * from "./messages/client/requests/index.js";
|
|
13
16
|
export * as messages from "./messages/index.js";
|
|
14
17
|
export * from "./phoneNumbers/client/requests/index.js";
|
|
@@ -36,7 +36,7 @@ var __importStar = (this && this.__importStar) || (function () {
|
|
|
36
36
|
};
|
|
37
37
|
})();
|
|
38
38
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
39
|
-
exports.webhooks = exports.tools = exports.status = exports.rcs = exports.phoneNumbers = exports.messages = exports.conversations = exports.contacts = exports.campaigns = exports.brands = exports.audiences = void 0;
|
|
39
|
+
exports.webhooks = exports.tools = exports.status = exports.rcs = exports.phoneNumbers = exports.messages = exports.forms = exports.conversations = exports.contacts = exports.campaigns = exports.brands = exports.audiences = void 0;
|
|
40
40
|
__exportStar(require("./audiences/client/requests/index.js"), exports);
|
|
41
41
|
exports.audiences = __importStar(require("./audiences/index.js"));
|
|
42
42
|
__exportStar(require("./audiences/types/index.js"), exports);
|
|
@@ -48,6 +48,9 @@ exports.contacts = __importStar(require("./contacts/index.js"));
|
|
|
48
48
|
__exportStar(require("./conversations/client/requests/index.js"), exports);
|
|
49
49
|
exports.conversations = __importStar(require("./conversations/index.js"));
|
|
50
50
|
__exportStar(require("./conversations/types/index.js"), exports);
|
|
51
|
+
__exportStar(require("./forms/client/requests/index.js"), exports);
|
|
52
|
+
exports.forms = __importStar(require("./forms/index.js"));
|
|
53
|
+
__exportStar(require("./forms/types/index.js"), exports);
|
|
51
54
|
__exportStar(require("./messages/client/requests/index.js"), exports);
|
|
52
55
|
exports.messages = __importStar(require("./messages/index.js"));
|
|
53
56
|
__exportStar(require("./phoneNumbers/client/requests/index.js"), exports);
|
|
@@ -21,7 +21,7 @@ export interface AttachWebhookParams {
|
|
|
21
21
|
/**
|
|
22
22
|
* Event type filter for the subscription. Set to `null` to receive all events. <br>
|
|
23
23
|
*
|
|
24
|
-
* `USER.TYPING`
|
|
24
|
+
* `USER.TYPING` and `CAMPAIGN.STATUS` are only supported for RCS agent senders, not phone numbers — attempting to attach either of these events to a phone number returns `400 Bad Request`.
|
|
25
25
|
*/
|
|
26
26
|
event?: Pinnacle.WebhookEventEnum | null;
|
|
27
27
|
/**
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import type * as Pinnacle from "../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* Free-form text input backed by a client-side Google Places autocomplete. Shares text-field validation (length / pattern); the place lookup happens entirely in the browser and is purely for suggestion UX.
|
|
4
|
+
*/
|
|
5
|
+
export interface AddressField extends Pinnacle.FieldBase {
|
|
6
|
+
/** Ghost text shown inside the input while it's empty. */
|
|
7
|
+
placeholder?: string;
|
|
8
|
+
/** Regex the value must match. Same RE2 safety check as `TextField.pattern`. Rarely needed for addresses — usually left off. */
|
|
9
|
+
pattern?: string;
|
|
10
|
+
/** Minimum number of characters in the selected address. */
|
|
11
|
+
min_length?: number;
|
|
12
|
+
/** Maximum number of characters in the selected address. */
|
|
13
|
+
max_length?: number;
|
|
14
|
+
}
|
|
@@ -5,7 +5,13 @@ export interface AgentSummary {
|
|
|
5
5
|
agentType: AgentSummary.AgentType;
|
|
6
6
|
/** Service ID associated with the agent. */
|
|
7
7
|
serviceId?: string | null;
|
|
8
|
-
/**
|
|
8
|
+
/**
|
|
9
|
+
* Raw per-carrier launch + verification state for the agent. Each
|
|
10
|
+
* value is tri-state — `null` means "no launch requested" or "not
|
|
11
|
+
* sent yet"; `false` means "pending" / "sent"; `true` means
|
|
12
|
+
* "launched" / "verified". Use the [GET /rcs/{agentId}](/api-reference/rcs-agents/get)
|
|
13
|
+
* endpoint for the resolved enum representation.
|
|
14
|
+
*/
|
|
9
15
|
carrierLaunches?: AgentSummary.CarrierLaunches | null;
|
|
10
16
|
/** Agent configuration details. */
|
|
11
17
|
config?: AgentSummary.Config | null;
|
|
@@ -22,7 +28,11 @@ export declare namespace AgentSummary {
|
|
|
22
28
|
};
|
|
23
29
|
type AgentType = (typeof AgentType)[keyof typeof AgentType];
|
|
24
30
|
/**
|
|
25
|
-
*
|
|
31
|
+
* Raw per-carrier launch + verification state for the agent. Each
|
|
32
|
+
* value is tri-state — `null` means "no launch requested" or "not
|
|
33
|
+
* sent yet"; `false` means "pending" / "sent"; `true` means
|
|
34
|
+
* "launched" / "verified". Use the [GET /rcs/{agentId}](/api-reference/rcs-agents/get)
|
|
35
|
+
* endpoint for the resolved enum representation.
|
|
26
36
|
*/
|
|
27
37
|
interface CarrierLaunches {
|
|
28
38
|
/** Launch status for AT&T. null = not requested, false = pending, true = launched. */
|
|
@@ -33,6 +43,10 @@ export declare namespace AgentSummary {
|
|
|
33
43
|
TMOBILE?: boolean | null;
|
|
34
44
|
/** Launch status for Verizon. null = not requested, false = pending, true = launched. */
|
|
35
45
|
VERIZON?: boolean | null;
|
|
46
|
+
/** AEGIS verification status. null = not sent, false = sent, true = verified. */
|
|
47
|
+
AEGIS?: boolean | null;
|
|
48
|
+
/** Google verification status. null = not sent, false = sent, true = verified. */
|
|
49
|
+
GOOGLE?: boolean | null;
|
|
36
50
|
}
|
|
37
51
|
/**
|
|
38
52
|
* Agent configuration details.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import type * as Pinnacle from "../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* Webhook body delivered to subscribers of `CAMPAIGN.STATUS` whenever
|
|
4
|
+
* an RCS campaign's per-carrier launch status or verification status
|
|
5
|
+
* (AEGIS / Google) changes. `CAMPAIGN.STATUS` is only supported for
|
|
6
|
+
* RCS agent senders — the attach call rejects phone-number senders
|
|
7
|
+
* with `400 Bad Request`. Verify the `PINNACLE-SIGNING-SECRET` header
|
|
8
|
+
* matches the signing secret of the webhook this event was delivered
|
|
9
|
+
* to before trusting the payload.
|
|
10
|
+
*/
|
|
11
|
+
export interface CampaignStatusEvent {
|
|
12
|
+
type: "CAMPAIGN.STATUS";
|
|
13
|
+
agent: Pinnacle.CampaignStatusEventAgent;
|
|
14
|
+
campaign: Pinnacle.CampaignStatusEventCampaign;
|
|
15
|
+
brand: Pinnacle.CampaignStatusEventBrand;
|
|
16
|
+
carrierLaunches: Pinnacle.CampaignStatusEventCarrierLaunches;
|
|
17
|
+
/** ISO 8601 timestamp of when the change was applied. */
|
|
18
|
+
updatedAt: string;
|
|
19
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Reference to the brand owning the agent's connected campaign.
|
|
3
|
+
*/
|
|
4
|
+
export interface CampaignStatusEventBrand {
|
|
5
|
+
/** Brand public id (`b_*`). Null if no brand is linked. */
|
|
6
|
+
publicId: string | null;
|
|
7
|
+
/** Brand display name. Null if unset. */
|
|
8
|
+
name: string | null;
|
|
9
|
+
}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Reference to the connected campaign.
|
|
3
|
+
*/
|
|
4
|
+
export interface CampaignStatusEventCampaign {
|
|
5
|
+
/** Campaign public id (`rcs_*` for RCS campaigns). Null if the agent isn't yet linked to a campaign. */
|
|
6
|
+
publicId: string | null;
|
|
7
|
+
/** Campaign protocol — currently always `RCS` for `CAMPAIGN.STATUS` events. Future event variants may carry `TOLL_FREE` or `10DLC`. */
|
|
8
|
+
type: CampaignStatusEventCampaign.Type;
|
|
9
|
+
}
|
|
10
|
+
export declare namespace CampaignStatusEventCampaign {
|
|
11
|
+
/** Campaign protocol — currently always `RCS` for `CAMPAIGN.STATUS` events. Future event variants may carry `TOLL_FREE` or `10DLC`. */
|
|
12
|
+
const Type: {
|
|
13
|
+
readonly Rcs: "RCS";
|
|
14
|
+
readonly TollFree: "TOLL_FREE";
|
|
15
|
+
readonly TenDlc: "10DLC";
|
|
16
|
+
};
|
|
17
|
+
type Type = (typeof Type)[keyof typeof Type];
|
|
18
|
+
}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.CampaignStatusEventCampaign = void 0;
|
|
5
|
+
var CampaignStatusEventCampaign;
|
|
6
|
+
(function (CampaignStatusEventCampaign) {
|
|
7
|
+
/** Campaign protocol — currently always `RCS` for `CAMPAIGN.STATUS` events. Future event variants may carry `TOLL_FREE` or `10DLC`. */
|
|
8
|
+
CampaignStatusEventCampaign.Type = {
|
|
9
|
+
Rcs: "RCS",
|
|
10
|
+
TollFree: "TOLL_FREE",
|
|
11
|
+
TenDlc: "10DLC",
|
|
12
|
+
};
|
|
13
|
+
})(CampaignStatusEventCampaign || (exports.CampaignStatusEventCampaign = CampaignStatusEventCampaign = {}));
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
import type * as Pinnacle from "../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* Resolved per-key launch status for the campaign's agent. Carrier
|
|
4
|
+
* statuses live under `carriers` and verifier statuses under
|
|
5
|
+
* `verification`.
|
|
6
|
+
*/
|
|
7
|
+
export interface CampaignStatusEventCarrierLaunches {
|
|
8
|
+
/**
|
|
9
|
+
* Per-carrier launch status. Each carrier moves through
|
|
10
|
+
* `NOT_LAUNCHED` → `PENDING` → `LAUNCHED` as Pinnacle submits the
|
|
11
|
+
* agent for review and the carrier accepts it. The agent is only
|
|
12
|
+
* deliverable on a carrier once that carrier reports `LAUNCHED`.
|
|
13
|
+
*/
|
|
14
|
+
carriers: CampaignStatusEventCarrierLaunches.Carriers;
|
|
15
|
+
/**
|
|
16
|
+
* External verifier status. AEGIS (the U.S. carrier vetting
|
|
17
|
+
* authority used by AT&T, T-Mobile, and Verizon) and Google each
|
|
18
|
+
* send a verification email to the brand's contact address. Each
|
|
19
|
+
* verifier moves through `NOT_SENT` → `SENT` → `VERIFIED` once
|
|
20
|
+
* the brand replies and the verifier confirms ownership.
|
|
21
|
+
*/
|
|
22
|
+
verification: CampaignStatusEventCarrierLaunches.Verification;
|
|
23
|
+
}
|
|
24
|
+
export declare namespace CampaignStatusEventCarrierLaunches {
|
|
25
|
+
/**
|
|
26
|
+
* Per-carrier launch status. Each carrier moves through
|
|
27
|
+
* `NOT_LAUNCHED` → `PENDING` → `LAUNCHED` as Pinnacle submits the
|
|
28
|
+
* agent for review and the carrier accepts it. The agent is only
|
|
29
|
+
* deliverable on a carrier once that carrier reports `LAUNCHED`.
|
|
30
|
+
*/
|
|
31
|
+
interface Carriers {
|
|
32
|
+
ATT: Pinnacle.CarrierLaunchStatus;
|
|
33
|
+
TMOBILE: Pinnacle.CarrierLaunchStatus;
|
|
34
|
+
VERIZON: Pinnacle.CarrierLaunchStatus;
|
|
35
|
+
OTHERS: Pinnacle.CarrierLaunchStatus;
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* External verifier status. AEGIS (the U.S. carrier vetting
|
|
39
|
+
* authority used by AT&T, T-Mobile, and Verizon) and Google each
|
|
40
|
+
* send a verification email to the brand's contact address. Each
|
|
41
|
+
* verifier moves through `NOT_SENT` → `SENT` → `VERIFIED` once
|
|
42
|
+
* the brand replies and the verifier confirms ownership.
|
|
43
|
+
*/
|
|
44
|
+
interface Verification {
|
|
45
|
+
AEGIS: Pinnacle.VerificationStatus;
|
|
46
|
+
GOOGLE: Pinnacle.VerificationStatus;
|
|
47
|
+
}
|
|
48
|
+
}
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
|
-
*
|
|
3
|
-
*
|
|
4
|
-
*
|
|
5
|
-
*
|
|
2
|
+
* Status of an RCS agent's launch on a specific carrier.
|
|
3
|
+
* - `NOT_LAUNCHED` — no launch requested yet
|
|
4
|
+
* - `PENDING` — submitted to the carrier, review in progress
|
|
5
|
+
* - `LAUNCHED` — live on the carrier
|
|
6
6
|
*/
|
|
7
7
|
export declare const CarrierLaunchStatus: {
|
|
8
8
|
readonly NotLaunched: "NOT_LAUNCHED";
|
|
@@ -3,10 +3,10 @@
|
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
4
|
exports.CarrierLaunchStatus = void 0;
|
|
5
5
|
/**
|
|
6
|
-
*
|
|
7
|
-
*
|
|
8
|
-
*
|
|
9
|
-
*
|
|
6
|
+
* Status of an RCS agent's launch on a specific carrier.
|
|
7
|
+
* - `NOT_LAUNCHED` — no launch requested yet
|
|
8
|
+
* - `PENDING` — submitted to the carrier, review in progress
|
|
9
|
+
* - `LAUNCHED` — live on the carrier
|
|
10
10
|
*/
|
|
11
11
|
exports.CarrierLaunchStatus = {
|
|
12
12
|
NotLaunched: "NOT_LAUNCHED",
|
|
@@ -1,14 +1,54 @@
|
|
|
1
1
|
import type * as Pinnacle from "../index.js";
|
|
2
2
|
/**
|
|
3
|
-
* Per-carrier launch status.
|
|
3
|
+
* Per-carrier launch status grouped by category. `carriers` covers
|
|
4
|
+
* AT&T / T-Mobile / Verizon / other carriers; `verification` covers
|
|
5
|
+
* the AEGIS and Google verification flows.
|
|
4
6
|
*/
|
|
5
7
|
export interface CarrierLaunches {
|
|
6
|
-
/**
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
8
|
+
/**
|
|
9
|
+
* Per-carrier launch status. Each carrier moves through
|
|
10
|
+
* `NOT_LAUNCHED` → `PENDING` → `LAUNCHED` as Pinnacle submits the
|
|
11
|
+
* agent for review and the carrier accepts it. The agent is only
|
|
12
|
+
* deliverable on a carrier once that carrier reports `LAUNCHED`.
|
|
13
|
+
*/
|
|
14
|
+
carriers: CarrierLaunches.Carriers;
|
|
15
|
+
/**
|
|
16
|
+
* External verifier status. AEGIS (the U.S. carrier vetting
|
|
17
|
+
* authority used by AT&T, T-Mobile, and Verizon) and Google each
|
|
18
|
+
* send a verification email to the brand's contact address. Each
|
|
19
|
+
* verifier moves through `NOT_SENT` → `SENT` → `VERIFIED` once
|
|
20
|
+
* the brand replies and the verifier confirms ownership.
|
|
21
|
+
*/
|
|
22
|
+
verification: CarrierLaunches.Verification;
|
|
23
|
+
}
|
|
24
|
+
export declare namespace CarrierLaunches {
|
|
25
|
+
/**
|
|
26
|
+
* Per-carrier launch status. Each carrier moves through
|
|
27
|
+
* `NOT_LAUNCHED` → `PENDING` → `LAUNCHED` as Pinnacle submits the
|
|
28
|
+
* agent for review and the carrier accepts it. The agent is only
|
|
29
|
+
* deliverable on a carrier once that carrier reports `LAUNCHED`.
|
|
30
|
+
*/
|
|
31
|
+
interface Carriers {
|
|
32
|
+
/** AT&T launch status. */
|
|
33
|
+
ATT: Pinnacle.CarrierLaunchStatus;
|
|
34
|
+
/** T-Mobile launch status. */
|
|
35
|
+
TMOBILE: Pinnacle.CarrierLaunchStatus;
|
|
36
|
+
/** Verizon launch status. */
|
|
37
|
+
VERIZON: Pinnacle.CarrierLaunchStatus;
|
|
38
|
+
/** Other carriers launch status. */
|
|
39
|
+
OTHERS: Pinnacle.CarrierLaunchStatus;
|
|
40
|
+
}
|
|
41
|
+
/**
|
|
42
|
+
* External verifier status. AEGIS (the U.S. carrier vetting
|
|
43
|
+
* authority used by AT&T, T-Mobile, and Verizon) and Google each
|
|
44
|
+
* send a verification email to the brand's contact address. Each
|
|
45
|
+
* verifier moves through `NOT_SENT` → `SENT` → `VERIFIED` once
|
|
46
|
+
* the brand replies and the verifier confirms ownership.
|
|
47
|
+
*/
|
|
48
|
+
interface Verification {
|
|
49
|
+
/** AEGIS verification status. */
|
|
50
|
+
AEGIS: Pinnacle.VerificationStatus;
|
|
51
|
+
/** Google verification status. */
|
|
52
|
+
GOOGLE: Pinnacle.VerificationStatus;
|
|
53
|
+
}
|
|
14
54
|
}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import type * as Pinnacle from "../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* Multi-select checkbox group when `options` is provided. If `options` is omitted the field renders as a single boolean checkbox.
|
|
4
|
+
*/
|
|
5
|
+
export interface CheckboxField extends Pinnacle.FieldBase {
|
|
6
|
+
/** Choices shown as checkboxes. Omit to render a single boolean checkbox. */
|
|
7
|
+
options?: Pinnacle.FormFieldOption[];
|
|
8
|
+
/** Minimum number of boxes the submitter must check. */
|
|
9
|
+
min_selected?: number;
|
|
10
|
+
/** Maximum number of boxes the submitter may check. Extra boxes become uninteractive once the cap is reached. */
|
|
11
|
+
max_selected?: number;
|
|
12
|
+
}
|