@surgeapi/node 0.27.0 → 0.27.1

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 (17) hide show
  1. package/CHANGELOG.md +13 -0
  2. package/package.json +1 -1
  3. package/resources/accounts.d.mts +24 -10
  4. package/resources/accounts.d.mts.map +1 -1
  5. package/resources/accounts.d.ts +24 -10
  6. package/resources/accounts.d.ts.map +1 -1
  7. package/resources/campaigns.d.mts +107 -98
  8. package/resources/campaigns.d.mts.map +1 -1
  9. package/resources/campaigns.d.ts +107 -98
  10. package/resources/campaigns.d.ts.map +1 -1
  11. package/src/resources/accounts.ts +24 -10
  12. package/src/resources/campaigns.ts +122 -109
  13. package/src/version.ts +1 -1
  14. package/version.d.mts +1 -1
  15. package/version.d.ts +1 -1
  16. package/version.js +1 -1
  17. package/version.mjs +1 -1
package/CHANGELOG.md CHANGED
@@ -1,5 +1,18 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.27.1 (2025-10-31)
4
+
5
+ Full Changelog: [v0.27.0...v0.27.1](https://github.com/surgeapi/typescript-sdk/compare/v0.27.0...v0.27.1)
6
+
7
+ ### Features
8
+
9
+ * **api:** create externally registered campaigns ([fd962d4](https://github.com/surgeapi/typescript-sdk/commit/fd962d4c7e49290a10ff956efd808540bdacd76b))
10
+
11
+
12
+ ### Documentation
13
+
14
+ * **api:** add context around organization contacts ([cf40475](https://github.com/surgeapi/typescript-sdk/commit/cf40475f7d9e807089a17a8547e33c9f2c997e3d))
15
+
3
16
  ## 0.27.0 (2025-10-09)
4
17
 
5
18
  Full Changelog: [v0.26.0...v0.27.0](https://github.com/surgeapi/typescript-sdk/compare/v0.26.0...v0.27.0)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@surgeapi/node",
3
- "version": "0.27.0",
3
+ "version": "0.27.1",
4
4
  "description": "The official TypeScript library for the Surge API",
5
5
  "author": "Surge <support@surge.app>",
6
6
  "types": "./index.d.ts",
package/resources/accounts.d.mts CHANGED
@@ -300,8 +300,11 @@ export declare namespace AccountCreateParams {
300
300
  */
301
301
  address?: Organization.Address;
302
302
  /**
303
- * An object representing an individual who can be contacted if the carriers have
304
- * any questions about the business.
303
+ * An object representing an individual who can be contacted if Surge or our
304
+ * carrier partners have any questions about the business. If you are registering
305
+ * on behalf of your customer, this must be a contact from your customer's company
306
+ * rather than your own. The individual will likely never be contacted unless there
307
+ * are issues with spam.
305
308
  */
306
309
  contact?: Organization.Contact | null;
307
310
  /**
@@ -404,8 +407,11 @@ export declare namespace AccountCreateParams {
404
407
  region?: string | null;
405
408
  }
406
409
  /**
407
- * An object representing an individual who can be contacted if the carriers have
408
- * any questions about the business.
410
+ * An object representing an individual who can be contacted if Surge or our
411
+ * carrier partners have any questions about the business. If you are registering
412
+ * on behalf of your customer, this must be a contact from your customer's company
413
+ * rather than your own. The individual will likely never be contacted unless there
414
+ * are issues with spam.
409
415
  */
410
416
  interface Contact {
411
417
  /**
@@ -413,7 +419,8 @@ export declare namespace AccountCreateParams {
413
419
  * using the same domain name as the website URL will be preferred (e.g. with a
414
420
  * website domain of `https://dtprecisionauto.com`, an email like
415
421
  * `dom@dtprecisionauto.com` will be preferred over one like
416
- * `dom@anothergarage.com` or `dom.toretto@gmail.com`)
422
+ * `dom@anothergarage.com` or `dom.toretto@gmail.com`. `dtprecisionauto@gmail.com`
423
+ * would also be acceptable, but not preferred)
417
424
  */
418
425
  email?: string | null;
419
426
  /**
@@ -475,8 +482,11 @@ export declare namespace AccountUpdateParams {
475
482
  */
476
483
  address?: Organization.Address;
477
484
  /**
478
- * An object representing an individual who can be contacted if the carriers have
479
- * any questions about the business.
485
+ * An object representing an individual who can be contacted if Surge or our
486
+ * carrier partners have any questions about the business. If you are registering
487
+ * on behalf of your customer, this must be a contact from your customer's company
488
+ * rather than your own. The individual will likely never be contacted unless there
489
+ * are issues with spam.
480
490
  */
481
491
  contact?: Organization.Contact | null;
482
492
  /**
@@ -579,8 +589,11 @@ export declare namespace AccountUpdateParams {
579
589
  region?: string | null;
580
590
  }
581
591
  /**
582
- * An object representing an individual who can be contacted if the carriers have
583
- * any questions about the business.
592
+ * An object representing an individual who can be contacted if Surge or our
593
+ * carrier partners have any questions about the business. If you are registering
594
+ * on behalf of your customer, this must be a contact from your customer's company
595
+ * rather than your own. The individual will likely never be contacted unless there
596
+ * are issues with spam.
584
597
  */
585
598
  interface Contact {
586
599
  /**
@@ -588,7 +601,8 @@ export declare namespace AccountUpdateParams {
588
601
  * using the same domain name as the website URL will be preferred (e.g. with a
589
602
  * website domain of `https://dtprecisionauto.com`, an email like
590
603
  * `dom@dtprecisionauto.com` will be preferred over one like
591
- * `dom@anothergarage.com` or `dom.toretto@gmail.com`)
604
+ * `dom@anothergarage.com` or `dom.toretto@gmail.com`. `dtprecisionauto@gmail.com`
605
+ * would also be acceptable, but not preferred)
592
606
  */
593
607
  email?: string | null;
594
608
  /**
package/resources/accounts.d.mts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"accounts.d.mts","sourceRoot":"","sources":["../src/resources/accounts.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;OASG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAIhF;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAI5F;;;;;;;;;OASG;IACH,cAAc,CACZ,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,2BAA2B,GAAG,IAAI,GAAG,SAAc,EAC1D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,aAAa,CAAC;CAG7B;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;;;;OAMG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,YAAY,EAAE,YAAY,CAAC;IAE3B;;;OAGG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,YAAY,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,aAAa,CAAC,YAAY,CAAA;KAAE,CAAC;CAC7D;AAED,yBAAiB,aAAa,CAAC;IAC7B,UAAiB,YAAY;QAC3B;;;WAGG;QACH,MAAM,EAAE,KAAK,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;QAElC;;;WAGG;QACH,aAAa,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE7B;;;;WAIG;QACH,MAAM,EAAE,OAAO,GAAG,YAAY,GAAG,OAAO,CAAC;KAC1C;IAED,UAAiB,YAAY,CAAC;QAC5B,UAAiB,KAAK;YACpB;;;eAGG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,OAAO,EAAE,MAAM,CAAC;YAEhB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;SACd;KACF;CACF;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,OAAO,EAAE,YAAY,CAAC,OAAO,CAAC;IAE9B;;;OAGG;IACH,OAAO,EAAE,YAAY,CAAC,OAAO,CAAC;IAE9B;;;OAGG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;;;;;OAMG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;;OAIG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,eAAe,EAAE,KAAK,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,QAAQ,EACJ,aAAa,GACb,YAAY,GACZ,SAAS,GACT,cAAc,GACd,UAAU,GACV,WAAW,GACX,aAAa,GACb,QAAQ,GACR,aAAa,GACb,4BAA4B,GAC5B,WAAW,GACX,SAAS,GACT,mBAAmB,GACnB,YAAY,GACZ,YAAY,GACZ,aAAa,GACb,WAAW,GACX,SAAS,GACT,OAAO,GACP,eAAe,GACf,OAAO,GACP,gBAAgB,GAChB,aAAa,GACb,QAAQ,GACR,uBAAuB,GACvB,eAAe,GACf,aAAa,GACb,UAAU,GACV,QAAQ,GACR,YAAY,GACZ,oBAAoB,GACpB,gBAAgB,GAChB,QAAQ,GACR,IAAI,CAAC;IAET;;;OAGG;IACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,oBAAoB,EAAE,KAAK,CACzB,QAAQ,GAAG,MAAM,GAAG,WAAW,GAAG,QAAQ,GAAG,eAAe,GAAG,gBAAgB,CAChF,GAAG,IAAI,CAAC;IAET;;;;OAIG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;OAGG;IACH,cAAc,EACV,MAAM,GACN,KAAK,GACL,KAAK,GACL,IAAI,GACJ,KAAK,GACL,KAAK,GACL,KAAK,GACL,MAAM,GACN,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,QAAQ,GACR,MAAM,GACN,MAAM,GACN,KAAK,GACL,KAAK,GACL,OAAO,GACP,MAAM,GACN,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,MAAM,GACN,KAAK,GACL,MAAM,GACN,KAAK,GACL,IAAI,CAAC;IAET;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,IAAI,EACA,OAAO,GACP,YAAY,GACZ,KAAK,GACL,YAAY,GACZ,aAAa,GACb,qBAAqB,GACrB,oBAAoB,GACpB,iBAAiB,GACjB,IAAI,CAAC;IAET;;;;OAIG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,yBAAiB,YAAY,CAAC;IAC5B;;OAEG;IACH,UAAiB,OAAO;QACtB;;;WAGG;QACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB;;WAEG;QACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;;WAGG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;KACvB;IAED;;;OAGG;IACH,UAAiB,OAAO;QACtB;;;;;;WAMG;QACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,KAAK,EAAE,KAAK,GAAG,KAAK,GAAG,UAAU,GAAG,IAAI,GAAG,IAAI,GAAG,iBAAiB,GAAG,OAAO,GAAG,IAAI,CAAC;QAErF;;;WAGG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5B;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;;;;;OAMG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,YAAY,CAAC,EAAE,mBAAmB,CAAC,YAAY,CAAC;IAEhD;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;;OAGG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,OAAO,CAAC,EAAE,YAAY,CAAC,OAAO,CAAC;QAE/B;;;WAGG;QACH,OAAO,CAAC,EAAE,YAAY,CAAC,OAAO,GAAG,IAAI,CAAC;QAEtC;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;;;;;WAMG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;;;WAIG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;;WAGG;QACH,eAAe,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC;QAE/B;;WAEG;QACH,QAAQ,CAAC,EACL,aAAa,GACb,YAAY,GACZ,SAAS,GACT,cAAc,GACd,UAAU,GACV,WAAW,GACX,aAAa,GACb,QAAQ,GACR,aAAa,GACb,4BAA4B,GAC5B,WAAW,GACX,SAAS,GACT,mBAAmB,GACnB,YAAY,GACZ,YAAY,GACZ,aAAa,GACb,WAAW,GACX,SAAS,GACT,OAAO,GACP,eAAe,GACf,OAAO,GACP,gBAAgB,GAChB,aAAa,GACb,QAAQ,GACR,uBAAuB,GACvB,eAAe,GACf,aAAa,GACb,UAAU,GACV,QAAQ,GACR,YAAY,GACZ,oBAAoB,GACpB,gBAAgB,GAChB,QAAQ,GACR,IAAI,CAAC;QAET;;;WAGG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;WAEG;QACH,oBAAoB,CAAC,EAAE,KAAK,CAC1B,QAAQ,GAAG,MAAM,GAAG,WAAW,GAAG,QAAQ,GAAG,eAAe,GAAG,gBAAgB,CAChF,GAAG,IAAI,CAAC;QAET;;;;WAIG;QACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEhC;;;WAGG;QACH,cAAc,CAAC,EACX,MAAM,GACN,KAAK,GACL,KAAK,GACL,IAAI,GACJ,KAAK,GACL,KAAK,GACL,KAAK,GACL,MAAM,GACN,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,QAAQ,GACR,MAAM,GACN,MAAM,GACN,KAAK,GACL,KAAK,GACL,OAAO,GACP,MAAM,GACN,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,MAAM,GACN,KAAK,GACL,MAAM,GACN,KAAK,GACL,IAAI,CAAC;QAET;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,IAAI,CAAC,EACD,OAAO,GACP,YAAY,GACZ,KAAK,GACL,YAAY,GACZ,aAAa,GACb,qBAAqB,GACrB,oBAAoB,GACpB,iBAAiB,GACjB,IAAI,CAAC;QAET;;;;WAIG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACzB;IAED,UAAiB,YAAY,CAAC;QAC5B;;WAEG;QACH,UAAiB,OAAO;YACtB;;;eAGG;YACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAExB;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtB;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtB;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;;eAGG;YACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAErB;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE5B;;eAEG;YACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SACxB;QAED;;;WAGG;QACH,UAAiB,OAAO;YACtB;;;;;;eAMG;YACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtB;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE3B;;eAEG;YACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE1B;;eAEG;YACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE7B;;eAEG;YACH,KAAK,CAAC,EAAE,KAAK,GAAG,KAAK,GAAG,UAAU,GAAG,IAAI,GAAG,IAAI,GAAG,iBAAiB,GAAG,OAAO,GAAG,IAAI,CAAC;YAEtF;;;eAGG;YACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAC7B;KACF;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;;OAMG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,YAAY,CAAC,EAAE,mBAAmB,CAAC,YAAY,CAAC;IAEhD;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;;OAGG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,OAAO,CAAC,EAAE,YAAY,CAAC,OAAO,CAAC;QAE/B;;;WAGG;QACH,OAAO,CAAC,EAAE,YAAY,CAAC,OAAO,GAAG,IAAI,CAAC;QAEtC;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;;;;;WAMG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;;;WAIG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;;WAGG;QACH,eAAe,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC;QAE/B;;WAEG;QACH,QAAQ,CAAC,EACL,aAAa,GACb,YAAY,GACZ,SAAS,GACT,cAAc,GACd,UAAU,GACV,WAAW,GACX,aAAa,GACb,QAAQ,GACR,aAAa,GACb,4BAA4B,GAC5B,WAAW,GACX,SAAS,GACT,mBAAmB,GACnB,YAAY,GACZ,YAAY,GACZ,aAAa,GACb,WAAW,GACX,SAAS,GACT,OAAO,GACP,eAAe,GACf,OAAO,GACP,gBAAgB,GAChB,aAAa,GACb,QAAQ,GACR,uBAAuB,GACvB,eAAe,GACf,aAAa,GACb,UAAU,GACV,QAAQ,GACR,YAAY,GACZ,oBAAoB,GACpB,gBAAgB,GAChB,QAAQ,GACR,IAAI,CAAC;QAET;;;WAGG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;WAEG;QACH,oBAAoB,CAAC,EAAE,KAAK,CAC1B,QAAQ,GAAG,MAAM,GAAG,WAAW,GAAG,QAAQ,GAAG,eAAe,GAAG,gBAAgB,CAChF,GAAG,IAAI,CAAC;QAET;;;;WAIG;QACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEhC;;;WAGG;QACH,cAAc,CAAC,EACX,MAAM,GACN,KAAK,GACL,KAAK,GACL,IAAI,GACJ,KAAK,GACL,KAAK,GACL,KAAK,GACL,MAAM,GACN,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,QAAQ,GACR,MAAM,GACN,MAAM,GACN,KAAK,GACL,KAAK,GACL,OAAO,GACP,MAAM,GACN,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,MAAM,GACN,KAAK,GACL,MAAM,GACN,KAAK,GACL,IAAI,CAAC;QAET;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,IAAI,CAAC,EACD,OAAO,GACP,YAAY,GACZ,KAAK,GACL,YAAY,GACZ,aAAa,GACb,qBAAqB,GACrB,oBAAoB,GACpB,iBAAiB,GACjB,IAAI,CAAC;QAET;;;;WAIG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACzB;IAED,UAAiB,YAAY,CAAC;QAC5B;;WAEG;QACH,UAAiB,OAAO;YACtB;;;eAGG;YACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAExB;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtB;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtB;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;;eAGG;YACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAErB;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE5B;;eAEG;YACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SACxB;QAED;;;WAGG;QACH,UAAiB,OAAO;YACtB;;;;;;eAMG;YACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtB;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE3B;;eAEG;YACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE1B;;eAEG;YACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE7B;;eAEG;YACH,KAAK,CAAC,EAAE,KAAK,GAAG,KAAK,GAAG,UAAU,GAAG,IAAI,GAAG,IAAI,GAAG,iBAAiB,GAAG,OAAO,GAAG,IAAI,CAAC;YAEtF;;;eAGG;YACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAC7B;KACF;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;CACzC;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,2BAA2B,IAAI,2BAA2B,GAChE,CAAC;CACH"}
1
+ {"version":3,"file":"accounts.d.mts","sourceRoot":"","sources":["../src/resources/accounts.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;OASG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAIhF;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAI5F;;;;;;;;;OASG;IACH,cAAc,CACZ,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,2BAA2B,GAAG,IAAI,GAAG,SAAc,EAC1D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,aAAa,CAAC;CAG7B;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;;;;OAMG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,YAAY,EAAE,YAAY,CAAC;IAE3B;;;OAGG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,YAAY,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,aAAa,CAAC,YAAY,CAAA;KAAE,CAAC;CAC7D;AAED,yBAAiB,aAAa,CAAC;IAC7B,UAAiB,YAAY;QAC3B;;;WAGG;QACH,MAAM,EAAE,KAAK,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;QAElC;;;WAGG;QACH,aAAa,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE7B;;;;WAIG;QACH,MAAM,EAAE,OAAO,GAAG,YAAY,GAAG,OAAO,CAAC;KAC1C;IAED,UAAiB,YAAY,CAAC;QAC5B,UAAiB,KAAK;YACpB;;;eAGG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,OAAO,EAAE,MAAM,CAAC;YAEhB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;SACd;KACF;CACF;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,OAAO,EAAE,YAAY,CAAC,OAAO,CAAC;IAE9B;;;OAGG;IACH,OAAO,EAAE,YAAY,CAAC,OAAO,CAAC;IAE9B;;;OAGG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;;;;;OAMG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;;OAIG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,eAAe,EAAE,KAAK,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,QAAQ,EACJ,aAAa,GACb,YAAY,GACZ,SAAS,GACT,cAAc,GACd,UAAU,GACV,WAAW,GACX,aAAa,GACb,QAAQ,GACR,aAAa,GACb,4BAA4B,GAC5B,WAAW,GACX,SAAS,GACT,mBAAmB,GACnB,YAAY,GACZ,YAAY,GACZ,aAAa,GACb,WAAW,GACX,SAAS,GACT,OAAO,GACP,eAAe,GACf,OAAO,GACP,gBAAgB,GAChB,aAAa,GACb,QAAQ,GACR,uBAAuB,GACvB,eAAe,GACf,aAAa,GACb,UAAU,GACV,QAAQ,GACR,YAAY,GACZ,oBAAoB,GACpB,gBAAgB,GAChB,QAAQ,GACR,IAAI,CAAC;IAET;;;OAGG;IACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,oBAAoB,EAAE,KAAK,CACzB,QAAQ,GAAG,MAAM,GAAG,WAAW,GAAG,QAAQ,GAAG,eAAe,GAAG,gBAAgB,CAChF,GAAG,IAAI,CAAC;IAET;;;;OAIG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;OAGG;IACH,cAAc,EACV,MAAM,GACN,KAAK,GACL,KAAK,GACL,IAAI,GACJ,KAAK,GACL,KAAK,GACL,KAAK,GACL,MAAM,GACN,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,QAAQ,GACR,MAAM,GACN,MAAM,GACN,KAAK,GACL,KAAK,GACL,OAAO,GACP,MAAM,GACN,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,MAAM,GACN,KAAK,GACL,MAAM,GACN,KAAK,GACL,IAAI,CAAC;IAET;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,IAAI,EACA,OAAO,GACP,YAAY,GACZ,KAAK,GACL,YAAY,GACZ,aAAa,GACb,qBAAqB,GACrB,oBAAoB,GACpB,iBAAiB,GACjB,IAAI,CAAC;IAET;;;;OAIG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,yBAAiB,YAAY,CAAC;IAC5B;;OAEG;IACH,UAAiB,OAAO;QACtB;;;WAGG;QACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB;;WAEG;QACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;;WAGG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;KACvB;IAED;;;OAGG;IACH,UAAiB,OAAO;QACtB;;;;;;WAMG;QACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,KAAK,EAAE,KAAK,GAAG,KAAK,GAAG,UAAU,GAAG,IAAI,GAAG,IAAI,GAAG,iBAAiB,GAAG,OAAO,GAAG,IAAI,CAAC;QAErF;;;WAGG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5B;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;;;;;OAMG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,YAAY,CAAC,EAAE,mBAAmB,CAAC,YAAY,CAAC;IAEhD;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;;OAGG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,OAAO,CAAC,EAAE,YAAY,CAAC,OAAO,CAAC;QAE/B;;;;;;WAMG;QACH,OAAO,CAAC,EAAE,YAAY,CAAC,OAAO,GAAG,IAAI,CAAC;QAEtC;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;;;;;WAMG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;;;WAIG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;;WAGG;QACH,eAAe,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC;QAE/B;;WAEG;QACH,QAAQ,CAAC,EACL,aAAa,GACb,YAAY,GACZ,SAAS,GACT,cAAc,GACd,UAAU,GACV,WAAW,GACX,aAAa,GACb,QAAQ,GACR,aAAa,GACb,4BAA4B,GAC5B,WAAW,GACX,SAAS,GACT,mBAAmB,GACnB,YAAY,GACZ,YAAY,GACZ,aAAa,GACb,WAAW,GACX,SAAS,GACT,OAAO,GACP,eAAe,GACf,OAAO,GACP,gBAAgB,GAChB,aAAa,GACb,QAAQ,GACR,uBAAuB,GACvB,eAAe,GACf,aAAa,GACb,UAAU,GACV,QAAQ,GACR,YAAY,GACZ,oBAAoB,GACpB,gBAAgB,GAChB,QAAQ,GACR,IAAI,CAAC;QAET;;;WAGG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;WAEG;QACH,oBAAoB,CAAC,EAAE,KAAK,CAC1B,QAAQ,GAAG,MAAM,GAAG,WAAW,GAAG,QAAQ,GAAG,eAAe,GAAG,gBAAgB,CAChF,GAAG,IAAI,CAAC;QAET;;;;WAIG;QACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEhC;;;WAGG;QACH,cAAc,CAAC,EACX,MAAM,GACN,KAAK,GACL,KAAK,GACL,IAAI,GACJ,KAAK,GACL,KAAK,GACL,KAAK,GACL,MAAM,GACN,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,QAAQ,GACR,MAAM,GACN,MAAM,GACN,KAAK,GACL,KAAK,GACL,OAAO,GACP,MAAM,GACN,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,MAAM,GACN,KAAK,GACL,MAAM,GACN,KAAK,GACL,IAAI,CAAC;QAET;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,IAAI,CAAC,EACD,OAAO,GACP,YAAY,GACZ,KAAK,GACL,YAAY,GACZ,aAAa,GACb,qBAAqB,GACrB,oBAAoB,GACpB,iBAAiB,GACjB,IAAI,CAAC;QAET;;;;WAIG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACzB;IAED,UAAiB,YAAY,CAAC;QAC5B;;WAEG;QACH,UAAiB,OAAO;YACtB;;;eAGG;YACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAExB;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtB;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtB;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;;eAGG;YACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAErB;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE5B;;eAEG;YACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SACxB;QAED;;;;;;WAMG;QACH,UAAiB,OAAO;YACtB;;;;;;;eAOG;YACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtB;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE3B;;eAEG;YACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE1B;;eAEG;YACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE7B;;eAEG;YACH,KAAK,CAAC,EAAE,KAAK,GAAG,KAAK,GAAG,UAAU,GAAG,IAAI,GAAG,IAAI,GAAG,iBAAiB,GAAG,OAAO,GAAG,IAAI,CAAC;YAEtF;;;eAGG;YACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAC7B;KACF;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;;OAMG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,YAAY,CAAC,EAAE,mBAAmB,CAAC,YAAY,CAAC;IAEhD;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;;OAGG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,OAAO,CAAC,EAAE,YAAY,CAAC,OAAO,CAAC;QAE/B;;;;;;WAMG;QACH,OAAO,CAAC,EAAE,YAAY,CAAC,OAAO,GAAG,IAAI,CAAC;QAEtC;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;;;;;WAMG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;;;WAIG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;;WAGG;QACH,eAAe,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC;QAE/B;;WAEG;QACH,QAAQ,CAAC,EACL,aAAa,GACb,YAAY,GACZ,SAAS,GACT,cAAc,GACd,UAAU,GACV,WAAW,GACX,aAAa,GACb,QAAQ,GACR,aAAa,GACb,4BAA4B,GAC5B,WAAW,GACX,SAAS,GACT,mBAAmB,GACnB,YAAY,GACZ,YAAY,GACZ,aAAa,GACb,WAAW,GACX,SAAS,GACT,OAAO,GACP,eAAe,GACf,OAAO,GACP,gBAAgB,GAChB,aAAa,GACb,QAAQ,GACR,uBAAuB,GACvB,eAAe,GACf,aAAa,GACb,UAAU,GACV,QAAQ,GACR,YAAY,GACZ,oBAAoB,GACpB,gBAAgB,GAChB,QAAQ,GACR,IAAI,CAAC;QAET;;;WAGG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;WAEG;QACH,oBAAoB,CAAC,EAAE,KAAK,CAC1B,QAAQ,GAAG,MAAM,GAAG,WAAW,GAAG,QAAQ,GAAG,eAAe,GAAG,gBAAgB,CAChF,GAAG,IAAI,CAAC;QAET;;;;WAIG;QACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEhC;;;WAGG;QACH,cAAc,CAAC,EACX,MAAM,GACN,KAAK,GACL,KAAK,GACL,IAAI,GACJ,KAAK,GACL,KAAK,GACL,KAAK,GACL,MAAM,GACN,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,QAAQ,GACR,MAAM,GACN,MAAM,GACN,KAAK,GACL,KAAK,GACL,OAAO,GACP,MAAM,GACN,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,MAAM,GACN,KAAK,GACL,MAAM,GACN,KAAK,GACL,IAAI,CAAC;QAET;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,IAAI,CAAC,EACD,OAAO,GACP,YAAY,GACZ,KAAK,GACL,YAAY,GACZ,aAAa,GACb,qBAAqB,GACrB,oBAAoB,GACpB,iBAAiB,GACjB,IAAI,CAAC;QAET;;;;WAIG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACzB;IAED,UAAiB,YAAY,CAAC;QAC5B;;WAEG;QACH,UAAiB,OAAO;YACtB;;;eAGG;YACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAExB;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtB;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtB;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;;eAGG;YACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAErB;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE5B;;eAEG;YACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SACxB;QAED;;;;;;WAMG;QACH,UAAiB,OAAO;YACtB;;;;;;;eAOG;YACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtB;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE3B;;eAEG;YACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE1B;;eAEG;YACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE7B;;eAEG;YACH,KAAK,CAAC,EAAE,KAAK,GAAG,KAAK,GAAG,UAAU,GAAG,IAAI,GAAG,IAAI,GAAG,iBAAiB,GAAG,OAAO,GAAG,IAAI,CAAC;YAEtF;;;eAGG;YACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAC7B;KACF;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;CACzC;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,2BAA2B,IAAI,2BAA2B,GAChE,CAAC;CACH"}
package/resources/accounts.d.ts CHANGED
@@ -300,8 +300,11 @@ export declare namespace AccountCreateParams {
300
300
  */
301
301
  address?: Organization.Address;
302
302
  /**
303
- * An object representing an individual who can be contacted if the carriers have
304
- * any questions about the business.
303
+ * An object representing an individual who can be contacted if Surge or our
304
+ * carrier partners have any questions about the business. If you are registering
305
+ * on behalf of your customer, this must be a contact from your customer's company
306
+ * rather than your own. The individual will likely never be contacted unless there
307
+ * are issues with spam.
305
308
  */
306
309
  contact?: Organization.Contact | null;
307
310
  /**
@@ -404,8 +407,11 @@ export declare namespace AccountCreateParams {
404
407
  region?: string | null;
405
408
  }
406
409
  /**
407
- * An object representing an individual who can be contacted if the carriers have
408
- * any questions about the business.
410
+ * An object representing an individual who can be contacted if Surge or our
411
+ * carrier partners have any questions about the business. If you are registering
412
+ * on behalf of your customer, this must be a contact from your customer's company
413
+ * rather than your own. The individual will likely never be contacted unless there
414
+ * are issues with spam.
409
415
  */
410
416
  interface Contact {
411
417
  /**
@@ -413,7 +419,8 @@ export declare namespace AccountCreateParams {
413
419
  * using the same domain name as the website URL will be preferred (e.g. with a
414
420
  * website domain of `https://dtprecisionauto.com`, an email like
415
421
  * `dom@dtprecisionauto.com` will be preferred over one like
416
- * `dom@anothergarage.com` or `dom.toretto@gmail.com`)
422
+ * `dom@anothergarage.com` or `dom.toretto@gmail.com`. `dtprecisionauto@gmail.com`
423
+ * would also be acceptable, but not preferred)
417
424
  */
418
425
  email?: string | null;
419
426
  /**
@@ -475,8 +482,11 @@ export declare namespace AccountUpdateParams {
475
482
  */
476
483
  address?: Organization.Address;
477
484
  /**
478
- * An object representing an individual who can be contacted if the carriers have
479
- * any questions about the business.
485
+ * An object representing an individual who can be contacted if Surge or our
486
+ * carrier partners have any questions about the business. If you are registering
487
+ * on behalf of your customer, this must be a contact from your customer's company
488
+ * rather than your own. The individual will likely never be contacted unless there
489
+ * are issues with spam.
480
490
  */
481
491
  contact?: Organization.Contact | null;
482
492
  /**
@@ -579,8 +589,11 @@ export declare namespace AccountUpdateParams {
579
589
  region?: string | null;
580
590
  }
581
591
  /**
582
- * An object representing an individual who can be contacted if the carriers have
583
- * any questions about the business.
592
+ * An object representing an individual who can be contacted if Surge or our
593
+ * carrier partners have any questions about the business. If you are registering
594
+ * on behalf of your customer, this must be a contact from your customer's company
595
+ * rather than your own. The individual will likely never be contacted unless there
596
+ * are issues with spam.
584
597
  */
585
598
  interface Contact {
586
599
  /**
@@ -588,7 +601,8 @@ export declare namespace AccountUpdateParams {
588
601
  * using the same domain name as the website URL will be preferred (e.g. with a
589
602
  * website domain of `https://dtprecisionauto.com`, an email like
590
603
  * `dom@dtprecisionauto.com` will be preferred over one like
591
- * `dom@anothergarage.com` or `dom.toretto@gmail.com`)
604
+ * `dom@anothergarage.com` or `dom.toretto@gmail.com`. `dtprecisionauto@gmail.com`
605
+ * would also be acceptable, but not preferred)
592
606
  */
593
607
  email?: string | null;
594
608
  /**
package/resources/accounts.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"accounts.d.ts","sourceRoot":"","sources":["../src/resources/accounts.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;OASG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAIhF;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAI5F;;;;;;;;;OASG;IACH,cAAc,CACZ,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,2BAA2B,GAAG,IAAI,GAAG,SAAc,EAC1D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,aAAa,CAAC;CAG7B;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;;;;OAMG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,YAAY,EAAE,YAAY,CAAC;IAE3B;;;OAGG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,YAAY,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,aAAa,CAAC,YAAY,CAAA;KAAE,CAAC;CAC7D;AAED,yBAAiB,aAAa,CAAC;IAC7B,UAAiB,YAAY;QAC3B;;;WAGG;QACH,MAAM,EAAE,KAAK,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;QAElC;;;WAGG;QACH,aAAa,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE7B;;;;WAIG;QACH,MAAM,EAAE,OAAO,GAAG,YAAY,GAAG,OAAO,CAAC;KAC1C;IAED,UAAiB,YAAY,CAAC;QAC5B,UAAiB,KAAK;YACpB;;;eAGG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,OAAO,EAAE,MAAM,CAAC;YAEhB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;SACd;KACF;CACF;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,OAAO,EAAE,YAAY,CAAC,OAAO,CAAC;IAE9B;;;OAGG;IACH,OAAO,EAAE,YAAY,CAAC,OAAO,CAAC;IAE9B;;;OAGG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;;;;;OAMG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;;OAIG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,eAAe,EAAE,KAAK,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,QAAQ,EACJ,aAAa,GACb,YAAY,GACZ,SAAS,GACT,cAAc,GACd,UAAU,GACV,WAAW,GACX,aAAa,GACb,QAAQ,GACR,aAAa,GACb,4BAA4B,GAC5B,WAAW,GACX,SAAS,GACT,mBAAmB,GACnB,YAAY,GACZ,YAAY,GACZ,aAAa,GACb,WAAW,GACX,SAAS,GACT,OAAO,GACP,eAAe,GACf,OAAO,GACP,gBAAgB,GAChB,aAAa,GACb,QAAQ,GACR,uBAAuB,GACvB,eAAe,GACf,aAAa,GACb,UAAU,GACV,QAAQ,GACR,YAAY,GACZ,oBAAoB,GACpB,gBAAgB,GAChB,QAAQ,GACR,IAAI,CAAC;IAET;;;OAGG;IACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,oBAAoB,EAAE,KAAK,CACzB,QAAQ,GAAG,MAAM,GAAG,WAAW,GAAG,QAAQ,GAAG,eAAe,GAAG,gBAAgB,CAChF,GAAG,IAAI,CAAC;IAET;;;;OAIG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;OAGG;IACH,cAAc,EACV,MAAM,GACN,KAAK,GACL,KAAK,GACL,IAAI,GACJ,KAAK,GACL,KAAK,GACL,KAAK,GACL,MAAM,GACN,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,QAAQ,GACR,MAAM,GACN,MAAM,GACN,KAAK,GACL,KAAK,GACL,OAAO,GACP,MAAM,GACN,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,MAAM,GACN,KAAK,GACL,MAAM,GACN,KAAK,GACL,IAAI,CAAC;IAET;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,IAAI,EACA,OAAO,GACP,YAAY,GACZ,KAAK,GACL,YAAY,GACZ,aAAa,GACb,qBAAqB,GACrB,oBAAoB,GACpB,iBAAiB,GACjB,IAAI,CAAC;IAET;;;;OAIG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,yBAAiB,YAAY,CAAC;IAC5B;;OAEG;IACH,UAAiB,OAAO;QACtB;;;WAGG;QACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB;;WAEG;QACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;;WAGG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;KACvB;IAED;;;OAGG;IACH,UAAiB,OAAO;QACtB;;;;;;WAMG;QACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,KAAK,EAAE,KAAK,GAAG,KAAK,GAAG,UAAU,GAAG,IAAI,GAAG,IAAI,GAAG,iBAAiB,GAAG,OAAO,GAAG,IAAI,CAAC;QAErF;;;WAGG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5B;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;;;;;OAMG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,YAAY,CAAC,EAAE,mBAAmB,CAAC,YAAY,CAAC;IAEhD;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;;OAGG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,OAAO,CAAC,EAAE,YAAY,CAAC,OAAO,CAAC;QAE/B;;;WAGG;QACH,OAAO,CAAC,EAAE,YAAY,CAAC,OAAO,GAAG,IAAI,CAAC;QAEtC;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;;;;;WAMG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;;;WAIG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;;WAGG;QACH,eAAe,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC;QAE/B;;WAEG;QACH,QAAQ,CAAC,EACL,aAAa,GACb,YAAY,GACZ,SAAS,GACT,cAAc,GACd,UAAU,GACV,WAAW,GACX,aAAa,GACb,QAAQ,GACR,aAAa,GACb,4BAA4B,GAC5B,WAAW,GACX,SAAS,GACT,mBAAmB,GACnB,YAAY,GACZ,YAAY,GACZ,aAAa,GACb,WAAW,GACX,SAAS,GACT,OAAO,GACP,eAAe,GACf,OAAO,GACP,gBAAgB,GAChB,aAAa,GACb,QAAQ,GACR,uBAAuB,GACvB,eAAe,GACf,aAAa,GACb,UAAU,GACV,QAAQ,GACR,YAAY,GACZ,oBAAoB,GACpB,gBAAgB,GAChB,QAAQ,GACR,IAAI,CAAC;QAET;;;WAGG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;WAEG;QACH,oBAAoB,CAAC,EAAE,KAAK,CAC1B,QAAQ,GAAG,MAAM,GAAG,WAAW,GAAG,QAAQ,GAAG,eAAe,GAAG,gBAAgB,CAChF,GAAG,IAAI,CAAC;QAET;;;;WAIG;QACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEhC;;;WAGG;QACH,cAAc,CAAC,EACX,MAAM,GACN,KAAK,GACL,KAAK,GACL,IAAI,GACJ,KAAK,GACL,KAAK,GACL,KAAK,GACL,MAAM,GACN,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,QAAQ,GACR,MAAM,GACN,MAAM,GACN,KAAK,GACL,KAAK,GACL,OAAO,GACP,MAAM,GACN,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,MAAM,GACN,KAAK,GACL,MAAM,GACN,KAAK,GACL,IAAI,CAAC;QAET;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,IAAI,CAAC,EACD,OAAO,GACP,YAAY,GACZ,KAAK,GACL,YAAY,GACZ,aAAa,GACb,qBAAqB,GACrB,oBAAoB,GACpB,iBAAiB,GACjB,IAAI,CAAC;QAET;;;;WAIG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACzB;IAED,UAAiB,YAAY,CAAC;QAC5B;;WAEG;QACH,UAAiB,OAAO;YACtB;;;eAGG;YACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAExB;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtB;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtB;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;;eAGG;YACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAErB;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE5B;;eAEG;YACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SACxB;QAED;;;WAGG;QACH,UAAiB,OAAO;YACtB;;;;;;eAMG;YACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtB;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE3B;;eAEG;YACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE1B;;eAEG;YACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE7B;;eAEG;YACH,KAAK,CAAC,EAAE,KAAK,GAAG,KAAK,GAAG,UAAU,GAAG,IAAI,GAAG,IAAI,GAAG,iBAAiB,GAAG,OAAO,GAAG,IAAI,CAAC;YAEtF;;;eAGG;YACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAC7B;KACF;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;;OAMG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,YAAY,CAAC,EAAE,mBAAmB,CAAC,YAAY,CAAC;IAEhD;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;;OAGG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,OAAO,CAAC,EAAE,YAAY,CAAC,OAAO,CAAC;QAE/B;;;WAGG;QACH,OAAO,CAAC,EAAE,YAAY,CAAC,OAAO,GAAG,IAAI,CAAC;QAEtC;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;;;;;WAMG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;;;WAIG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;;WAGG;QACH,eAAe,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC;QAE/B;;WAEG;QACH,QAAQ,CAAC,EACL,aAAa,GACb,YAAY,GACZ,SAAS,GACT,cAAc,GACd,UAAU,GACV,WAAW,GACX,aAAa,GACb,QAAQ,GACR,aAAa,GACb,4BAA4B,GAC5B,WAAW,GACX,SAAS,GACT,mBAAmB,GACnB,YAAY,GACZ,YAAY,GACZ,aAAa,GACb,WAAW,GACX,SAAS,GACT,OAAO,GACP,eAAe,GACf,OAAO,GACP,gBAAgB,GAChB,aAAa,GACb,QAAQ,GACR,uBAAuB,GACvB,eAAe,GACf,aAAa,GACb,UAAU,GACV,QAAQ,GACR,YAAY,GACZ,oBAAoB,GACpB,gBAAgB,GAChB,QAAQ,GACR,IAAI,CAAC;QAET;;;WAGG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;WAEG;QACH,oBAAoB,CAAC,EAAE,KAAK,CAC1B,QAAQ,GAAG,MAAM,GAAG,WAAW,GAAG,QAAQ,GAAG,eAAe,GAAG,gBAAgB,CAChF,GAAG,IAAI,CAAC;QAET;;;;WAIG;QACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEhC;;;WAGG;QACH,cAAc,CAAC,EACX,MAAM,GACN,KAAK,GACL,KAAK,GACL,IAAI,GACJ,KAAK,GACL,KAAK,GACL,KAAK,GACL,MAAM,GACN,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,QAAQ,GACR,MAAM,GACN,MAAM,GACN,KAAK,GACL,KAAK,GACL,OAAO,GACP,MAAM,GACN,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,MAAM,GACN,KAAK,GACL,MAAM,GACN,KAAK,GACL,IAAI,CAAC;QAET;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,IAAI,CAAC,EACD,OAAO,GACP,YAAY,GACZ,KAAK,GACL,YAAY,GACZ,aAAa,GACb,qBAAqB,GACrB,oBAAoB,GACpB,iBAAiB,GACjB,IAAI,CAAC;QAET;;;;WAIG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACzB;IAED,UAAiB,YAAY,CAAC;QAC5B;;WAEG;QACH,UAAiB,OAAO;YACtB;;;eAGG;YACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAExB;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtB;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtB;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;;eAGG;YACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAErB;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE5B;;eAEG;YACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SACxB;QAED;;;WAGG;QACH,UAAiB,OAAO;YACtB;;;;;;eAMG;YACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtB;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE3B;;eAEG;YACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE1B;;eAEG;YACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE7B;;eAEG;YACH,KAAK,CAAC,EAAE,KAAK,GAAG,KAAK,GAAG,UAAU,GAAG,IAAI,GAAG,IAAI,GAAG,iBAAiB,GAAG,OAAO,GAAG,IAAI,CAAC;YAEtF;;;eAGG;YACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAC7B;KACF;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;CACzC;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,2BAA2B,IAAI,2BAA2B,GAChE,CAAC;CACH"}
1
+ {"version":3,"file":"accounts.d.ts","sourceRoot":"","sources":["../src/resources/accounts.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;OASG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAIhF;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAI5F;;;;;;;;;OASG;IACH,cAAc,CACZ,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,2BAA2B,GAAG,IAAI,GAAG,SAAc,EAC1D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,aAAa,CAAC;CAG7B;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;;;;OAMG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,YAAY,EAAE,YAAY,CAAC;IAE3B;;;OAGG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,YAAY,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,aAAa,CAAC,YAAY,CAAA;KAAE,CAAC;CAC7D;AAED,yBAAiB,aAAa,CAAC;IAC7B,UAAiB,YAAY;QAC3B;;;WAGG;QACH,MAAM,EAAE,KAAK,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;QAElC;;;WAGG;QACH,aAAa,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE7B;;;;WAIG;QACH,MAAM,EAAE,OAAO,GAAG,YAAY,GAAG,OAAO,CAAC;KAC1C;IAED,UAAiB,YAAY,CAAC;QAC5B,UAAiB,KAAK;YACpB;;;eAGG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,OAAO,EAAE,MAAM,CAAC;YAEhB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;SACd;KACF;CACF;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,OAAO,EAAE,YAAY,CAAC,OAAO,CAAC;IAE9B;;;OAGG;IACH,OAAO,EAAE,YAAY,CAAC,OAAO,CAAC;IAE9B;;;OAGG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;;;;;OAMG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;;OAIG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,eAAe,EAAE,KAAK,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,QAAQ,EACJ,aAAa,GACb,YAAY,GACZ,SAAS,GACT,cAAc,GACd,UAAU,GACV,WAAW,GACX,aAAa,GACb,QAAQ,GACR,aAAa,GACb,4BAA4B,GAC5B,WAAW,GACX,SAAS,GACT,mBAAmB,GACnB,YAAY,GACZ,YAAY,GACZ,aAAa,GACb,WAAW,GACX,SAAS,GACT,OAAO,GACP,eAAe,GACf,OAAO,GACP,gBAAgB,GAChB,aAAa,GACb,QAAQ,GACR,uBAAuB,GACvB,eAAe,GACf,aAAa,GACb,UAAU,GACV,QAAQ,GACR,YAAY,GACZ,oBAAoB,GACpB,gBAAgB,GAChB,QAAQ,GACR,IAAI,CAAC;IAET;;;OAGG;IACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,oBAAoB,EAAE,KAAK,CACzB,QAAQ,GAAG,MAAM,GAAG,WAAW,GAAG,QAAQ,GAAG,eAAe,GAAG,gBAAgB,CAChF,GAAG,IAAI,CAAC;IAET;;;;OAIG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;OAGG;IACH,cAAc,EACV,MAAM,GACN,KAAK,GACL,KAAK,GACL,IAAI,GACJ,KAAK,GACL,KAAK,GACL,KAAK,GACL,MAAM,GACN,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,QAAQ,GACR,MAAM,GACN,MAAM,GACN,KAAK,GACL,KAAK,GACL,OAAO,GACP,MAAM,GACN,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,MAAM,GACN,KAAK,GACL,MAAM,GACN,KAAK,GACL,IAAI,CAAC;IAET;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,IAAI,EACA,OAAO,GACP,YAAY,GACZ,KAAK,GACL,YAAY,GACZ,aAAa,GACb,qBAAqB,GACrB,oBAAoB,GACpB,iBAAiB,GACjB,IAAI,CAAC;IAET;;;;OAIG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,yBAAiB,YAAY,CAAC;IAC5B;;OAEG;IACH,UAAiB,OAAO;QACtB;;;WAGG;QACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB;;WAEG;QACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;;WAGG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;KACvB;IAED;;;OAGG;IACH,UAAiB,OAAO;QACtB;;;;;;WAMG;QACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,KAAK,EAAE,KAAK,GAAG,KAAK,GAAG,UAAU,GAAG,IAAI,GAAG,IAAI,GAAG,iBAAiB,GAAG,OAAO,GAAG,IAAI,CAAC;QAErF;;;WAGG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5B;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;;;;;OAMG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,YAAY,CAAC,EAAE,mBAAmB,CAAC,YAAY,CAAC;IAEhD;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;;OAGG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,OAAO,CAAC,EAAE,YAAY,CAAC,OAAO,CAAC;QAE/B;;;;;;WAMG;QACH,OAAO,CAAC,EAAE,YAAY,CAAC,OAAO,GAAG,IAAI,CAAC;QAEtC;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;;;;;WAMG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;;;WAIG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;;WAGG;QACH,eAAe,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC;QAE/B;;WAEG;QACH,QAAQ,CAAC,EACL,aAAa,GACb,YAAY,GACZ,SAAS,GACT,cAAc,GACd,UAAU,GACV,WAAW,GACX,aAAa,GACb,QAAQ,GACR,aAAa,GACb,4BAA4B,GAC5B,WAAW,GACX,SAAS,GACT,mBAAmB,GACnB,YAAY,GACZ,YAAY,GACZ,aAAa,GACb,WAAW,GACX,SAAS,GACT,OAAO,GACP,eAAe,GACf,OAAO,GACP,gBAAgB,GAChB,aAAa,GACb,QAAQ,GACR,uBAAuB,GACvB,eAAe,GACf,aAAa,GACb,UAAU,GACV,QAAQ,GACR,YAAY,GACZ,oBAAoB,GACpB,gBAAgB,GAChB,QAAQ,GACR,IAAI,CAAC;QAET;;;WAGG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;WAEG;QACH,oBAAoB,CAAC,EAAE,KAAK,CAC1B,QAAQ,GAAG,MAAM,GAAG,WAAW,GAAG,QAAQ,GAAG,eAAe,GAAG,gBAAgB,CAChF,GAAG,IAAI,CAAC;QAET;;;;WAIG;QACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEhC;;;WAGG;QACH,cAAc,CAAC,EACX,MAAM,GACN,KAAK,GACL,KAAK,GACL,IAAI,GACJ,KAAK,GACL,KAAK,GACL,KAAK,GACL,MAAM,GACN,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,QAAQ,GACR,MAAM,GACN,MAAM,GACN,KAAK,GACL,KAAK,GACL,OAAO,GACP,MAAM,GACN,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,MAAM,GACN,KAAK,GACL,MAAM,GACN,KAAK,GACL,IAAI,CAAC;QAET;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,IAAI,CAAC,EACD,OAAO,GACP,YAAY,GACZ,KAAK,GACL,YAAY,GACZ,aAAa,GACb,qBAAqB,GACrB,oBAAoB,GACpB,iBAAiB,GACjB,IAAI,CAAC;QAET;;;;WAIG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACzB;IAED,UAAiB,YAAY,CAAC;QAC5B;;WAEG;QACH,UAAiB,OAAO;YACtB;;;eAGG;YACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAExB;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtB;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtB;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;;eAGG;YACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAErB;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE5B;;eAEG;YACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SACxB;QAED;;;;;;WAMG;QACH,UAAiB,OAAO;YACtB;;;;;;;eAOG;YACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtB;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE3B;;eAEG;YACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE1B;;eAEG;YACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE7B;;eAEG;YACH,KAAK,CAAC,EAAE,KAAK,GAAG,KAAK,GAAG,UAAU,GAAG,IAAI,GAAG,IAAI,GAAG,iBAAiB,GAAG,OAAO,GAAG,IAAI,CAAC;YAEtF;;;eAGG;YACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAC7B;KACF;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;;OAMG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,YAAY,CAAC,EAAE,mBAAmB,CAAC,YAAY,CAAC;IAEhD;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;;OAGG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,OAAO,CAAC,EAAE,YAAY,CAAC,OAAO,CAAC;QAE/B;;;;;;WAMG;QACH,OAAO,CAAC,EAAE,YAAY,CAAC,OAAO,GAAG,IAAI,CAAC;QAEtC;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;;;;;WAMG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;;;WAIG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;;WAGG;QACH,eAAe,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC;QAE/B;;WAEG;QACH,QAAQ,CAAC,EACL,aAAa,GACb,YAAY,GACZ,SAAS,GACT,cAAc,GACd,UAAU,GACV,WAAW,GACX,aAAa,GACb,QAAQ,GACR,aAAa,GACb,4BAA4B,GAC5B,WAAW,GACX,SAAS,GACT,mBAAmB,GACnB,YAAY,GACZ,YAAY,GACZ,aAAa,GACb,WAAW,GACX,SAAS,GACT,OAAO,GACP,eAAe,GACf,OAAO,GACP,gBAAgB,GAChB,aAAa,GACb,QAAQ,GACR,uBAAuB,GACvB,eAAe,GACf,aAAa,GACb,UAAU,GACV,QAAQ,GACR,YAAY,GACZ,oBAAoB,GACpB,gBAAgB,GAChB,QAAQ,GACR,IAAI,CAAC;QAET;;;WAGG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;WAEG;QACH,oBAAoB,CAAC,EAAE,KAAK,CAC1B,QAAQ,GAAG,MAAM,GAAG,WAAW,GAAG,QAAQ,GAAG,eAAe,GAAG,gBAAgB,CAChF,GAAG,IAAI,CAAC;QAET;;;;WAIG;QACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEhC;;;WAGG;QACH,cAAc,CAAC,EACX,MAAM,GACN,KAAK,GACL,KAAK,GACL,IAAI,GACJ,KAAK,GACL,KAAK,GACL,KAAK,GACL,MAAM,GACN,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,QAAQ,GACR,MAAM,GACN,MAAM,GACN,KAAK,GACL,KAAK,GACL,OAAO,GACP,MAAM,GACN,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,MAAM,GACN,KAAK,GACL,MAAM,GACN,KAAK,GACL,IAAI,CAAC;QAET;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,IAAI,CAAC,EACD,OAAO,GACP,YAAY,GACZ,KAAK,GACL,YAAY,GACZ,aAAa,GACb,qBAAqB,GACrB,oBAAoB,GACpB,iBAAiB,GACjB,IAAI,CAAC;QAET;;;;WAIG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACzB;IAED,UAAiB,YAAY,CAAC;QAC5B;;WAEG;QACH,UAAiB,OAAO;YACtB;;;eAGG;YACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAExB;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtB;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtB;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;;eAGG;YACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAErB;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE5B;;eAEG;YACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SACxB;QAED;;;;;;WAMG;QACH,UAAiB,OAAO;YACtB;;;;;;;eAOG;YACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtB;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE3B;;eAEG;YACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE1B;;eAEG;YACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE7B;;eAEG;YACH,KAAK,CAAC,EAAE,KAAK,GAAG,KAAK,GAAG,UAAU,GAAG,IAAI,GAAG,IAAI,GAAG,iBAAiB,GAAG,OAAO,GAAG,IAAI,CAAC;YAEtF;;;eAGG;YACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAC7B;KACF;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;CACzC;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,2BAA2B,IAAI,2BAA2B,GAChE,CAAC;CACH"}
package/resources/campaigns.d.mts CHANGED
@@ -139,104 +139,113 @@ export interface Campaign {
139
139
  */
140
140
  terms_and_conditions_url?: string;
141
141
  }
142
- export interface CampaignCreateParams {
143
- /**
144
- * A string explaining the method through which end users will opt in to receive
145
- * messages from the brand. Typically this should include URLs for opt-in forms or
146
- * screenshots that might be helpful in explaining the flow to someone unfamiliar
147
- * with the organization's purpose.
148
- */
149
- consent_flow: string;
150
- /**
151
- * An explanation of the organization's purpose and how it will be using text
152
- * messaging to accomplish that purpose.
153
- */
154
- description: string;
155
- /**
156
- * An array of 2-5 strings with examples of the messages that will be sent from
157
- * this campaign. Typically the first sample should be a compliance message like
158
- * `You are now opted in to messages from {brand name}. Frequency varies. Msg&data rates apply. Reply STOP to opt out.`
159
- * These samples don't necessarily need to be the only templates that will be used
160
- * for the campaign, but they should reflect the purpose of the messages that will
161
- * be sent. Any variable content can be reflected by wrapping it in square brackets
162
- * like `[customer name]`.
163
- */
164
- message_samples: Array<string>;
165
- /**
166
- * The URL of the privacy policy for the brand in question. This may be a shared
167
- * privacy policy if it's the policy that is displayed to end users when they opt
168
- * in to messaging.
169
- */
170
- privacy_policy_url: string;
171
- /**
172
- * A list containing 1-5 types of messages that will be sent with this campaign.
173
- *
174
- * The following use cases are typically available to all brands:
175
- *
176
- * - `account_notification` - For sending reminders, alerts, and general
177
- * account-related notifications like booking confirmations or appointment
178
- * reminders.
179
- * - `customer_care` - For account support, troubleshooting, and general customer
180
- * service communication.
181
- * - `delivery_notification` - For notifying customers about the status of product
182
- * or service deliveries.
183
- * - `fraud_alert` - For warning customers about suspicious or potentially
184
- * fraudulent activity.
185
- * - `higher_education` - For messaging related to colleges, universities, and
186
- * school districts outside of K–12.
187
- * - `marketing` - For promotional or advertising messages intended to market
188
- * products or services.
189
- * - `polling_voting` - For conducting surveys, polls, or voting-related messaging.
190
- * - `public_service_announcement` - For raising awareness about social issues or
191
- * important public information.
192
- * - `security_alert` - For alerts related to potential security breaches or
193
- * compromised systems requiring user action.
194
- * - `two_factor_authentication` - For sending one-time passwords or verification
195
- * codes for login or password reset.
196
- *
197
- * For access to special use cases not shown here, reach out to support@surge.app.
198
- */
199
- use_cases: Array<'account_notification' | 'customer_care' | 'delivery_notification' | 'fraud_alert' | 'higher_education' | 'marketing' | 'polling_voting' | 'public_service_announcement' | 'security_alert' | 'two_factor_authentication'>;
200
- /**
201
- * This will be one of the following:
202
- *
203
- * - `low` - The campaign will be allowed to send up to 2000 SMS segments to
204
- * T-Mobile customers each day. In this case your platform will be charged for
205
- * the setup fee for a low volume number upon receipt of the API request.
206
- * - `high` - The campaign will be allowed to send up to 200k SMS segments to
207
- * T-Mobile customers each day, depending on the trust score assigned by The
208
- * Campaign Registry. Your platform will be charged for the setup fee for a high
209
- * volume number upon receipt of the API request, and phone numbers will be
210
- * charged as high volume numbers going forward.
211
- */
212
- volume: 'high' | 'low';
213
- /**
214
- * A list of properties that this campaign should include. These properties can be
215
- * any of the following values:
216
- *
217
- * - `links` - whether the campaign might send links in messages
218
- * - `phone_numbers` - whether the campaign might send phone numbers in messages
219
- * - `age_gated` - whether the campaign contains age gated content (controlled
220
- * substances or adult content)
221
- * - `direct_lending` - whether the campaign contains content related to direct
222
- * lending or other loan arrangements
223
- */
224
- includes?: Array<'links' | 'phone_numbers' | 'age_gated' | 'direct_lending'>;
225
- /**
226
- * A sample link that might be sent by this campaign. If links from other domains
227
- * are sent through this campaign, they are much more likely to be filtered by the
228
- * carriers. If link shortening is enabled for the account, the link shortener URL
229
- * will be used instead of what is provided. Reach out to support if you would like
230
- * to disable automatic link shortening.
231
- */
232
- link_sample?: string;
233
- /**
234
- * The URL of the terms and conditions presented to end users when they opt in to
235
- * messaging. These terms and conditions may be shared among all of a platform's
236
- * customers if they're the terms that are presented to end users when they opt in
237
- * to messaging.
238
- */
239
- terms_and_conditions_url?: string;
142
+ export type CampaignCreateParams = CampaignCreateParams.StandardCampaignParams | CampaignCreateParams.ExternalCampaignParams;
143
+ export declare namespace CampaignCreateParams {
144
+ interface StandardCampaignParams {
145
+ /**
146
+ * A string explaining the method through which end users will opt in to receive
147
+ * messages from the brand. Typically this should include URLs for opt-in forms or
148
+ * screenshots that might be helpful in explaining the flow to someone unfamiliar
149
+ * with the organization's purpose.
150
+ */
151
+ consent_flow: string;
152
+ /**
153
+ * An explanation of the organization's purpose and how it will be using text
154
+ * messaging to accomplish that purpose.
155
+ */
156
+ description: string;
157
+ /**
158
+ * An array of 2-5 strings with examples of the messages that will be sent from
159
+ * this campaign. Typically the first sample should be a compliance message like
160
+ * `You are now opted in to messages from {brand name}. Frequency varies. Msg&data rates apply. Reply STOP to opt out.`
161
+ * These samples don't necessarily need to be the only templates that will be used
162
+ * for the campaign, but they should reflect the purpose of the messages that will
163
+ * be sent. Any variable content can be reflected by wrapping it in square brackets
164
+ * like `[customer name]`.
165
+ */
166
+ message_samples: Array<string>;
167
+ /**
168
+ * The URL of the privacy policy for the brand in question. This may be a shared
169
+ * privacy policy if it's the policy that is displayed to end users when they opt
170
+ * in to messaging.
171
+ */
172
+ privacy_policy_url: string;
173
+ /**
174
+ * A list containing 1-5 types of messages that will be sent with this campaign.
175
+ *
176
+ * The following use cases are typically available to all brands:
177
+ *
178
+ * - `account_notification` - For sending reminders, alerts, and general
179
+ * account-related notifications like booking confirmations or appointment
180
+ * reminders.
181
+ * - `customer_care` - For account support, troubleshooting, and general customer
182
+ * service communication.
183
+ * - `delivery_notification` - For notifying customers about the status of product
184
+ * or service deliveries.
185
+ * - `fraud_alert` - For warning customers about suspicious or potentially
186
+ * fraudulent activity.
187
+ * - `higher_education` - For messaging related to colleges, universities, and
188
+ * school districts outside of K–12.
189
+ * - `marketing` - For promotional or advertising messages intended to market
190
+ * products or services.
191
+ * - `polling_voting` - For conducting surveys, polls, or voting-related messaging.
192
+ * - `public_service_announcement` - For raising awareness about social issues or
193
+ * important public information.
194
+ * - `security_alert` - For alerts related to potential security breaches or
195
+ * compromised systems requiring user action.
196
+ * - `two_factor_authentication` - For sending one-time passwords or verification
197
+ * codes for login or password reset.
198
+ *
199
+ * For access to special use cases not shown here, reach out to support@surge.app.
200
+ */
201
+ use_cases: Array<'account_notification' | 'customer_care' | 'delivery_notification' | 'fraud_alert' | 'higher_education' | 'marketing' | 'polling_voting' | 'public_service_announcement' | 'security_alert' | 'two_factor_authentication'>;
202
+ /**
203
+ * This will be one of the following:
204
+ *
205
+ * - `low` - The campaign will be allowed to send up to 2000 SMS segments to
206
+ * T-Mobile customers each day. In this case your platform will be charged for
207
+ * the setup fee for a low volume number upon receipt of the API request.
208
+ * - `high` - The campaign will be allowed to send up to 200k SMS segments to
209
+ * T-Mobile customers each day, depending on the trust score assigned by The
210
+ * Campaign Registry. Your platform will be charged for the setup fee for a high
211
+ * volume number upon receipt of the API request, and phone numbers will be
212
+ * charged as high volume numbers going forward.
213
+ */
214
+ volume: 'high' | 'low';
215
+ /**
216
+ * A list of properties that this campaign should include. These properties can be
217
+ * any of the following values:
218
+ *
219
+ * - `links` - whether the campaign might send links in messages
220
+ * - `phone_numbers` - whether the campaign might send phone numbers in messages
221
+ * - `age_gated` - whether the campaign contains age gated content (controlled
222
+ * substances or adult content)
223
+ * - `direct_lending` - whether the campaign contains content related to direct
224
+ * lending or other loan arrangements
225
+ */
226
+ includes?: Array<'links' | 'phone_numbers' | 'age_gated' | 'direct_lending'>;
227
+ /**
228
+ * A sample link that might be sent by this campaign. If links from other domains
229
+ * are sent through this campaign, they are much more likely to be filtered by the
230
+ * carriers. If link shortening is enabled for the account, the link shortener URL
231
+ * will be used instead of what is provided. Reach out to support if you would like
232
+ * to disable automatic link shortening.
233
+ */
234
+ link_sample?: string;
235
+ /**
236
+ * The URL of the terms and conditions presented to end users when they opt in to
237
+ * messaging. These terms and conditions may be shared among all of a platform's
238
+ * customers if they're the terms that are presented to end users when they opt in
239
+ * to messaging.
240
+ */
241
+ terms_and_conditions_url?: string;
242
+ }
243
+ interface ExternalCampaignParams {
244
+ /**
245
+ * The Campaign Registry (TCR) ID for the externally registered campaign
246
+ */
247
+ tcr_id: string;
248
+ }
240
249
  }
241
250
  export declare namespace Campaigns {
242
251
  export { type Campaign as Campaign, type CampaignCreateParams as CampaignCreateParams };
package/resources/campaigns.d.mts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"campaigns.d.mts","sourceRoot":"","sources":["../src/resources/campaigns.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;CAGtG;AAED;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;;;OAKG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;;;;;;;OAUG;IACH,QAAQ,EAAE,KAAK,CAAC,OAAO,GAAG,eAAe,GAAG,WAAW,GAAG,gBAAgB,CAAC,CAAC;IAE5E;;;;;;;;OAQG;IACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;;;OAIG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,SAAS,EAAE,KAAK,CACZ,sBAAsB,GACtB,eAAe,GACf,uBAAuB,GACvB,aAAa,GACb,kBAAkB,GAClB,WAAW,GACX,gBAAgB,GAChB,6BAA6B,GAC7B,gBAAgB,GAChB,2BAA2B,CAC9B,CAAC;IAEF;;;;;;;;;;;OAWG;IACH,MAAM,EAAE,MAAM,GAAG,KAAK,CAAC;IAEvB;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;OAKG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;CACnC;AAED,MAAM,WAAW,oBAAoB;IACnC;;;;;OAKG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;;;;;OAQG;IACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;;;OAIG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,SAAS,EAAE,KAAK,CACZ,sBAAsB,GACtB,eAAe,GACf,uBAAuB,GACvB,aAAa,GACb,kBAAkB,GAClB,WAAW,GACX,gBAAgB,GAChB,6BAA6B,GAC7B,gBAAgB,GAChB,2BAA2B,CAC9B,CAAC;IAEF;;;;;;;;;;;OAWG;IACH,MAAM,EAAE,MAAM,GAAG,KAAK,CAAC;IAEvB;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,eAAe,GAAG,WAAW,GAAG,gBAAgB,CAAC,CAAC;IAE7E;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;OAKG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;CACnC;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EAAE,KAAK,QAAQ,IAAI,QAAQ,EAAE,KAAK,oBAAoB,IAAI,oBAAoB,EAAE,CAAC;CACzF"}
1
+ {"version":3,"file":"campaigns.d.mts","sourceRoot":"","sources":["../src/resources/campaigns.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;CAGtG;AAED;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;;;OAKG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;;;;;;;OAUG;IACH,QAAQ,EAAE,KAAK,CAAC,OAAO,GAAG,eAAe,GAAG,WAAW,GAAG,gBAAgB,CAAC,CAAC;IAE5E;;;;;;;;OAQG;IACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;;;OAIG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,SAAS,EAAE,KAAK,CACZ,sBAAsB,GACtB,eAAe,GACf,uBAAuB,GACvB,aAAa,GACb,kBAAkB,GAClB,WAAW,GACX,gBAAgB,GAChB,6BAA6B,GAC7B,gBAAgB,GAChB,2BAA2B,CAC9B,CAAC;IAEF;;;;;;;;;;;OAWG;IACH,MAAM,EAAE,MAAM,GAAG,KAAK,CAAC;IAEvB;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;OAKG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;CACnC;AAED,MAAM,MAAM,oBAAoB,GAC5B,oBAAoB,CAAC,sBAAsB,GAC3C,oBAAoB,CAAC,sBAAsB,CAAC;AAEhD,MAAM,CAAC,OAAO,WAAW,oBAAoB,CAAC;IAC5C,UAAiB,sBAAsB;QACrC;;;;;WAKG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;;;;;;;WAQG;QACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE/B;;;;WAIG;QACH,kBAAkB,EAAE,MAAM,CAAC;QAE3B;;;;;;;;;;;;;;;;;;;;;;;;;;;WA2BG;QACH,SAAS,EAAE,KAAK,CACZ,sBAAsB,GACtB,eAAe,GACf,uBAAuB,GACvB,aAAa,GACb,kBAAkB,GAClB,WAAW,GACX,gBAAgB,GAChB,6BAA6B,GAC7B,gBAAgB,GAChB,2BAA2B,CAC9B,CAAC;QAEF;;;;;;;;;;;WAWG;QACH,MAAM,EAAE,MAAM,GAAG,KAAK,CAAC;QAEvB;;;;;;;;;;WAUG;QACH,QAAQ,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,eAAe,GAAG,WAAW,GAAG,gBAAgB,CAAC,CAAC;QAE7E;;;;;;WAMG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;;;WAKG;QACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;KACnC;IAED,UAAiB,sBAAsB;QACrC;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;KAChB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EAAE,KAAK,QAAQ,IAAI,QAAQ,EAAE,KAAK,oBAAoB,IAAI,oBAAoB,EAAE,CAAC;CACzF"}
package/resources/campaigns.d.ts CHANGED
@@ -139,104 +139,113 @@ export interface Campaign {
139
139
  */
140
140
  terms_and_conditions_url?: string;
141
141
  }
142
- export interface CampaignCreateParams {
143
- /**
144
- * A string explaining the method through which end users will opt in to receive
145
- * messages from the brand. Typically this should include URLs for opt-in forms or
146
- * screenshots that might be helpful in explaining the flow to someone unfamiliar
147
- * with the organization's purpose.
148
- */
149
- consent_flow: string;
150
- /**
151
- * An explanation of the organization's purpose and how it will be using text
152
- * messaging to accomplish that purpose.
153
- */
154
- description: string;
155
- /**
156
- * An array of 2-5 strings with examples of the messages that will be sent from
157
- * this campaign. Typically the first sample should be a compliance message like
158
- * `You are now opted in to messages from {brand name}. Frequency varies. Msg&data rates apply. Reply STOP to opt out.`
159
- * These samples don't necessarily need to be the only templates that will be used
160
- * for the campaign, but they should reflect the purpose of the messages that will
161
- * be sent. Any variable content can be reflected by wrapping it in square brackets
162
- * like `[customer name]`.
163
- */
164
- message_samples: Array<string>;
165
- /**
166
- * The URL of the privacy policy for the brand in question. This may be a shared
167
- * privacy policy if it's the policy that is displayed to end users when they opt
168
- * in to messaging.
169
- */
170
- privacy_policy_url: string;
171
- /**
172
- * A list containing 1-5 types of messages that will be sent with this campaign.
173
- *
174
- * The following use cases are typically available to all brands:
175
- *
176
- * - `account_notification` - For sending reminders, alerts, and general
177
- * account-related notifications like booking confirmations or appointment
178
- * reminders.
179
- * - `customer_care` - For account support, troubleshooting, and general customer
180
- * service communication.
181
- * - `delivery_notification` - For notifying customers about the status of product
182
- * or service deliveries.
183
- * - `fraud_alert` - For warning customers about suspicious or potentially
184
- * fraudulent activity.
185
- * - `higher_education` - For messaging related to colleges, universities, and
186
- * school districts outside of K–12.
187
- * - `marketing` - For promotional or advertising messages intended to market
188
- * products or services.
189
- * - `polling_voting` - For conducting surveys, polls, or voting-related messaging.
190
- * - `public_service_announcement` - For raising awareness about social issues or
191
- * important public information.
192
- * - `security_alert` - For alerts related to potential security breaches or
193
- * compromised systems requiring user action.
194
- * - `two_factor_authentication` - For sending one-time passwords or verification
195
- * codes for login or password reset.
196
- *
197
- * For access to special use cases not shown here, reach out to support@surge.app.
198
- */
199
- use_cases: Array<'account_notification' | 'customer_care' | 'delivery_notification' | 'fraud_alert' | 'higher_education' | 'marketing' | 'polling_voting' | 'public_service_announcement' | 'security_alert' | 'two_factor_authentication'>;
200
- /**
201
- * This will be one of the following:
202
- *
203
- * - `low` - The campaign will be allowed to send up to 2000 SMS segments to
204
- * T-Mobile customers each day. In this case your platform will be charged for
205
- * the setup fee for a low volume number upon receipt of the API request.
206
- * - `high` - The campaign will be allowed to send up to 200k SMS segments to
207
- * T-Mobile customers each day, depending on the trust score assigned by The
208
- * Campaign Registry. Your platform will be charged for the setup fee for a high
209
- * volume number upon receipt of the API request, and phone numbers will be
210
- * charged as high volume numbers going forward.
211
- */
212
- volume: 'high' | 'low';
213
- /**
214
- * A list of properties that this campaign should include. These properties can be
215
- * any of the following values:
216
- *
217
- * - `links` - whether the campaign might send links in messages
218
- * - `phone_numbers` - whether the campaign might send phone numbers in messages
219
- * - `age_gated` - whether the campaign contains age gated content (controlled
220
- * substances or adult content)
221
- * - `direct_lending` - whether the campaign contains content related to direct
222
- * lending or other loan arrangements
223
- */
224
- includes?: Array<'links' | 'phone_numbers' | 'age_gated' | 'direct_lending'>;
225
- /**
226
- * A sample link that might be sent by this campaign. If links from other domains
227
- * are sent through this campaign, they are much more likely to be filtered by the
228
- * carriers. If link shortening is enabled for the account, the link shortener URL
229
- * will be used instead of what is provided. Reach out to support if you would like
230
- * to disable automatic link shortening.
231
- */
232
- link_sample?: string;
233
- /**
234
- * The URL of the terms and conditions presented to end users when they opt in to
235
- * messaging. These terms and conditions may be shared among all of a platform's
236
- * customers if they're the terms that are presented to end users when they opt in
237
- * to messaging.
238
- */
239
- terms_and_conditions_url?: string;
142
+ export type CampaignCreateParams = CampaignCreateParams.StandardCampaignParams | CampaignCreateParams.ExternalCampaignParams;
143
+ export declare namespace CampaignCreateParams {
144
+ interface StandardCampaignParams {
145
+ /**
146
+ * A string explaining the method through which end users will opt in to receive
147
+ * messages from the brand. Typically this should include URLs for opt-in forms or
148
+ * screenshots that might be helpful in explaining the flow to someone unfamiliar
149
+ * with the organization's purpose.
150
+ */
151
+ consent_flow: string;
152
+ /**
153
+ * An explanation of the organization's purpose and how it will be using text
154
+ * messaging to accomplish that purpose.
155
+ */
156
+ description: string;
157
+ /**
158
+ * An array of 2-5 strings with examples of the messages that will be sent from
159
+ * this campaign. Typically the first sample should be a compliance message like
160
+ * `You are now opted in to messages from {brand name}. Frequency varies. Msg&data rates apply. Reply STOP to opt out.`
161
+ * These samples don't necessarily need to be the only templates that will be used
162
+ * for the campaign, but they should reflect the purpose of the messages that will
163
+ * be sent. Any variable content can be reflected by wrapping it in square brackets
164
+ * like `[customer name]`.
165
+ */
166
+ message_samples: Array<string>;
167
+ /**
168
+ * The URL of the privacy policy for the brand in question. This may be a shared
169
+ * privacy policy if it's the policy that is displayed to end users when they opt
170
+ * in to messaging.
171
+ */
172
+ privacy_policy_url: string;
173
+ /**
174
+ * A list containing 1-5 types of messages that will be sent with this campaign.
175
+ *
176
+ * The following use cases are typically available to all brands:
177
+ *
178
+ * - `account_notification` - For sending reminders, alerts, and general
179
+ * account-related notifications like booking confirmations or appointment
180
+ * reminders.
181
+ * - `customer_care` - For account support, troubleshooting, and general customer
182
+ * service communication.
183
+ * - `delivery_notification` - For notifying customers about the status of product
184
+ * or service deliveries.
185
+ * - `fraud_alert` - For warning customers about suspicious or potentially
186
+ * fraudulent activity.
187
+ * - `higher_education` - For messaging related to colleges, universities, and
188
+ * school districts outside of K–12.
189
+ * - `marketing` - For promotional or advertising messages intended to market
190
+ * products or services.
191
+ * - `polling_voting` - For conducting surveys, polls, or voting-related messaging.
192
+ * - `public_service_announcement` - For raising awareness about social issues or
193
+ * important public information.
194
+ * - `security_alert` - For alerts related to potential security breaches or
195
+ * compromised systems requiring user action.
196
+ * - `two_factor_authentication` - For sending one-time passwords or verification
197
+ * codes for login or password reset.
198
+ *
199
+ * For access to special use cases not shown here, reach out to support@surge.app.
200
+ */
201
+ use_cases: Array<'account_notification' | 'customer_care' | 'delivery_notification' | 'fraud_alert' | 'higher_education' | 'marketing' | 'polling_voting' | 'public_service_announcement' | 'security_alert' | 'two_factor_authentication'>;
202
+ /**
203
+ * This will be one of the following:
204
+ *
205
+ * - `low` - The campaign will be allowed to send up to 2000 SMS segments to
206
+ * T-Mobile customers each day. In this case your platform will be charged for
207
+ * the setup fee for a low volume number upon receipt of the API request.
208
+ * - `high` - The campaign will be allowed to send up to 200k SMS segments to
209
+ * T-Mobile customers each day, depending on the trust score assigned by The
210
+ * Campaign Registry. Your platform will be charged for the setup fee for a high
211
+ * volume number upon receipt of the API request, and phone numbers will be
212
+ * charged as high volume numbers going forward.
213
+ */
214
+ volume: 'high' | 'low';
215
+ /**
216
+ * A list of properties that this campaign should include. These properties can be
217
+ * any of the following values:
218
+ *
219
+ * - `links` - whether the campaign might send links in messages
220
+ * - `phone_numbers` - whether the campaign might send phone numbers in messages
221
+ * - `age_gated` - whether the campaign contains age gated content (controlled
222
+ * substances or adult content)
223
+ * - `direct_lending` - whether the campaign contains content related to direct
224
+ * lending or other loan arrangements
225
+ */
226
+ includes?: Array<'links' | 'phone_numbers' | 'age_gated' | 'direct_lending'>;
227
+ /**
228
+ * A sample link that might be sent by this campaign. If links from other domains
229
+ * are sent through this campaign, they are much more likely to be filtered by the
230
+ * carriers. If link shortening is enabled for the account, the link shortener URL
231
+ * will be used instead of what is provided. Reach out to support if you would like
232
+ * to disable automatic link shortening.
233
+ */
234
+ link_sample?: string;
235
+ /**
236
+ * The URL of the terms and conditions presented to end users when they opt in to
237
+ * messaging. These terms and conditions may be shared among all of a platform's
238
+ * customers if they're the terms that are presented to end users when they opt in
239
+ * to messaging.
240
+ */
241
+ terms_and_conditions_url?: string;
242
+ }
243
+ interface ExternalCampaignParams {
244
+ /**
245
+ * The Campaign Registry (TCR) ID for the externally registered campaign
246
+ */
247
+ tcr_id: string;
248
+ }
240
249
  }
241
250
  export declare namespace Campaigns {
242
251
  export { type Campaign as Campaign, type CampaignCreateParams as CampaignCreateParams };
package/resources/campaigns.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"campaigns.d.ts","sourceRoot":"","sources":["../src/resources/campaigns.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;CAGtG;AAED;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;;;OAKG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;;;;;;;OAUG;IACH,QAAQ,EAAE,KAAK,CAAC,OAAO,GAAG,eAAe,GAAG,WAAW,GAAG,gBAAgB,CAAC,CAAC;IAE5E;;;;;;;;OAQG;IACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;;;OAIG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,SAAS,EAAE,KAAK,CACZ,sBAAsB,GACtB,eAAe,GACf,uBAAuB,GACvB,aAAa,GACb,kBAAkB,GAClB,WAAW,GACX,gBAAgB,GAChB,6BAA6B,GAC7B,gBAAgB,GAChB,2BAA2B,CAC9B,CAAC;IAEF;;;;;;;;;;;OAWG;IACH,MAAM,EAAE,MAAM,GAAG,KAAK,CAAC;IAEvB;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;OAKG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;CACnC;AAED,MAAM,WAAW,oBAAoB;IACnC;;;;;OAKG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;;;;;OAQG;IACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;;;OAIG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,SAAS,EAAE,KAAK,CACZ,sBAAsB,GACtB,eAAe,GACf,uBAAuB,GACvB,aAAa,GACb,kBAAkB,GAClB,WAAW,GACX,gBAAgB,GAChB,6BAA6B,GAC7B,gBAAgB,GAChB,2BAA2B,CAC9B,CAAC;IAEF;;;;;;;;;;;OAWG;IACH,MAAM,EAAE,MAAM,GAAG,KAAK,CAAC;IAEvB;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,eAAe,GAAG,WAAW,GAAG,gBAAgB,CAAC,CAAC;IAE7E;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;OAKG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;CACnC;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EAAE,KAAK,QAAQ,IAAI,QAAQ,EAAE,KAAK,oBAAoB,IAAI,oBAAoB,EAAE,CAAC;CACzF"}
1
+ {"version":3,"file":"campaigns.d.ts","sourceRoot":"","sources":["../src/resources/campaigns.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;CAGtG;AAED;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;;;OAKG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;;;;;;;OAUG;IACH,QAAQ,EAAE,KAAK,CAAC,OAAO,GAAG,eAAe,GAAG,WAAW,GAAG,gBAAgB,CAAC,CAAC;IAE5E;;;;;;;;OAQG;IACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;;;OAIG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,SAAS,EAAE,KAAK,CACZ,sBAAsB,GACtB,eAAe,GACf,uBAAuB,GACvB,aAAa,GACb,kBAAkB,GAClB,WAAW,GACX,gBAAgB,GAChB,6BAA6B,GAC7B,gBAAgB,GAChB,2BAA2B,CAC9B,CAAC;IAEF;;;;;;;;;;;OAWG;IACH,MAAM,EAAE,MAAM,GAAG,KAAK,CAAC;IAEvB;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;OAKG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;CACnC;AAED,MAAM,MAAM,oBAAoB,GAC5B,oBAAoB,CAAC,sBAAsB,GAC3C,oBAAoB,CAAC,sBAAsB,CAAC;AAEhD,MAAM,CAAC,OAAO,WAAW,oBAAoB,CAAC;IAC5C,UAAiB,sBAAsB;QACrC;;;;;WAKG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;;;;;;;WAQG;QACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE/B;;;;WAIG;QACH,kBAAkB,EAAE,MAAM,CAAC;QAE3B;;;;;;;;;;;;;;;;;;;;;;;;;;;WA2BG;QACH,SAAS,EAAE,KAAK,CACZ,sBAAsB,GACtB,eAAe,GACf,uBAAuB,GACvB,aAAa,GACb,kBAAkB,GAClB,WAAW,GACX,gBAAgB,GAChB,6BAA6B,GAC7B,gBAAgB,GAChB,2BAA2B,CAC9B,CAAC;QAEF;;;;;;;;;;;WAWG;QACH,MAAM,EAAE,MAAM,GAAG,KAAK,CAAC;QAEvB;;;;;;;;;;WAUG;QACH,QAAQ,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,eAAe,GAAG,WAAW,GAAG,gBAAgB,CAAC,CAAC;QAE7E;;;;;;WAMG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;;;WAKG;QACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;KACnC;IAED,UAAiB,sBAAsB;QACrC;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;KAChB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EAAE,KAAK,QAAQ,IAAI,QAAQ,EAAE,KAAK,oBAAoB,IAAI,oBAAoB,EAAE,CAAC;CACzF"}
package/src/resources/accounts.ts CHANGED
@@ -432,8 +432,11 @@ export namespace AccountCreateParams {
432
432
  address?: Organization.Address;
433
433
 
434
434
  /**
435
- * An object representing an individual who can be contacted if the carriers have
436
- * any questions about the business.
435
+ * An object representing an individual who can be contacted if Surge or our
436
+ * carrier partners have any questions about the business. If you are registering
437
+ * on behalf of your customer, this must be a contact from your customer's company
438
+ * rather than your own. The individual will likely never be contacted unless there
439
+ * are issues with spam.
437
440
  */
438
441
  contact?: Organization.Contact | null;
439
442
 
@@ -629,8 +632,11 @@ export namespace AccountCreateParams {
629
632
  }
630
633
 
631
634
  /**
632
- * An object representing an individual who can be contacted if the carriers have
633
- * any questions about the business.
635
+ * An object representing an individual who can be contacted if Surge or our
636
+ * carrier partners have any questions about the business. If you are registering
637
+ * on behalf of your customer, this must be a contact from your customer's company
638
+ * rather than your own. The individual will likely never be contacted unless there
639
+ * are issues with spam.
634
640
  */
635
641
  export interface Contact {
636
642
  /**
@@ -638,7 +644,8 @@ export namespace AccountCreateParams {
638
644
  * using the same domain name as the website URL will be preferred (e.g. with a
639
645
  * website domain of `https://dtprecisionauto.com`, an email like
640
646
  * `dom@dtprecisionauto.com` will be preferred over one like
641
- * `dom@anothergarage.com` or `dom.toretto@gmail.com`)
647
+ * `dom@anothergarage.com` or `dom.toretto@gmail.com`. `dtprecisionauto@gmail.com`
648
+ * would also be acceptable, but not preferred)
642
649
  */
643
650
  email?: string | null;
644
651
 
@@ -711,8 +718,11 @@ export namespace AccountUpdateParams {
711
718
  address?: Organization.Address;
712
719
 
713
720
  /**
714
- * An object representing an individual who can be contacted if the carriers have
715
- * any questions about the business.
721
+ * An object representing an individual who can be contacted if Surge or our
722
+ * carrier partners have any questions about the business. If you are registering
723
+ * on behalf of your customer, this must be a contact from your customer's company
724
+ * rather than your own. The individual will likely never be contacted unless there
725
+ * are issues with spam.
716
726
  */
717
727
  contact?: Organization.Contact | null;
718
728
 
@@ -908,8 +918,11 @@ export namespace AccountUpdateParams {
908
918
  }
909
919
 
910
920
  /**
911
- * An object representing an individual who can be contacted if the carriers have
912
- * any questions about the business.
921
+ * An object representing an individual who can be contacted if Surge or our
922
+ * carrier partners have any questions about the business. If you are registering
923
+ * on behalf of your customer, this must be a contact from your customer's company
924
+ * rather than your own. The individual will likely never be contacted unless there
925
+ * are issues with spam.
913
926
  */
914
927
  export interface Contact {
915
928
  /**
@@ -917,7 +930,8 @@ export namespace AccountUpdateParams {
917
930
  * using the same domain name as the website URL will be preferred (e.g. with a
918
931
  * website domain of `https://dtprecisionauto.com`, an email like
919
932
  * `dom@dtprecisionauto.com` will be preferred over one like
920
- * `dom@anothergarage.com` or `dom.toretto@gmail.com`)
933
+ * `dom@anothergarage.com` or `dom.toretto@gmail.com`. `dtprecisionauto@gmail.com`
934
+ * would also be acceptable, but not preferred)
921
935
  */
922
936
  email?: string | null;
923
937
 
package/src/resources/campaigns.ts CHANGED
@@ -167,123 +167,136 @@ export interface Campaign {
167
167
  terms_and_conditions_url?: string;
168
168
  }
169
169
 
170
- export interface CampaignCreateParams {
171
- /**
172
- * A string explaining the method through which end users will opt in to receive
173
- * messages from the brand. Typically this should include URLs for opt-in forms or
174
- * screenshots that might be helpful in explaining the flow to someone unfamiliar
175
- * with the organization's purpose.
176
- */
177
- consent_flow: string;
170
+ export type CampaignCreateParams =
171
+ | CampaignCreateParams.StandardCampaignParams
172
+ | CampaignCreateParams.ExternalCampaignParams;
178
173
 
179
- /**
180
- * An explanation of the organization's purpose and how it will be using text
181
- * messaging to accomplish that purpose.
182
- */
183
- description: string;
174
+ export declare namespace CampaignCreateParams {
175
+ export interface StandardCampaignParams {
176
+ /**
177
+ * A string explaining the method through which end users will opt in to receive
178
+ * messages from the brand. Typically this should include URLs for opt-in forms or
179
+ * screenshots that might be helpful in explaining the flow to someone unfamiliar
180
+ * with the organization's purpose.
181
+ */
182
+ consent_flow: string;
184
183
 
185
- /**
186
- * An array of 2-5 strings with examples of the messages that will be sent from
187
- * this campaign. Typically the first sample should be a compliance message like
188
- * `You are now opted in to messages from {brand name}. Frequency varies. Msg&data rates apply. Reply STOP to opt out.`
189
- * These samples don't necessarily need to be the only templates that will be used
190
- * for the campaign, but they should reflect the purpose of the messages that will
191
- * be sent. Any variable content can be reflected by wrapping it in square brackets
192
- * like `[customer name]`.
193
- */
194
- message_samples: Array<string>;
184
+ /**
185
+ * An explanation of the organization's purpose and how it will be using text
186
+ * messaging to accomplish that purpose.
187
+ */
188
+ description: string;
195
189
 
196
- /**
197
- * The URL of the privacy policy for the brand in question. This may be a shared
198
- * privacy policy if it's the policy that is displayed to end users when they opt
199
- * in to messaging.
200
- */
201
- privacy_policy_url: string;
190
+ /**
191
+ * An array of 2-5 strings with examples of the messages that will be sent from
192
+ * this campaign. Typically the first sample should be a compliance message like
193
+ * `You are now opted in to messages from {brand name}. Frequency varies. Msg&data rates apply. Reply STOP to opt out.`
194
+ * These samples don't necessarily need to be the only templates that will be used
195
+ * for the campaign, but they should reflect the purpose of the messages that will
196
+ * be sent. Any variable content can be reflected by wrapping it in square brackets
197
+ * like `[customer name]`.
198
+ */
199
+ message_samples: Array<string>;
202
200
 
203
- /**
204
- * A list containing 1-5 types of messages that will be sent with this campaign.
205
- *
206
- * The following use cases are typically available to all brands:
207
- *
208
- * - `account_notification` - For sending reminders, alerts, and general
209
- * account-related notifications like booking confirmations or appointment
210
- * reminders.
211
- * - `customer_care` - For account support, troubleshooting, and general customer
212
- * service communication.
213
- * - `delivery_notification` - For notifying customers about the status of product
214
- * or service deliveries.
215
- * - `fraud_alert` - For warning customers about suspicious or potentially
216
- * fraudulent activity.
217
- * - `higher_education` - For messaging related to colleges, universities, and
218
- * school districts outside of K–12.
219
- * - `marketing` - For promotional or advertising messages intended to market
220
- * products or services.
221
- * - `polling_voting` - For conducting surveys, polls, or voting-related messaging.
222
- * - `public_service_announcement` - For raising awareness about social issues or
223
- * important public information.
224
- * - `security_alert` - For alerts related to potential security breaches or
225
- * compromised systems requiring user action.
226
- * - `two_factor_authentication` - For sending one-time passwords or verification
227
- * codes for login or password reset.
228
- *
229
- * For access to special use cases not shown here, reach out to support@surge.app.
230
- */
231
- use_cases: Array<
232
- | 'account_notification'
233
- | 'customer_care'
234
- | 'delivery_notification'
235
- | 'fraud_alert'
236
- | 'higher_education'
237
- | 'marketing'
238
- | 'polling_voting'
239
- | 'public_service_announcement'
240
- | 'security_alert'
241
- | 'two_factor_authentication'
242
- >;
201
+ /**
202
+ * The URL of the privacy policy for the brand in question. This may be a shared
203
+ * privacy policy if it's the policy that is displayed to end users when they opt
204
+ * in to messaging.
205
+ */
206
+ privacy_policy_url: string;
243
207
 
244
- /**
245
- * This will be one of the following:
246
- *
247
- * - `low` - The campaign will be allowed to send up to 2000 SMS segments to
248
- * T-Mobile customers each day. In this case your platform will be charged for
249
- * the setup fee for a low volume number upon receipt of the API request.
250
- * - `high` - The campaign will be allowed to send up to 200k SMS segments to
251
- * T-Mobile customers each day, depending on the trust score assigned by The
252
- * Campaign Registry. Your platform will be charged for the setup fee for a high
253
- * volume number upon receipt of the API request, and phone numbers will be
254
- * charged as high volume numbers going forward.
255
- */
256
- volume: 'high' | 'low';
208
+ /**
209
+ * A list containing 1-5 types of messages that will be sent with this campaign.
210
+ *
211
+ * The following use cases are typically available to all brands:
212
+ *
213
+ * - `account_notification` - For sending reminders, alerts, and general
214
+ * account-related notifications like booking confirmations or appointment
215
+ * reminders.
216
+ * - `customer_care` - For account support, troubleshooting, and general customer
217
+ * service communication.
218
+ * - `delivery_notification` - For notifying customers about the status of product
219
+ * or service deliveries.
220
+ * - `fraud_alert` - For warning customers about suspicious or potentially
221
+ * fraudulent activity.
222
+ * - `higher_education` - For messaging related to colleges, universities, and
223
+ * school districts outside of K–12.
224
+ * - `marketing` - For promotional or advertising messages intended to market
225
+ * products or services.
226
+ * - `polling_voting` - For conducting surveys, polls, or voting-related messaging.
227
+ * - `public_service_announcement` - For raising awareness about social issues or
228
+ * important public information.
229
+ * - `security_alert` - For alerts related to potential security breaches or
230
+ * compromised systems requiring user action.
231
+ * - `two_factor_authentication` - For sending one-time passwords or verification
232
+ * codes for login or password reset.
233
+ *
234
+ * For access to special use cases not shown here, reach out to support@surge.app.
235
+ */
236
+ use_cases: Array<
237
+ | 'account_notification'
238
+ | 'customer_care'
239
+ | 'delivery_notification'
240
+ | 'fraud_alert'
241
+ | 'higher_education'
242
+ | 'marketing'
243
+ | 'polling_voting'
244
+ | 'public_service_announcement'
245
+ | 'security_alert'
246
+ | 'two_factor_authentication'
247
+ >;
257
248
 
258
- /**
259
- * A list of properties that this campaign should include. These properties can be
260
- * any of the following values:
261
- *
262
- * - `links` - whether the campaign might send links in messages
263
- * - `phone_numbers` - whether the campaign might send phone numbers in messages
264
- * - `age_gated` - whether the campaign contains age gated content (controlled
265
- * substances or adult content)
266
- * - `direct_lending` - whether the campaign contains content related to direct
267
- * lending or other loan arrangements
268
- */
269
- includes?: Array<'links' | 'phone_numbers' | 'age_gated' | 'direct_lending'>;
249
+ /**
250
+ * This will be one of the following:
251
+ *
252
+ * - `low` - The campaign will be allowed to send up to 2000 SMS segments to
253
+ * T-Mobile customers each day. In this case your platform will be charged for
254
+ * the setup fee for a low volume number upon receipt of the API request.
255
+ * - `high` - The campaign will be allowed to send up to 200k SMS segments to
256
+ * T-Mobile customers each day, depending on the trust score assigned by The
257
+ * Campaign Registry. Your platform will be charged for the setup fee for a high
258
+ * volume number upon receipt of the API request, and phone numbers will be
259
+ * charged as high volume numbers going forward.
260
+ */
261
+ volume: 'high' | 'low';
270
262
 
271
- /**
272
- * A sample link that might be sent by this campaign. If links from other domains
273
- * are sent through this campaign, they are much more likely to be filtered by the
274
- * carriers. If link shortening is enabled for the account, the link shortener URL
275
- * will be used instead of what is provided. Reach out to support if you would like
276
- * to disable automatic link shortening.
277
- */
278
- link_sample?: string;
263
+ /**
264
+ * A list of properties that this campaign should include. These properties can be
265
+ * any of the following values:
266
+ *
267
+ * - `links` - whether the campaign might send links in messages
268
+ * - `phone_numbers` - whether the campaign might send phone numbers in messages
269
+ * - `age_gated` - whether the campaign contains age gated content (controlled
270
+ * substances or adult content)
271
+ * - `direct_lending` - whether the campaign contains content related to direct
272
+ * lending or other loan arrangements
273
+ */
274
+ includes?: Array<'links' | 'phone_numbers' | 'age_gated' | 'direct_lending'>;
279
275
 
280
- /**
281
- * The URL of the terms and conditions presented to end users when they opt in to
282
- * messaging. These terms and conditions may be shared among all of a platform's
283
- * customers if they're the terms that are presented to end users when they opt in
284
- * to messaging.
285
- */
286
- terms_and_conditions_url?: string;
276
+ /**
277
+ * A sample link that might be sent by this campaign. If links from other domains
278
+ * are sent through this campaign, they are much more likely to be filtered by the
279
+ * carriers. If link shortening is enabled for the account, the link shortener URL
280
+ * will be used instead of what is provided. Reach out to support if you would like
281
+ * to disable automatic link shortening.
282
+ */
283
+ link_sample?: string;
284
+
285
+ /**
286
+ * The URL of the terms and conditions presented to end users when they opt in to
287
+ * messaging. These terms and conditions may be shared among all of a platform's
288
+ * customers if they're the terms that are presented to end users when they opt in
289
+ * to messaging.
290
+ */
291
+ terms_and_conditions_url?: string;
292
+ }
293
+
294
+ export interface ExternalCampaignParams {
295
+ /**
296
+ * The Campaign Registry (TCR) ID for the externally registered campaign
297
+ */
298
+ tcr_id: string;
299
+ }
287
300
  }
288
301
 
289
302
  export declare namespace Campaigns {
package/src/version.ts CHANGED
@@ -1 +1 @@
1
- export const VERSION = '0.27.0'; // x-release-please-version
1
+ export const VERSION = '0.27.1'; // x-release-please-version
package/version.d.mts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "0.27.0";
1
+ export declare const VERSION = "0.27.1";
2
2
  //# sourceMappingURL=version.d.mts.map
package/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "0.27.0";
1
+ export declare const VERSION = "0.27.1";
2
2
  //# sourceMappingURL=version.d.ts.map
package/version.js CHANGED
@@ -1,5 +1,5 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.VERSION = void 0;
4
- exports.VERSION = '0.27.0'; // x-release-please-version
4
+ exports.VERSION = '0.27.1'; // x-release-please-version
5
5
  //# sourceMappingURL=version.js.map
package/version.mjs CHANGED
@@ -1,2 +1,2 @@
1
- export const VERSION = '0.27.0'; // x-release-please-version
1
+ export const VERSION = '0.27.1'; // x-release-please-version
2
2
  //# sourceMappingURL=version.mjs.map