pingram 1.0.28 → 1.0.29-alpha.1454

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.
@@ -75,12 +75,6 @@ export interface AccountGetResponse {
75
75
  * @memberof AccountGetResponse
76
76
  */
77
77
  anniversaryDate: string;
78
- /**
79
- *
80
- * @type {boolean}
81
- * @memberof AccountGetResponse
82
- */
83
- allowOverage: boolean;
84
78
  /**
85
79
  *
86
80
  * @type {string}
@@ -105,6 +99,24 @@ export interface AccountGetResponse {
105
99
  * @memberof AccountGetResponse
106
100
  */
107
101
  subscriptionStatus?: AccountGetResponseSubscriptionStatusEnum | null;
102
+ /**
103
+ *
104
+ * @type {string}
105
+ * @memberof AccountGetResponse
106
+ */
107
+ pendingDowngradeEffectiveDate?: string;
108
+ /**
109
+ *
110
+ * @type {number}
111
+ * @memberof AccountGetResponse
112
+ */
113
+ pendingDowngradeCostCap?: number;
114
+ /**
115
+ *
116
+ * @type {string}
117
+ * @memberof AccountGetResponse
118
+ */
119
+ pendingDowngradeAccountType?: AccountGetResponsePendingDowngradeAccountTypeEnum;
108
120
  }
109
121
  /**
110
122
  * @export
@@ -141,6 +153,13 @@ export declare enum AccountGetResponseSubscriptionStatusEnum {
141
153
  PAST_DUE = "past_due",
142
154
  PAUSED = "paused"
143
155
  }
156
+ /**
157
+ * @export
158
+ * @enum {string}
159
+ */
160
+ export declare enum AccountGetResponsePendingDowngradeAccountTypeEnum {
161
+ FREE = "free"
162
+ }
144
163
  /**
145
164
  * Check if a given object implements the AccountGetResponse interface.
146
165
  */
@@ -13,7 +13,7 @@
13
13
  * Do not edit the class manually.
14
14
  */
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
- exports.AccountGetResponseSubscriptionStatusEnum = exports.AccountGetResponseStatusEnum = exports.AccountGetResponseBillingVersionEnum = exports.AccountGetResponseAccountTypeEnum = void 0;
16
+ exports.AccountGetResponsePendingDowngradeAccountTypeEnum = exports.AccountGetResponseSubscriptionStatusEnum = exports.AccountGetResponseStatusEnum = exports.AccountGetResponseBillingVersionEnum = exports.AccountGetResponseAccountTypeEnum = void 0;
17
17
  exports.instanceOfAccountGetResponse = instanceOfAccountGetResponse;
18
18
  exports.AccountGetResponseFromJSON = AccountGetResponseFromJSON;
19
19
  exports.AccountGetResponseFromJSONTyped = AccountGetResponseFromJSONTyped;
@@ -58,6 +58,14 @@ var AccountGetResponseSubscriptionStatusEnum;
58
58
  AccountGetResponseSubscriptionStatusEnum["PAST_DUE"] = "past_due";
59
59
  AccountGetResponseSubscriptionStatusEnum["PAUSED"] = "paused";
60
60
  })(AccountGetResponseSubscriptionStatusEnum || (exports.AccountGetResponseSubscriptionStatusEnum = AccountGetResponseSubscriptionStatusEnum = {}));
61
+ /**
62
+ * @export
63
+ * @enum {string}
64
+ */
65
+ var AccountGetResponsePendingDowngradeAccountTypeEnum;
66
+ (function (AccountGetResponsePendingDowngradeAccountTypeEnum) {
67
+ AccountGetResponsePendingDowngradeAccountTypeEnum["FREE"] = "free";
68
+ })(AccountGetResponsePendingDowngradeAccountTypeEnum || (exports.AccountGetResponsePendingDowngradeAccountTypeEnum = AccountGetResponsePendingDowngradeAccountTypeEnum = {}));
61
69
  /**
62
70
  * Check if a given object implements the AccountGetResponse interface.
63
71
  */
@@ -72,8 +80,6 @@ function instanceOfAccountGetResponse(value) {
72
80
  return false;
73
81
  if (!('anniversaryDate' in value) || value['anniversaryDate'] === undefined)
74
82
  return false;
75
- if (!('allowOverage' in value) || value['allowOverage'] === undefined)
76
- return false;
77
83
  if (!('createdAt' in value) || value['createdAt'] === undefined)
78
84
  return false;
79
85
  if (!('updatedAt' in value) || value['updatedAt'] === undefined)
@@ -98,13 +104,21 @@ function AccountGetResponseFromJSONTyped(json, ignoreDiscriminator) {
98
104
  callCap: json['callCap'] == null ? undefined : json['callCap'],
99
105
  billingVersion: json['billingVersion'] == null ? undefined : json['billingVersion'],
100
106
  anniversaryDate: json['anniversaryDate'],
101
- allowOverage: json['allowOverage'],
102
107
  createdAt: json['createdAt'],
103
108
  updatedAt: json['updatedAt'],
104
109
  status: json['status'] == null ? undefined : json['status'],
105
110
  subscriptionStatus: json['subscriptionStatus'] == null
106
111
  ? undefined
107
- : json['subscriptionStatus']
112
+ : json['subscriptionStatus'],
113
+ pendingDowngradeEffectiveDate: json['pendingDowngradeEffectiveDate'] == null
114
+ ? undefined
115
+ : json['pendingDowngradeEffectiveDate'],
116
+ pendingDowngradeCostCap: json['pendingDowngradeCostCap'] == null
117
+ ? undefined
118
+ : json['pendingDowngradeCostCap'],
119
+ pendingDowngradeAccountType: json['pendingDowngradeAccountType'] == null
120
+ ? undefined
121
+ : json['pendingDowngradeAccountType']
108
122
  };
109
123
  }
110
124
  function AccountGetResponseToJSON(json) {
@@ -125,10 +139,12 @@ function AccountGetResponseToJSONTyped(value, ignoreDiscriminator = false) {
125
139
  callCap: value['callCap'],
126
140
  billingVersion: value['billingVersion'],
127
141
  anniversaryDate: value['anniversaryDate'],
128
- allowOverage: value['allowOverage'],
129
142
  createdAt: value['createdAt'],
130
143
  updatedAt: value['updatedAt'],
131
144
  status: value['status'],
132
- subscriptionStatus: value['subscriptionStatus']
145
+ subscriptionStatus: value['subscriptionStatus'],
146
+ pendingDowngradeEffectiveDate: value['pendingDowngradeEffectiveDate'],
147
+ pendingDowngradeCostCap: value['pendingDowngradeCostCap'],
148
+ pendingDowngradeAccountType: value['pendingDowngradeAccountType']
133
149
  };
134
150
  }
@@ -75,12 +75,6 @@ export interface BillingPostResponseBody {
75
75
  * @memberof BillingPostResponseBody
76
76
  */
77
77
  anniversaryDate: string;
78
- /**
79
- *
80
- * @type {boolean}
81
- * @memberof BillingPostResponseBody
82
- */
83
- allowOverage: boolean;
84
78
  /**
85
79
  *
86
80
  * @type {string}
@@ -105,6 +99,24 @@ export interface BillingPostResponseBody {
105
99
  * @memberof BillingPostResponseBody
106
100
  */
107
101
  subscriptionStatus?: BillingPostResponseBodySubscriptionStatusEnum | null;
102
+ /**
103
+ *
104
+ * @type {string}
105
+ * @memberof BillingPostResponseBody
106
+ */
107
+ pendingDowngradeEffectiveDate?: string;
108
+ /**
109
+ *
110
+ * @type {number}
111
+ * @memberof BillingPostResponseBody
112
+ */
113
+ pendingDowngradeCostCap?: number;
114
+ /**
115
+ *
116
+ * @type {string}
117
+ * @memberof BillingPostResponseBody
118
+ */
119
+ pendingDowngradeAccountType?: BillingPostResponseBodyPendingDowngradeAccountTypeEnum;
108
120
  /**
109
121
  *
110
122
  * @type {string}
@@ -153,6 +165,13 @@ export declare enum BillingPostResponseBodySubscriptionStatusEnum {
153
165
  PAST_DUE = "past_due",
154
166
  PAUSED = "paused"
155
167
  }
168
+ /**
169
+ * @export
170
+ * @enum {string}
171
+ */
172
+ export declare enum BillingPostResponseBodyPendingDowngradeAccountTypeEnum {
173
+ FREE = "free"
174
+ }
156
175
  /**
157
176
  * Check if a given object implements the BillingPostResponseBody interface.
158
177
  */
@@ -13,7 +13,7 @@
13
13
  * Do not edit the class manually.
14
14
  */
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
- exports.BillingPostResponseBodySubscriptionStatusEnum = exports.BillingPostResponseBodyStatusEnum = exports.BillingPostResponseBodyBillingVersionEnum = exports.BillingPostResponseBodyAccountTypeEnum = void 0;
16
+ exports.BillingPostResponseBodyPendingDowngradeAccountTypeEnum = exports.BillingPostResponseBodySubscriptionStatusEnum = exports.BillingPostResponseBodyStatusEnum = exports.BillingPostResponseBodyBillingVersionEnum = exports.BillingPostResponseBodyAccountTypeEnum = void 0;
17
17
  exports.instanceOfBillingPostResponseBody = instanceOfBillingPostResponseBody;
18
18
  exports.BillingPostResponseBodyFromJSON = BillingPostResponseBodyFromJSON;
19
19
  exports.BillingPostResponseBodyFromJSONTyped = BillingPostResponseBodyFromJSONTyped;
@@ -58,6 +58,14 @@ var BillingPostResponseBodySubscriptionStatusEnum;
58
58
  BillingPostResponseBodySubscriptionStatusEnum["PAST_DUE"] = "past_due";
59
59
  BillingPostResponseBodySubscriptionStatusEnum["PAUSED"] = "paused";
60
60
  })(BillingPostResponseBodySubscriptionStatusEnum || (exports.BillingPostResponseBodySubscriptionStatusEnum = BillingPostResponseBodySubscriptionStatusEnum = {}));
61
+ /**
62
+ * @export
63
+ * @enum {string}
64
+ */
65
+ var BillingPostResponseBodyPendingDowngradeAccountTypeEnum;
66
+ (function (BillingPostResponseBodyPendingDowngradeAccountTypeEnum) {
67
+ BillingPostResponseBodyPendingDowngradeAccountTypeEnum["FREE"] = "free";
68
+ })(BillingPostResponseBodyPendingDowngradeAccountTypeEnum || (exports.BillingPostResponseBodyPendingDowngradeAccountTypeEnum = BillingPostResponseBodyPendingDowngradeAccountTypeEnum = {}));
61
69
  /**
62
70
  * Check if a given object implements the BillingPostResponseBody interface.
63
71
  */
@@ -72,8 +80,6 @@ function instanceOfBillingPostResponseBody(value) {
72
80
  return false;
73
81
  if (!('anniversaryDate' in value) || value['anniversaryDate'] === undefined)
74
82
  return false;
75
- if (!('allowOverage' in value) || value['allowOverage'] === undefined)
76
- return false;
77
83
  if (!('createdAt' in value) || value['createdAt'] === undefined)
78
84
  return false;
79
85
  if (!('updatedAt' in value) || value['updatedAt'] === undefined)
@@ -98,13 +104,21 @@ function BillingPostResponseBodyFromJSONTyped(json, ignoreDiscriminator) {
98
104
  callCap: json['callCap'] == null ? undefined : json['callCap'],
99
105
  billingVersion: json['billingVersion'] == null ? undefined : json['billingVersion'],
100
106
  anniversaryDate: json['anniversaryDate'],
101
- allowOverage: json['allowOverage'],
102
107
  createdAt: json['createdAt'],
103
108
  updatedAt: json['updatedAt'],
104
109
  status: json['status'] == null ? undefined : json['status'],
105
110
  subscriptionStatus: json['subscriptionStatus'] == null
106
111
  ? undefined
107
112
  : json['subscriptionStatus'],
113
+ pendingDowngradeEffectiveDate: json['pendingDowngradeEffectiveDate'] == null
114
+ ? undefined
115
+ : json['pendingDowngradeEffectiveDate'],
116
+ pendingDowngradeCostCap: json['pendingDowngradeCostCap'] == null
117
+ ? undefined
118
+ : json['pendingDowngradeCostCap'],
119
+ pendingDowngradeAccountType: json['pendingDowngradeAccountType'] == null
120
+ ? undefined
121
+ : json['pendingDowngradeAccountType'],
108
122
  sessionId: json['sessionId'] == null ? undefined : json['sessionId'],
109
123
  url: json['url'] == null ? undefined : json['url']
110
124
  };
@@ -127,11 +141,13 @@ function BillingPostResponseBodyToJSONTyped(value, ignoreDiscriminator = false)
127
141
  callCap: value['callCap'],
128
142
  billingVersion: value['billingVersion'],
129
143
  anniversaryDate: value['anniversaryDate'],
130
- allowOverage: value['allowOverage'],
131
144
  createdAt: value['createdAt'],
132
145
  updatedAt: value['updatedAt'],
133
146
  status: value['status'],
134
147
  subscriptionStatus: value['subscriptionStatus'],
148
+ pendingDowngradeEffectiveDate: value['pendingDowngradeEffectiveDate'],
149
+ pendingDowngradeCostCap: value['pendingDowngradeCostCap'],
150
+ pendingDowngradeAccountType: value['pendingDowngradeAccountType'],
135
151
  sessionId: value['sessionId'],
136
152
  url: value['url']
137
153
  };
@@ -35,79 +35,79 @@ export interface TenDlcBrandAdminUpdateRequest {
35
35
  */
36
36
  businessType?: TenDlcBrandAdminUpdateRequestBusinessTypeEnum;
37
37
  /**
38
- *
38
+ * Official registered legal business name. For SOLE_PROPRIETOR, optional DBA or trade name (defaults to firstName and lastName).
39
39
  * @type {string}
40
40
  * @memberof TenDlcBrandAdminUpdateRequest
41
41
  */
42
42
  legalName?: string;
43
43
  /**
44
- * Brand display name (marketing/DBA); defaults to legalName when omitted on legalName-only updates.
44
+ * Public brand name shown to recipients and carriers. Use the name customers recognize (your DBA or trade name). For SOLE_PROPRIETOR, this is the brand you send as — not the individual's legal name. Omit to keep the existing value. If you change legalName and omit displayName, displayName is reset to the new legalName.
45
45
  * @type {string}
46
46
  * @memberof TenDlcBrandAdminUpdateRequest
47
47
  */
48
48
  displayName?: string;
49
49
  /**
50
- *
50
+ * Legal first name of the sole proprietor. Required when businessType is SOLE_PROPRIETOR.
51
51
  * @type {string}
52
52
  * @memberof TenDlcBrandAdminUpdateRequest
53
53
  */
54
54
  firstName?: string;
55
55
  /**
56
- *
56
+ * Legal last name of the sole proprietor. Required when businessType is SOLE_PROPRIETOR.
57
57
  * @type {string}
58
58
  * @memberof TenDlcBrandAdminUpdateRequest
59
59
  */
60
60
  lastName?: string;
61
61
  /**
62
- * For US companies (country US): 9-digit EIN (Employer Identification Number). For Canada (country CA): 9-digit BN (Business Number). For other countries: national business tax identifier.
62
+ * For US companies (country US): 9-digit EIN (Employer Identification Number). For Canada (country CA): 9-digit BN (Business Number). For other countries: national business tax identifier. Required except when businessType is SOLE_PROPRIETOR.
63
63
  * @type {string}
64
64
  * @memberof TenDlcBrandAdminUpdateRequest
65
65
  */
66
66
  taxId?: string;
67
67
  /**
68
- *
68
+ * Public website for the brand. Include a scheme (https://) or a domain; https:// is prepended when omitted. Carriers expect a working site with privacy policy and terms.
69
69
  * @type {string}
70
70
  * @memberof TenDlcBrandAdminUpdateRequest
71
71
  */
72
72
  website?: string;
73
73
  /**
74
- *
74
+ * ISO 3166-1 alpha-2 country of incorporation (for example US or CA).
75
75
  * @type {string}
76
76
  * @memberof TenDlcBrandAdminUpdateRequest
77
77
  */
78
78
  country?: string;
79
79
  /**
80
- *
80
+ * Street address that matches official tax registration.
81
81
  * @type {string}
82
82
  * @memberof TenDlcBrandAdminUpdateRequest
83
83
  */
84
84
  street?: string;
85
85
  /**
86
- *
86
+ * City that matches official tax registration.
87
87
  * @type {string}
88
88
  * @memberof TenDlcBrandAdminUpdateRequest
89
89
  */
90
90
  city?: string;
91
91
  /**
92
- *
92
+ * State (US) or province (CA) that matches official tax registration.
93
93
  * @type {string}
94
94
  * @memberof TenDlcBrandAdminUpdateRequest
95
95
  */
96
96
  state?: string;
97
97
  /**
98
- *
98
+ * ZIP code (US) or postal code (CA) that matches official tax registration.
99
99
  * @type {string}
100
100
  * @memberof TenDlcBrandAdminUpdateRequest
101
101
  */
102
102
  postalCode?: string;
103
103
  /**
104
- *
104
+ * Email for the 10DLC compliance contact. Used for carrier and registration follow-up.
105
105
  * @type {string}
106
106
  * @memberof TenDlcBrandAdminUpdateRequest
107
107
  */
108
108
  complianceContactEmail?: string;
109
109
  /**
110
- *
110
+ * Phone number for the 10DLC compliance contact. E.164 preferred; national numbers are normalized using country.
111
111
  * @type {string}
112
112
  * @memberof TenDlcBrandAdminUpdateRequest
113
113
  */
@@ -35,19 +35,25 @@ export interface TenDlcBrandCreateRequest {
35
35
  */
36
36
  businessType: TenDlcBrandCreateRequestBusinessTypeEnum;
37
37
  /**
38
- *
38
+ * Official registered legal business name. For SOLE_PROPRIETOR, optional DBA or trade name (defaults to firstName and lastName).
39
39
  * @type {string}
40
40
  * @memberof TenDlcBrandCreateRequest
41
41
  */
42
- legalName: string;
42
+ legalName?: string;
43
43
  /**
44
- * Required when businessType is SOLE_PROPRIETOR.
44
+ * Public brand name shown to recipients and carriers. Use the name customers recognize (your DBA or trade name). For companies with no DBA, use the same value as legalName. For SOLE_PROPRIETOR, this is the brand you send as — not the individual's legal name (set firstName and lastName for that). If the sole proprietor has no DBA, use first and last name.
45
+ * @type {string}
46
+ * @memberof TenDlcBrandCreateRequest
47
+ */
48
+ displayName: string;
49
+ /**
50
+ * Legal first name of the sole proprietor. Required when businessType is SOLE_PROPRIETOR.
45
51
  * @type {string}
46
52
  * @memberof TenDlcBrandCreateRequest
47
53
  */
48
54
  firstName?: string;
49
55
  /**
50
- * Required when businessType is SOLE_PROPRIETOR.
56
+ * Legal last name of the sole proprietor. Required when businessType is SOLE_PROPRIETOR.
51
57
  * @type {string}
52
58
  * @memberof TenDlcBrandCreateRequest
53
59
  */
@@ -59,49 +65,49 @@ export interface TenDlcBrandCreateRequest {
59
65
  */
60
66
  taxId?: string;
61
67
  /**
62
- *
68
+ * Public website for the brand. Include a scheme (https://) or a domain; https:// is prepended when omitted. Carriers expect a working site with privacy policy and terms.
63
69
  * @type {string}
64
70
  * @memberof TenDlcBrandCreateRequest
65
71
  */
66
72
  website: string;
67
73
  /**
68
- *
74
+ * ISO 3166-1 alpha-2 country of incorporation (for example US or CA).
69
75
  * @type {string}
70
76
  * @memberof TenDlcBrandCreateRequest
71
77
  */
72
78
  country: string;
73
79
  /**
74
- *
80
+ * Street address that matches official tax registration.
75
81
  * @type {string}
76
82
  * @memberof TenDlcBrandCreateRequest
77
83
  */
78
- street?: string;
84
+ street: string;
79
85
  /**
80
- *
86
+ * City that matches official tax registration.
81
87
  * @type {string}
82
88
  * @memberof TenDlcBrandCreateRequest
83
89
  */
84
- city?: string;
90
+ city: string;
85
91
  /**
86
- *
92
+ * State (US) or province (CA) that matches official tax registration.
87
93
  * @type {string}
88
94
  * @memberof TenDlcBrandCreateRequest
89
95
  */
90
- state?: string;
96
+ state: string;
91
97
  /**
92
- *
98
+ * ZIP code (US) or postal code (CA) that matches official tax registration.
93
99
  * @type {string}
94
100
  * @memberof TenDlcBrandCreateRequest
95
101
  */
96
- postalCode?: string;
102
+ postalCode: string;
97
103
  /**
98
- *
104
+ * Email for the 10DLC compliance contact. Used for carrier and registration follow-up.
99
105
  * @type {string}
100
106
  * @memberof TenDlcBrandCreateRequest
101
107
  */
102
108
  complianceContactEmail: string;
103
109
  /**
104
- *
110
+ * Phone number for the 10DLC compliance contact. E.164 preferred; national numbers are normalized using country.
105
111
  * @type {string}
106
112
  * @memberof TenDlcBrandCreateRequest
107
113
  */
@@ -48,12 +48,20 @@ function instanceOfTenDlcBrandCreateRequest(value) {
48
48
  return false;
49
49
  if (!('businessType' in value) || value['businessType'] === undefined)
50
50
  return false;
51
- if (!('legalName' in value) || value['legalName'] === undefined)
51
+ if (!('displayName' in value) || value['displayName'] === undefined)
52
52
  return false;
53
53
  if (!('website' in value) || value['website'] === undefined)
54
54
  return false;
55
55
  if (!('country' in value) || value['country'] === undefined)
56
56
  return false;
57
+ if (!('street' in value) || value['street'] === undefined)
58
+ return false;
59
+ if (!('city' in value) || value['city'] === undefined)
60
+ return false;
61
+ if (!('state' in value) || value['state'] === undefined)
62
+ return false;
63
+ if (!('postalCode' in value) || value['postalCode'] === undefined)
64
+ return false;
57
65
  if (!('complianceContactEmail' in value) ||
58
66
  value['complianceContactEmail'] === undefined)
59
67
  return false;
@@ -72,16 +80,17 @@ function TenDlcBrandCreateRequestFromJSONTyped(json, ignoreDiscriminator) {
72
80
  return {
73
81
  scenarioId: json['scenarioId'],
74
82
  businessType: json['businessType'],
75
- legalName: json['legalName'],
83
+ legalName: json['legalName'] == null ? undefined : json['legalName'],
84
+ displayName: json['displayName'],
76
85
  firstName: json['firstName'] == null ? undefined : json['firstName'],
77
86
  lastName: json['lastName'] == null ? undefined : json['lastName'],
78
87
  taxId: json['taxId'] == null ? undefined : json['taxId'],
79
88
  website: json['website'],
80
89
  country: json['country'],
81
- street: json['street'] == null ? undefined : json['street'],
82
- city: json['city'] == null ? undefined : json['city'],
83
- state: json['state'] == null ? undefined : json['state'],
84
- postalCode: json['postalCode'] == null ? undefined : json['postalCode'],
90
+ street: json['street'],
91
+ city: json['city'],
92
+ state: json['state'],
93
+ postalCode: json['postalCode'],
85
94
  complianceContactEmail: json['complianceContactEmail'],
86
95
  complianceContactPhone: json['complianceContactPhone']
87
96
  };
@@ -97,6 +106,7 @@ function TenDlcBrandCreateRequestToJSONTyped(value, ignoreDiscriminator = false)
97
106
  scenarioId: value['scenarioId'],
98
107
  businessType: value['businessType'],
99
108
  legalName: value['legalName'],
109
+ displayName: value['displayName'],
100
110
  firstName: value['firstName'],
101
111
  lastName: value['lastName'],
102
112
  taxId: value['taxId'],
@@ -34,67 +34,67 @@ export interface TenDlcBrandRegistration {
34
34
  */
35
35
  businessType: string;
36
36
  /**
37
- *
37
+ * Official registered legal business name. For SOLE_PROPRIETOR, may be a DBA or trade name.
38
38
  * @type {string}
39
39
  * @memberof TenDlcBrandRegistration
40
40
  */
41
41
  legalName: string;
42
42
  /**
43
- * Brand display name (marketing/DBA); defaults to legalName on customer submit.
43
+ * Public brand name shown to recipients and carriers.
44
44
  * @type {string}
45
45
  * @memberof TenDlcBrandRegistration
46
46
  */
47
47
  displayName?: string;
48
48
  /**
49
- *
49
+ * Legal first name of the sole proprietor. Present when businessType is SOLE_PROPRIETOR.
50
50
  * @type {string}
51
51
  * @memberof TenDlcBrandRegistration
52
52
  */
53
53
  firstName?: string;
54
54
  /**
55
- *
55
+ * Legal last name of the sole proprietor. Present when businessType is SOLE_PROPRIETOR.
56
56
  * @type {string}
57
57
  * @memberof TenDlcBrandRegistration
58
58
  */
59
59
  lastName?: string;
60
60
  /**
61
- *
61
+ * For US companies (country US): 9-digit EIN (Employer Identification Number). For Canada (country CA): 9-digit BN (Business Number). For other countries: national business tax identifier. Omitted when businessType is SOLE_PROPRIETOR.
62
62
  * @type {string}
63
63
  * @memberof TenDlcBrandRegistration
64
64
  */
65
65
  taxId?: string;
66
66
  /**
67
- *
67
+ * Public website for the brand.
68
68
  * @type {string}
69
69
  * @memberof TenDlcBrandRegistration
70
70
  */
71
71
  website: string;
72
72
  /**
73
- *
73
+ * ISO 3166-1 alpha-2 country of incorporation (for example US or CA).
74
74
  * @type {string}
75
75
  * @memberof TenDlcBrandRegistration
76
76
  */
77
77
  country: string;
78
78
  /**
79
- *
79
+ * Street address that matches official tax registration.
80
80
  * @type {string}
81
81
  * @memberof TenDlcBrandRegistration
82
82
  */
83
83
  street?: string;
84
84
  /**
85
- *
85
+ * City that matches official tax registration.
86
86
  * @type {string}
87
87
  * @memberof TenDlcBrandRegistration
88
88
  */
89
89
  city?: string;
90
90
  /**
91
- *
91
+ * State (US) or province (CA) that matches official tax registration.
92
92
  * @type {string}
93
93
  * @memberof TenDlcBrandRegistration
94
94
  */
95
95
  state?: string;
96
96
  /**
97
- *
97
+ * ZIP code (US) or postal code (CA) that matches official tax registration.
98
98
  * @type {string}
99
99
  * @memberof TenDlcBrandRegistration
100
100
  */
@@ -106,13 +106,13 @@ export interface TenDlcBrandRegistration {
106
106
  */
107
107
  fullAddress?: string;
108
108
  /**
109
- *
109
+ * Email for the 10DLC compliance contact.
110
110
  * @type {string}
111
111
  * @memberof TenDlcBrandRegistration
112
112
  */
113
113
  complianceContactEmail: string;
114
114
  /**
115
- *
115
+ * Phone number for the 10DLC compliance contact.
116
116
  * @type {string}
117
117
  * @memberof TenDlcBrandRegistration
118
118
  */
@@ -34,67 +34,67 @@ export interface TenDlcBrandRegistrationDetails {
34
34
  */
35
35
  businessType: string;
36
36
  /**
37
- *
37
+ * Official registered legal business name. For SOLE_PROPRIETOR, may be a DBA or trade name.
38
38
  * @type {string}
39
39
  * @memberof TenDlcBrandRegistrationDetails
40
40
  */
41
41
  legalName: string;
42
42
  /**
43
- * Brand display name (marketing/DBA); defaults to legalName on customer submit.
43
+ * Public brand name shown to recipients and carriers.
44
44
  * @type {string}
45
45
  * @memberof TenDlcBrandRegistrationDetails
46
46
  */
47
47
  displayName?: string;
48
48
  /**
49
- *
49
+ * Legal first name of the sole proprietor. Present when businessType is SOLE_PROPRIETOR.
50
50
  * @type {string}
51
51
  * @memberof TenDlcBrandRegistrationDetails
52
52
  */
53
53
  firstName?: string;
54
54
  /**
55
- *
55
+ * Legal last name of the sole proprietor. Present when businessType is SOLE_PROPRIETOR.
56
56
  * @type {string}
57
57
  * @memberof TenDlcBrandRegistrationDetails
58
58
  */
59
59
  lastName?: string;
60
60
  /**
61
- *
61
+ * For US companies (country US): 9-digit EIN (Employer Identification Number). For Canada (country CA): 9-digit BN (Business Number). For other countries: national business tax identifier. Omitted when businessType is SOLE_PROPRIETOR.
62
62
  * @type {string}
63
63
  * @memberof TenDlcBrandRegistrationDetails
64
64
  */
65
65
  taxId?: string;
66
66
  /**
67
- *
67
+ * Public website for the brand.
68
68
  * @type {string}
69
69
  * @memberof TenDlcBrandRegistrationDetails
70
70
  */
71
71
  website: string;
72
72
  /**
73
- *
73
+ * ISO 3166-1 alpha-2 country of incorporation (for example US or CA).
74
74
  * @type {string}
75
75
  * @memberof TenDlcBrandRegistrationDetails
76
76
  */
77
77
  country: string;
78
78
  /**
79
- *
79
+ * Street address that matches official tax registration.
80
80
  * @type {string}
81
81
  * @memberof TenDlcBrandRegistrationDetails
82
82
  */
83
83
  street?: string;
84
84
  /**
85
- *
85
+ * City that matches official tax registration.
86
86
  * @type {string}
87
87
  * @memberof TenDlcBrandRegistrationDetails
88
88
  */
89
89
  city?: string;
90
90
  /**
91
- *
91
+ * State (US) or province (CA) that matches official tax registration.
92
92
  * @type {string}
93
93
  * @memberof TenDlcBrandRegistrationDetails
94
94
  */
95
95
  state?: string;
96
96
  /**
97
- *
97
+ * ZIP code (US) or postal code (CA) that matches official tax registration.
98
98
  * @type {string}
99
99
  * @memberof TenDlcBrandRegistrationDetails
100
100
  */
@@ -106,13 +106,13 @@ export interface TenDlcBrandRegistrationDetails {
106
106
  */
107
107
  fullAddress?: string;
108
108
  /**
109
- *
109
+ * Email for the 10DLC compliance contact.
110
110
  * @type {string}
111
111
  * @memberof TenDlcBrandRegistrationDetails
112
112
  */
113
113
  complianceContactEmail: string;
114
114
  /**
115
- *
115
+ * Phone number for the 10DLC compliance contact.
116
116
  * @type {string}
117
117
  * @memberof TenDlcBrandRegistrationDetails
118
118
  */