pingram 1.0.28 → 1.0.29-alpha.1455

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (16) hide show
  1. package/dist/generated/src/models/AccountGetResponse.d.ts +25 -6
  2. package/dist/generated/src/models/AccountGetResponse.js +23 -7
  3. package/dist/generated/src/models/BillingPostResponseBody.d.ts +25 -6
  4. package/dist/generated/src/models/BillingPostResponseBody.js +21 -5
  5. package/dist/generated/src/models/TenDlcBrandAdminUpdateRequest.d.ts +13 -13
  6. package/dist/generated/src/models/TenDlcBrandCreateRequest.d.ts +22 -16
  7. package/dist/generated/src/models/TenDlcBrandCreateRequest.js +16 -6
  8. package/dist/generated/src/models/TenDlcBrandRegistration.d.ts +13 -13
  9. package/dist/generated/src/models/TenDlcBrandRegistrationDetails.d.ts +13 -13
  10. package/dist/generated/src/models/TenDlcBrandUpdateRequest.d.ts +13 -13
  11. package/dist/generated/src/models/TenDlcCampaignAdminUpdateRequest.d.ts +20 -20
  12. package/dist/generated/src/models/TenDlcCampaignRegistration.d.ts +20 -20
  13. package/dist/generated/src/models/TenDlcCampaignRegistrationDetails.d.ts +20 -20
  14. package/dist/generated/src/models/TenDlcCampaignUpdateRequest.d.ts +20 -20
  15. package/dist/src/client.js +1 -1
  16. package/package.json +1 -1
package/dist/generated/src/models/TenDlcBrandUpdateRequest.d.ts CHANGED
@@ -35,79 +35,79 @@ export interface TenDlcBrandUpdateRequest {
35
35
  */
36
36
  businessType?: TenDlcBrandUpdateRequestBusinessTypeEnum;
37
37
  /**
38
- *
38
+ * Official registered legal business name. For SOLE_PROPRIETOR, optional DBA or trade name (defaults to firstName and lastName).
39
39
  * @type {string}
40
40
  * @memberof TenDlcBrandUpdateRequest
41
41
  */
42
42
  legalName?: string;
43
43
  /**
44
- * Brand display name (marketing/DBA); defaults to legalName when omitted on legalName-only updates.
44
+ * Public brand name shown to recipients and carriers. Use the name customers recognize (your DBA or trade name). For SOLE_PROPRIETOR, this is the brand you send as — not the individual's legal name. Omit to keep the existing value. If you change legalName and omit displayName, displayName is reset to the new legalName.
45
45
  * @type {string}
46
46
  * @memberof TenDlcBrandUpdateRequest
47
47
  */
48
48
  displayName?: string;
49
49
  /**
50
- *
50
+ * Legal first name of the sole proprietor. Required when businessType is SOLE_PROPRIETOR.
51
51
  * @type {string}
52
52
  * @memberof TenDlcBrandUpdateRequest
53
53
  */
54
54
  firstName?: string;
55
55
  /**
56
- *
56
+ * Legal last name of the sole proprietor. Required when businessType is SOLE_PROPRIETOR.
57
57
  * @type {string}
58
58
  * @memberof TenDlcBrandUpdateRequest
59
59
  */
60
60
  lastName?: string;
61
61
  /**
62
- * For US companies (country US): 9-digit EIN (Employer Identification Number). For Canada (country CA): 9-digit BN (Business Number). For other countries: national business tax identifier.
62
+ * For US companies (country US): 9-digit EIN (Employer Identification Number). For Canada (country CA): 9-digit BN (Business Number). For other countries: national business tax identifier. Required except when businessType is SOLE_PROPRIETOR.
63
63
  * @type {string}
64
64
  * @memberof TenDlcBrandUpdateRequest
65
65
  */
66
66
  taxId?: string;
67
67
  /**
68
- *
68
+ * Public website for the brand. Include a scheme (https://) or a domain; https:// is prepended when omitted. Carriers expect a working site with privacy policy and terms.
69
69
  * @type {string}
70
70
  * @memberof TenDlcBrandUpdateRequest
71
71
  */
72
72
  website?: string;
73
73
  /**
74
- *
74
+ * ISO 3166-1 alpha-2 country of incorporation (for example US or CA).
75
75
  * @type {string}
76
76
  * @memberof TenDlcBrandUpdateRequest
77
77
  */
78
78
  country?: string;
79
79
  /**
80
- *
80
+ * Street address that matches official tax registration.
81
81
  * @type {string}
82
82
  * @memberof TenDlcBrandUpdateRequest
83
83
  */
84
84
  street?: string;
85
85
  /**
86
- *
86
+ * City that matches official tax registration.
87
87
  * @type {string}
88
88
  * @memberof TenDlcBrandUpdateRequest
89
89
  */
90
90
  city?: string;
91
91
  /**
92
- *
92
+ * State (US) or province (CA) that matches official tax registration.
93
93
  * @type {string}
94
94
  * @memberof TenDlcBrandUpdateRequest
95
95
  */
96
96
  state?: string;
97
97
  /**
98
- *
98
+ * ZIP code (US) or postal code (CA) that matches official tax registration.
99
99
  * @type {string}
100
100
  * @memberof TenDlcBrandUpdateRequest
101
101
  */
102
102
  postalCode?: string;
103
103
  /**
104
- *
104
+ * Email for the 10DLC compliance contact. Used for carrier and registration follow-up.
105
105
  * @type {string}
106
106
  * @memberof TenDlcBrandUpdateRequest
107
107
  */
108
108
  complianceContactEmail?: string;
109
109
  /**
110
- *
110
+ * Phone number for the 10DLC compliance contact. E.164 preferred; national numbers are normalized using country.
111
111
  * @type {string}
112
112
  * @memberof TenDlcBrandUpdateRequest
113
113
  */
package/dist/generated/src/models/TenDlcCampaignAdminUpdateRequest.d.ts CHANGED
@@ -16,121 +16,121 @@
16
16
  */
17
17
  export interface TenDlcCampaignAdminUpdateRequest {
18
18
  /**
19
- *
19
+ * Summary of what this campaign sends and why, including audience and typical message content. Required before carrier submission.
20
20
  * @type {string}
21
21
  * @memberof TenDlcCampaignAdminUpdateRequest
22
22
  */
23
23
  campaignDescription?: string;
24
24
  /**
25
- *
25
+ * Example SMS that represents actual campaign traffic. Required before carrier submission. Should match the use case and typically identify the brand and include STOP/HELP language.
26
26
  * @type {string}
27
27
  * @memberof TenDlcCampaignAdminUpdateRequest
28
28
  */
29
29
  campaignSample1?: string;
30
30
  /**
31
- *
31
+ * Second example SMS. Required before carrier submission. Required for MARKETING and MIXED use cases.
32
32
  * @type {string}
33
33
  * @memberof TenDlcCampaignAdminUpdateRequest
34
34
  */
35
35
  campaignSample2?: string;
36
36
  /**
37
- *
37
+ * Optional third example SMS.
38
38
  * @type {string}
39
39
  * @memberof TenDlcCampaignAdminUpdateRequest
40
40
  */
41
41
  campaignSample3?: string;
42
42
  /**
43
- *
43
+ * Optional fourth example SMS.
44
44
  * @type {string}
45
45
  * @memberof TenDlcCampaignAdminUpdateRequest
46
46
  */
47
47
  campaignSample4?: string;
48
48
  /**
49
- *
49
+ * How recipients opt in (for example website form, checkout, or keyword). Describe the call-to-action and where consent is collected. Required before carrier submission.
50
50
  * @type {string}
51
51
  * @memberof TenDlcCampaignAdminUpdateRequest
52
52
  */
53
53
  campaignMessageFlow?: string;
54
54
  /**
55
- *
55
+ * Extra opt-in keywords as a comma-separated list. START is always included.
56
56
  * @type {string}
57
57
  * @memberof TenDlcCampaignAdminUpdateRequest
58
58
  */
59
59
  campaignOptinKeywords?: string;
60
60
  /**
61
- *
61
+ * Auto-reply sent when a recipient opts in. Required before carrier submission. Should confirm the subscription, mention message frequency, and include STOP and HELP instructions.
62
62
  * @type {string}
63
63
  * @memberof TenDlcCampaignAdminUpdateRequest
64
64
  */
65
65
  campaignOptinMessage?: string;
66
66
  /**
67
- *
67
+ * Extra opt-out keywords as a comma-separated list. STOP is always included.
68
68
  * @type {string}
69
69
  * @memberof TenDlcCampaignAdminUpdateRequest
70
70
  */
71
71
  campaignOptoutKeywords?: string;
72
72
  /**
73
- *
73
+ * Auto-reply sent when a recipient opts out. Required before carrier submission. Should confirm they will receive no further messages.
74
74
  * @type {string}
75
75
  * @memberof TenDlcCampaignAdminUpdateRequest
76
76
  */
77
77
  campaignOptoutMessage?: string;
78
78
  /**
79
- *
79
+ * Extra help keywords as a comma-separated list. HELP is always included.
80
80
  * @type {string}
81
81
  * @memberof TenDlcCampaignAdminUpdateRequest
82
82
  */
83
83
  campaignHelpKeywords?: string;
84
84
  /**
85
- *
85
+ * Auto-reply sent when a recipient texts a help keyword. Required before carrier submission. Should include a support contact (email and/or phone).
86
86
  * @type {string}
87
87
  * @memberof TenDlcCampaignAdminUpdateRequest
88
88
  */
89
89
  campaignHelpMessage?: string;
90
90
  /**
91
- *
91
+ * Whether campaign messages include URLs.
92
92
  * @type {boolean}
93
93
  * @memberof TenDlcCampaignAdminUpdateRequest
94
94
  */
95
95
  campaignEmbeddedLink?: boolean;
96
96
  /**
97
- *
97
+ * Sample URL that appears in messages. Provide when campaignEmbeddedLink is true.
98
98
  * @type {string}
99
99
  * @memberof TenDlcCampaignAdminUpdateRequest
100
100
  */
101
101
  campaignEmbeddedLinkUrl?: string;
102
102
  /**
103
- *
103
+ * Whether campaign messages include phone numbers.
104
104
  * @type {boolean}
105
105
  * @memberof TenDlcCampaignAdminUpdateRequest
106
106
  */
107
107
  campaignEmbeddedPhone?: boolean;
108
108
  /**
109
- *
109
+ * Whether campaign content is age-restricted (18+).
110
110
  * @type {boolean}
111
111
  * @memberof TenDlcCampaignAdminUpdateRequest
112
112
  */
113
113
  campaignAgeGated?: boolean;
114
114
  /**
115
- *
115
+ * Whether the campaign relates to direct lending or loan products.
116
116
  * @type {boolean}
117
117
  * @memberof TenDlcCampaignAdminUpdateRequest
118
118
  */
119
119
  campaignDirectLending?: boolean;
120
120
  /**
121
- *
121
+ * Public URL of the privacy policy that covers this SMS program.
122
122
  * @type {string}
123
123
  * @memberof TenDlcCampaignAdminUpdateRequest
124
124
  */
125
125
  campaignPrivacyPolicyLink?: string;
126
126
  /**
127
- *
127
+ * Public URL of the terms and conditions that cover this SMS program.
128
128
  * @type {string}
129
129
  * @memberof TenDlcCampaignAdminUpdateRequest
130
130
  */
131
131
  campaignTermsAndConditionsLink?: string;
132
132
  /**
133
- *
133
+ * 10DLC campaign use case submitted to carriers. Required before carrier submission. One of 2FA, ACCOUNT_NOTIFICATION, CUSTOMER_CARE, DELIVERY_NOTIFICATION, FRAUD_ALERT, MARKETING, MIXED, POLLING_VOTING, PUBLIC_SERVICE_ANNOUNCEMENT, or SECURITY_ALERT. For MIXED, append comma-separated sub-use cases after MIXED (sub-use cases cannot include MIXED), for example MIXED,2FA,ACCOUNT_NOTIFICATION.
134
134
  * @type {string}
135
135
  * @memberof TenDlcCampaignAdminUpdateRequest
136
136
  */
package/dist/generated/src/models/TenDlcCampaignRegistration.d.ts CHANGED
@@ -32,121 +32,121 @@ export interface TenDlcCampaignRegistration {
32
32
  */
33
33
  campaignStatus: TenDlcCampaignRegistrationCampaignStatusEnum;
34
34
  /**
35
- *
35
+ * Summary of what this campaign sends and why, including audience and typical message content. Required before carrier submission.
36
36
  * @type {string}
37
37
  * @memberof TenDlcCampaignRegistration
38
38
  */
39
39
  campaignDescription?: string;
40
40
  /**
41
- *
41
+ * Example SMS that represents actual campaign traffic. Required before carrier submission. Should match the use case and typically identify the brand and include STOP/HELP language.
42
42
  * @type {string}
43
43
  * @memberof TenDlcCampaignRegistration
44
44
  */
45
45
  campaignSample1?: string;
46
46
  /**
47
- *
47
+ * Second example SMS. Required before carrier submission. Required for MARKETING and MIXED use cases.
48
48
  * @type {string}
49
49
  * @memberof TenDlcCampaignRegistration
50
50
  */
51
51
  campaignSample2?: string;
52
52
  /**
53
- *
53
+ * Optional third example SMS.
54
54
  * @type {string}
55
55
  * @memberof TenDlcCampaignRegistration
56
56
  */
57
57
  campaignSample3?: string;
58
58
  /**
59
- *
59
+ * Optional fourth example SMS.
60
60
  * @type {string}
61
61
  * @memberof TenDlcCampaignRegistration
62
62
  */
63
63
  campaignSample4?: string;
64
64
  /**
65
- *
65
+ * How recipients opt in (for example website form, checkout, or keyword). Describe the call-to-action and where consent is collected. Required before carrier submission.
66
66
  * @type {string}
67
67
  * @memberof TenDlcCampaignRegistration
68
68
  */
69
69
  campaignMessageFlow?: string;
70
70
  /**
71
- *
71
+ * Extra opt-in keywords as a comma-separated list. START is always included.
72
72
  * @type {string}
73
73
  * @memberof TenDlcCampaignRegistration
74
74
  */
75
75
  campaignOptinKeywords?: string;
76
76
  /**
77
- *
77
+ * Auto-reply sent when a recipient opts in. Required before carrier submission. Should confirm the subscription, mention message frequency, and include STOP and HELP instructions.
78
78
  * @type {string}
79
79
  * @memberof TenDlcCampaignRegistration
80
80
  */
81
81
  campaignOptinMessage?: string;
82
82
  /**
83
- *
83
+ * Extra opt-out keywords as a comma-separated list. STOP is always included.
84
84
  * @type {string}
85
85
  * @memberof TenDlcCampaignRegistration
86
86
  */
87
87
  campaignOptoutKeywords?: string;
88
88
  /**
89
- *
89
+ * Auto-reply sent when a recipient opts out. Required before carrier submission. Should confirm they will receive no further messages.
90
90
  * @type {string}
91
91
  * @memberof TenDlcCampaignRegistration
92
92
  */
93
93
  campaignOptoutMessage?: string;
94
94
  /**
95
- *
95
+ * Extra help keywords as a comma-separated list. HELP is always included.
96
96
  * @type {string}
97
97
  * @memberof TenDlcCampaignRegistration
98
98
  */
99
99
  campaignHelpKeywords?: string;
100
100
  /**
101
- *
101
+ * Auto-reply sent when a recipient texts a help keyword. Required before carrier submission. Should include a support contact (email and/or phone).
102
102
  * @type {string}
103
103
  * @memberof TenDlcCampaignRegistration
104
104
  */
105
105
  campaignHelpMessage?: string;
106
106
  /**
107
- *
107
+ * Whether campaign messages include URLs.
108
108
  * @type {boolean}
109
109
  * @memberof TenDlcCampaignRegistration
110
110
  */
111
111
  campaignEmbeddedLink?: boolean;
112
112
  /**
113
- *
113
+ * Sample URL that appears in messages. Provide when campaignEmbeddedLink is true.
114
114
  * @type {string}
115
115
  * @memberof TenDlcCampaignRegistration
116
116
  */
117
117
  campaignEmbeddedLinkUrl?: string;
118
118
  /**
119
- *
119
+ * Whether campaign messages include phone numbers.
120
120
  * @type {boolean}
121
121
  * @memberof TenDlcCampaignRegistration
122
122
  */
123
123
  campaignEmbeddedPhone?: boolean;
124
124
  /**
125
- *
125
+ * Whether campaign content is age-restricted (18+).
126
126
  * @type {boolean}
127
127
  * @memberof TenDlcCampaignRegistration
128
128
  */
129
129
  campaignAgeGated?: boolean;
130
130
  /**
131
- *
131
+ * Whether the campaign relates to direct lending or loan products.
132
132
  * @type {boolean}
133
133
  * @memberof TenDlcCampaignRegistration
134
134
  */
135
135
  campaignDirectLending?: boolean;
136
136
  /**
137
- *
137
+ * Public URL of the privacy policy that covers this SMS program.
138
138
  * @type {string}
139
139
  * @memberof TenDlcCampaignRegistration
140
140
  */
141
141
  campaignPrivacyPolicyLink?: string;
142
142
  /**
143
- *
143
+ * Public URL of the terms and conditions that cover this SMS program.
144
144
  * @type {string}
145
145
  * @memberof TenDlcCampaignRegistration
146
146
  */
147
147
  campaignTermsAndConditionsLink?: string;
148
148
  /**
149
- *
149
+ * 10DLC campaign use case submitted to carriers. Required before carrier submission. One of 2FA, ACCOUNT_NOTIFICATION, CUSTOMER_CARE, DELIVERY_NOTIFICATION, FRAUD_ALERT, MARKETING, MIXED, POLLING_VOTING, PUBLIC_SERVICE_ANNOUNCEMENT, or SECURITY_ALERT. For MIXED, append comma-separated sub-use cases after MIXED (sub-use cases cannot include MIXED), for example MIXED,2FA,ACCOUNT_NOTIFICATION.
150
150
  * @type {string}
151
151
  * @memberof TenDlcCampaignRegistration
152
152
  */
package/dist/generated/src/models/TenDlcCampaignRegistrationDetails.d.ts CHANGED
@@ -32,121 +32,121 @@ export interface TenDlcCampaignRegistrationDetails {
32
32
  */
33
33
  campaignStatus: TenDlcCampaignRegistrationDetailsCampaignStatusEnum;
34
34
  /**
35
- *
35
+ * Summary of what this campaign sends and why, including audience and typical message content. Required before carrier submission.
36
36
  * @type {string}
37
37
  * @memberof TenDlcCampaignRegistrationDetails
38
38
  */
39
39
  campaignDescription?: string;
40
40
  /**
41
- *
41
+ * Example SMS that represents actual campaign traffic. Required before carrier submission. Should match the use case and typically identify the brand and include STOP/HELP language.
42
42
  * @type {string}
43
43
  * @memberof TenDlcCampaignRegistrationDetails
44
44
  */
45
45
  campaignSample1?: string;
46
46
  /**
47
- *
47
+ * Second example SMS. Required before carrier submission. Required for MARKETING and MIXED use cases.
48
48
  * @type {string}
49
49
  * @memberof TenDlcCampaignRegistrationDetails
50
50
  */
51
51
  campaignSample2?: string;
52
52
  /**
53
- *
53
+ * Optional third example SMS.
54
54
  * @type {string}
55
55
  * @memberof TenDlcCampaignRegistrationDetails
56
56
  */
57
57
  campaignSample3?: string;
58
58
  /**
59
- *
59
+ * Optional fourth example SMS.
60
60
  * @type {string}
61
61
  * @memberof TenDlcCampaignRegistrationDetails
62
62
  */
63
63
  campaignSample4?: string;
64
64
  /**
65
- *
65
+ * How recipients opt in (for example website form, checkout, or keyword). Describe the call-to-action and where consent is collected. Required before carrier submission.
66
66
  * @type {string}
67
67
  * @memberof TenDlcCampaignRegistrationDetails
68
68
  */
69
69
  campaignMessageFlow?: string;
70
70
  /**
71
- *
71
+ * Extra opt-in keywords as a comma-separated list. START is always included.
72
72
  * @type {string}
73
73
  * @memberof TenDlcCampaignRegistrationDetails
74
74
  */
75
75
  campaignOptinKeywords?: string;
76
76
  /**
77
- *
77
+ * Auto-reply sent when a recipient opts in. Required before carrier submission. Should confirm the subscription, mention message frequency, and include STOP and HELP instructions.
78
78
  * @type {string}
79
79
  * @memberof TenDlcCampaignRegistrationDetails
80
80
  */
81
81
  campaignOptinMessage?: string;
82
82
  /**
83
- *
83
+ * Extra opt-out keywords as a comma-separated list. STOP is always included.
84
84
  * @type {string}
85
85
  * @memberof TenDlcCampaignRegistrationDetails
86
86
  */
87
87
  campaignOptoutKeywords?: string;
88
88
  /**
89
- *
89
+ * Auto-reply sent when a recipient opts out. Required before carrier submission. Should confirm they will receive no further messages.
90
90
  * @type {string}
91
91
  * @memberof TenDlcCampaignRegistrationDetails
92
92
  */
93
93
  campaignOptoutMessage?: string;
94
94
  /**
95
- *
95
+ * Extra help keywords as a comma-separated list. HELP is always included.
96
96
  * @type {string}
97
97
  * @memberof TenDlcCampaignRegistrationDetails
98
98
  */
99
99
  campaignHelpKeywords?: string;
100
100
  /**
101
- *
101
+ * Auto-reply sent when a recipient texts a help keyword. Required before carrier submission. Should include a support contact (email and/or phone).
102
102
  * @type {string}
103
103
  * @memberof TenDlcCampaignRegistrationDetails
104
104
  */
105
105
  campaignHelpMessage?: string;
106
106
  /**
107
- *
107
+ * Whether campaign messages include URLs.
108
108
  * @type {boolean}
109
109
  * @memberof TenDlcCampaignRegistrationDetails
110
110
  */
111
111
  campaignEmbeddedLink?: boolean;
112
112
  /**
113
- *
113
+ * Sample URL that appears in messages. Provide when campaignEmbeddedLink is true.
114
114
  * @type {string}
115
115
  * @memberof TenDlcCampaignRegistrationDetails
116
116
  */
117
117
  campaignEmbeddedLinkUrl?: string;
118
118
  /**
119
- *
119
+ * Whether campaign messages include phone numbers.
120
120
  * @type {boolean}
121
121
  * @memberof TenDlcCampaignRegistrationDetails
122
122
  */
123
123
  campaignEmbeddedPhone?: boolean;
124
124
  /**
125
- *
125
+ * Whether campaign content is age-restricted (18+).
126
126
  * @type {boolean}
127
127
  * @memberof TenDlcCampaignRegistrationDetails
128
128
  */
129
129
  campaignAgeGated?: boolean;
130
130
  /**
131
- *
131
+ * Whether the campaign relates to direct lending or loan products.
132
132
  * @type {boolean}
133
133
  * @memberof TenDlcCampaignRegistrationDetails
134
134
  */
135
135
  campaignDirectLending?: boolean;
136
136
  /**
137
- *
137
+ * Public URL of the privacy policy that covers this SMS program.
138
138
  * @type {string}
139
139
  * @memberof TenDlcCampaignRegistrationDetails
140
140
  */
141
141
  campaignPrivacyPolicyLink?: string;
142
142
  /**
143
- *
143
+ * Public URL of the terms and conditions that cover this SMS program.
144
144
  * @type {string}
145
145
  * @memberof TenDlcCampaignRegistrationDetails
146
146
  */
147
147
  campaignTermsAndConditionsLink?: string;
148
148
  /**
149
- *
149
+ * 10DLC campaign use case submitted to carriers. Required before carrier submission. One of 2FA, ACCOUNT_NOTIFICATION, CUSTOMER_CARE, DELIVERY_NOTIFICATION, FRAUD_ALERT, MARKETING, MIXED, POLLING_VOTING, PUBLIC_SERVICE_ANNOUNCEMENT, or SECURITY_ALERT. For MIXED, append comma-separated sub-use cases after MIXED (sub-use cases cannot include MIXED), for example MIXED,2FA,ACCOUNT_NOTIFICATION.
150
150
  * @type {string}
151
151
  * @memberof TenDlcCampaignRegistrationDetails
152
152
  */
package/dist/generated/src/models/TenDlcCampaignUpdateRequest.d.ts CHANGED
@@ -16,121 +16,121 @@
16
16
  */
17
17
  export interface TenDlcCampaignUpdateRequest {
18
18
  /**
19
- *
19
+ * Summary of what this campaign sends and why, including audience and typical message content. Required before carrier submission.
20
20
  * @type {string}
21
21
  * @memberof TenDlcCampaignUpdateRequest
22
22
  */
23
23
  campaignDescription?: string;
24
24
  /**
25
- *
25
+ * Example SMS that represents actual campaign traffic. Required before carrier submission. Should match the use case and typically identify the brand and include STOP/HELP language.
26
26
  * @type {string}
27
27
  * @memberof TenDlcCampaignUpdateRequest
28
28
  */
29
29
  campaignSample1?: string;
30
30
  /**
31
- *
31
+ * Second example SMS. Required before carrier submission. Required for MARKETING and MIXED use cases.
32
32
  * @type {string}
33
33
  * @memberof TenDlcCampaignUpdateRequest
34
34
  */
35
35
  campaignSample2?: string;
36
36
  /**
37
- *
37
+ * Optional third example SMS.
38
38
  * @type {string}
39
39
  * @memberof TenDlcCampaignUpdateRequest
40
40
  */
41
41
  campaignSample3?: string;
42
42
  /**
43
- *
43
+ * Optional fourth example SMS.
44
44
  * @type {string}
45
45
  * @memberof TenDlcCampaignUpdateRequest
46
46
  */
47
47
  campaignSample4?: string;
48
48
  /**
49
- *
49
+ * How recipients opt in (for example website form, checkout, or keyword). Describe the call-to-action and where consent is collected. Required before carrier submission.
50
50
  * @type {string}
51
51
  * @memberof TenDlcCampaignUpdateRequest
52
52
  */
53
53
  campaignMessageFlow?: string;
54
54
  /**
55
- *
55
+ * Extra opt-in keywords as a comma-separated list. START is always included.
56
56
  * @type {string}
57
57
  * @memberof TenDlcCampaignUpdateRequest
58
58
  */
59
59
  campaignOptinKeywords?: string;
60
60
  /**
61
- *
61
+ * Auto-reply sent when a recipient opts in. Required before carrier submission. Should confirm the subscription, mention message frequency, and include STOP and HELP instructions.
62
62
  * @type {string}
63
63
  * @memberof TenDlcCampaignUpdateRequest
64
64
  */
65
65
  campaignOptinMessage?: string;
66
66
  /**
67
- *
67
+ * Extra opt-out keywords as a comma-separated list. STOP is always included.
68
68
  * @type {string}
69
69
  * @memberof TenDlcCampaignUpdateRequest
70
70
  */
71
71
  campaignOptoutKeywords?: string;
72
72
  /**
73
- *
73
+ * Auto-reply sent when a recipient opts out. Required before carrier submission. Should confirm they will receive no further messages.
74
74
  * @type {string}
75
75
  * @memberof TenDlcCampaignUpdateRequest
76
76
  */
77
77
  campaignOptoutMessage?: string;
78
78
  /**
79
- *
79
+ * Extra help keywords as a comma-separated list. HELP is always included.
80
80
  * @type {string}
81
81
  * @memberof TenDlcCampaignUpdateRequest
82
82
  */
83
83
  campaignHelpKeywords?: string;
84
84
  /**
85
- *
85
+ * Auto-reply sent when a recipient texts a help keyword. Required before carrier submission. Should include a support contact (email and/or phone).
86
86
  * @type {string}
87
87
  * @memberof TenDlcCampaignUpdateRequest
88
88
  */
89
89
  campaignHelpMessage?: string;
90
90
  /**
91
- *
91
+ * Whether campaign messages include URLs.
92
92
  * @type {boolean}
93
93
  * @memberof TenDlcCampaignUpdateRequest
94
94
  */
95
95
  campaignEmbeddedLink?: boolean;
96
96
  /**
97
- *
97
+ * Sample URL that appears in messages. Provide when campaignEmbeddedLink is true.
98
98
  * @type {string}
99
99
  * @memberof TenDlcCampaignUpdateRequest
100
100
  */
101
101
  campaignEmbeddedLinkUrl?: string;
102
102
  /**
103
- *
103
+ * Whether campaign messages include phone numbers.
104
104
  * @type {boolean}
105
105
  * @memberof TenDlcCampaignUpdateRequest
106
106
  */
107
107
  campaignEmbeddedPhone?: boolean;
108
108
  /**
109
- *
109
+ * Whether campaign content is age-restricted (18+).
110
110
  * @type {boolean}
111
111
  * @memberof TenDlcCampaignUpdateRequest
112
112
  */
113
113
  campaignAgeGated?: boolean;
114
114
  /**
115
- *
115
+ * Whether the campaign relates to direct lending or loan products.
116
116
  * @type {boolean}
117
117
  * @memberof TenDlcCampaignUpdateRequest
118
118
  */
119
119
  campaignDirectLending?: boolean;
120
120
  /**
121
- *
121
+ * Public URL of the privacy policy that covers this SMS program.
122
122
  * @type {string}
123
123
  * @memberof TenDlcCampaignUpdateRequest
124
124
  */
125
125
  campaignPrivacyPolicyLink?: string;
126
126
  /**
127
- *
127
+ * Public URL of the terms and conditions that cover this SMS program.
128
128
  * @type {string}
129
129
  * @memberof TenDlcCampaignUpdateRequest
130
130
  */
131
131
  campaignTermsAndConditionsLink?: string;
132
132
  /**
133
- *
133
+ * 10DLC campaign use case submitted to carriers. Required before carrier submission. One of 2FA, ACCOUNT_NOTIFICATION, CUSTOMER_CARE, DELIVERY_NOTIFICATION, FRAUD_ALERT, MARKETING, MIXED, POLLING_VOTING, PUBLIC_SERVICE_ANNOUNCEMENT, or SECURITY_ALERT. For MIXED, append comma-separated sub-use cases after MIXED (sub-use cases cannot include MIXED), for example MIXED,2FA,ACCOUNT_NOTIFICATION.
134
134
  * @type {string}
135
135
  * @memberof TenDlcCampaignUpdateRequest
136
136
  */
package/dist/src/client.js CHANGED
@@ -8,7 +8,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
8
8
  exports.Pingram = void 0;
9
9
  const src_1 = require("../generated/src");
10
10
  // SDK version for User-Agent header (injected at codegen time)
11
- const SDK_VERSION = '1.0.28';
11
+ const SDK_VERSION = '1.0.29';
12
12
  const USER_AGENT = `pingram-node/${SDK_VERSION}`;
13
13
  const src_2 = require("../generated/src");
14
14
  const src_3 = require("../generated/src");
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "pingram",
3
- "version": "1.0.28",
3
+ "version": "1.0.29-alpha.1455",
4
4
  "description": "Official Node.js SDK for Pingram - Send notifications via Email, SMS, Push, In-App, and more",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.js",