Skip to content

Commit 449f5b2

Browse files
author
childish-sambino
authored
docs: use long property descriptions if available (#899)
1 parent 8da34f6 commit 449f5b2

File tree

386 files changed

+3600
-3600
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

386 files changed

+3600
-3600
lines changed

lib/rest/accounts/v1/authTokenPromotion.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -110,19 +110,19 @@ export class AuthTokenPromotionInstance {
110110
}
111111

112112
/**
113-
* The SID of the Account that the secondary Auth Token was created for
113+
* The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that the secondary Auth Token was created for.
114114
*/
115115
accountSid: string;
116116
/**
117-
* The promoted Auth Token
117+
* The promoted Auth Token that must be used to authenticate future API requests.
118118
*/
119119
authToken: string;
120120
/**
121-
* The ISO 8601 formatted date and time in UTC when the resource was created
121+
* The date and time in UTC when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
122122
*/
123123
dateCreated: Date;
124124
/**
125-
* The ISO 8601 formatted date and time in UTC when the resource was last updated
125+
* The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
126126
*/
127127
dateUpdated: Date;
128128
/**

lib/rest/accounts/v1/credential/aws.ts

+5-5
Original file line numberDiff line numberDiff line change
@@ -269,23 +269,23 @@ export class AwsInstance {
269269
}
270270

271271
/**
272-
* The unique string that identifies the resource
272+
* The unique string that we created to identify the AWS resource.
273273
*/
274274
sid: string;
275275
/**
276-
* The SID of the Account that created the resource
276+
* The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the AWS resource.
277277
*/
278278
accountSid: string;
279279
/**
280-
* The string that you assigned to describe the resource
280+
* The string that you assigned to describe the resource.
281281
*/
282282
friendlyName: string;
283283
/**
284-
* The RFC 2822 date and time in GMT when the resource was created
284+
* The date and time in GMT when the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
285285
*/
286286
dateCreated: Date;
287287
/**
288-
* The RFC 2822 date and time in GMT when the resource was last updated
288+
* The date and time in GMT when the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
289289
*/
290290
dateUpdated: Date;
291291
/**

lib/rest/accounts/v1/credential/publicKey.ts

+5-5
Original file line numberDiff line numberDiff line change
@@ -273,23 +273,23 @@ export class PublicKeyInstance {
273273
}
274274

275275
/**
276-
* The unique string that identifies the resource
276+
* The unique string that that we created to identify the PublicKey resource.
277277
*/
278278
sid: string;
279279
/**
280-
* The SID of the Account that created the Credential that the PublicKey resource belongs to
280+
* The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Credential that the PublicKey resource belongs to.
281281
*/
282282
accountSid: string;
283283
/**
284-
* The string that you assigned to describe the resource
284+
* The string that you assigned to describe the resource.
285285
*/
286286
friendlyName: string;
287287
/**
288-
* The RFC 2822 date and time in GMT when the resource was created
288+
* The date and time in GMT when the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
289289
*/
290290
dateCreated: Date;
291291
/**
292-
* The RFC 2822 date and time in GMT when the resource was last updated
292+
* The date and time in GMT when the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
293293
*/
294294
dateUpdated: Date;
295295
/**

lib/rest/accounts/v1/secondaryAuthToken.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -138,19 +138,19 @@ export class SecondaryAuthTokenInstance {
138138
}
139139

140140
/**
141-
* The SID of the Account that the secondary Auth Token was created for
141+
* The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that the secondary Auth Token was created for.
142142
*/
143143
accountSid: string;
144144
/**
145-
* The ISO 8601 formatted date and time in UTC when the resource was created
145+
* The date and time in UTC when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
146146
*/
147147
dateCreated: Date;
148148
/**
149-
* The ISO 8601 formatted date and time in UTC when the resource was last updated
149+
* The date and time in UTC when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
150150
*/
151151
dateUpdated: Date;
152152
/**
153-
* The generated secondary Auth Token
153+
* The generated secondary Auth Token that can be used to authenticate future API requests.
154154
*/
155155
secondaryAuthToken: string;
156156
/**

lib/rest/api/v2010/account.ts

+6-6
Original file line numberDiff line numberDiff line change
@@ -502,23 +502,23 @@ export class AccountInstance {
502502
}
503503

504504
/**
505-
* The authorization token for this account
505+
* The authorization token for this account. This token should be kept a secret, so no sharing.
506506
*/
507507
authToken: string;
508508
/**
509-
* The date this account was created
509+
* The date that this account was created, in GMT in RFC 2822 format
510510
*/
511511
dateCreated: Date;
512512
/**
513-
* The date this account was last updated
513+
* The date that this account was last updated, in GMT in RFC 2822 format.
514514
*/
515515
dateUpdated: Date;
516516
/**
517-
* A human readable description of this account
517+
* A human readable description of this account, up to 64 characters long. By default the FriendlyName is your email address.
518518
*/
519519
friendlyName: string;
520520
/**
521-
* The unique 34 character id representing the parent of this account
521+
* The unique 34 character id that represents the parent of this account. The OwnerAccountSid of a parent account is it\'s own sid.
522522
*/
523523
ownerAccountSid: string;
524524
/**
@@ -527,7 +527,7 @@ export class AccountInstance {
527527
sid: string;
528528
status: AccountStatus;
529529
/**
530-
* Account Instance Subresources
530+
* A Map of various subresources available for the given Account Instance
531531
*/
532532
subresourceUris: Record<string, string>;
533533
type: AccountType;

lib/rest/api/v2010/account/address.ts

+16-16
Original file line numberDiff line numberDiff line change
@@ -386,67 +386,67 @@ export class AddressInstance {
386386
}
387387

388388
/**
389-
* The SID of the Account that is responsible for the resource
389+
* The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that is responsible for the Address resource.
390390
*/
391391
accountSid: string;
392392
/**
393-
* The city in which the address is located
393+
* The city in which the address is located.
394394
*/
395395
city: string;
396396
/**
397-
* The name associated with the address
397+
* The name associated with the address.This property has a maximum length of 16 4-byte characters, or 21 3-byte characters.
398398
*/
399399
customerName: string;
400400
/**
401-
* The RFC 2822 date and time in GMT that the resource was created
401+
* The date and time in GMT that the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
402402
*/
403403
dateCreated: Date;
404404
/**
405-
* The RFC 2822 date and time in GMT that the resource was last updated
405+
* The date and time in GMT that the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
406406
*/
407407
dateUpdated: Date;
408408
/**
409-
* The string that you assigned to describe the resource
409+
* The string that you assigned to describe the resource.
410410
*/
411411
friendlyName: string;
412412
/**
413-
* The ISO country code of the address
413+
* The ISO country code of the address.
414414
*/
415415
isoCountry: string;
416416
/**
417-
* The postal code of the address
417+
* The postal code of the address.
418418
*/
419419
postalCode: string;
420420
/**
421-
* The state or region of the address
421+
* The state or region of the address.
422422
*/
423423
region: string;
424424
/**
425-
* The unique string that identifies the resource
425+
* The unique string that that we created to identify the Address resource.
426426
*/
427427
sid: string;
428428
/**
429-
* The number and street address of the address
429+
* The number and street address of the address.
430430
*/
431431
street: string;
432432
/**
433-
* The URI of the resource, relative to `https://api.twilio.com`
433+
* The URI of the resource, relative to `https://api.twilio.com`.
434434
*/
435435
uri: string;
436436
/**
437-
* Whether emergency calling has been enabled on this number
437+
* Whether emergency calling has been enabled on this number.
438438
*/
439439
emergencyEnabled: boolean;
440440
/**
441-
* Whether the address has been validated to comply with local regulation
441+
* Whether the address has been validated to comply with local regulation. In countries that require valid addresses, an invalid address will not be accepted. `true` indicates the Address has been validated. `false` indicate the country doesn\'t require validation or the Address is not valid.
442442
*/
443443
validated: boolean;
444444
/**
445-
* Whether the address has been verified to comply with regulation
445+
* Whether the address has been verified to comply with regulation. In countries that require valid addresses, an invalid address will not be accepted. `true` indicates the Address has been verified. `false` indicate the country doesn\'t require verified or the Address is not valid.
446446
*/
447447
verified: boolean;
448448
/**
449-
* The additional number and street address of the address
449+
* The additional number and street address of the address.
450450
*/
451451
streetSecondary: string;
452452

lib/rest/api/v2010/account/address/dependentPhoneNumber.ts

+24-24
Original file line numberDiff line numberDiff line change
@@ -371,101 +371,101 @@ export class DependentPhoneNumberInstance {
371371
}
372372

373373
/**
374-
* The unique string that identifies the resource
374+
* The unique string that that we created to identify the DependentPhoneNumber resource.
375375
*/
376376
sid: string;
377377
/**
378-
* The SID of the Account that created the resource
378+
* The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the DependentPhoneNumber resource.
379379
*/
380380
accountSid: string;
381381
/**
382-
* The string that you assigned to describe the resource
382+
* The string that you assigned to describe the resource.
383383
*/
384384
friendlyName: string;
385385
/**
386-
* The phone number in E.164 format
386+
* The phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number.
387387
*/
388388
phoneNumber: string;
389389
/**
390-
* The URL we call when the phone number receives a call
390+
* The URL we call when the phone number receives a call. The `voice_url` will not be used if a `voice_application_sid` or a `trunk_sid` is set.
391391
*/
392392
voiceUrl: string;
393393
/**
394-
* The HTTP method used with the voice_url
394+
* The HTTP method we use to call `voice_url`. Can be: `GET` or `POST`.
395395
*/
396396
voiceMethod: DependentPhoneNumberVoiceMethod;
397397
/**
398-
* The HTTP method used with voice_fallback_url
398+
* The HTTP method we use to call `voice_fallback_url`. Can be: `GET` or `POST`.
399399
*/
400400
voiceFallbackMethod: DependentPhoneNumberVoiceFallbackMethod;
401401
/**
402-
* The URL we call when an error occurs in TwiML
402+
* The URL that we call when an error occurs retrieving or executing the TwiML requested by `url`.
403403
*/
404404
voiceFallbackUrl: string;
405405
/**
406-
* Whether to lookup the caller\'s name
406+
* Whether we look up the caller\'s caller-ID name from the CNAM database. Can be: `true` or `false`. Caller ID lookups can cost $0.01 each.
407407
*/
408408
voiceCallerIdLookup: boolean;
409409
/**
410-
* The RFC 2822 date and time in GMT that the resource was created
410+
* The date and time in GMT that the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
411411
*/
412412
dateCreated: Date;
413413
/**
414-
* The RFC 2822 date and time in GMT that the resource was last updated
414+
* The date and time in GMT that the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
415415
*/
416416
dateUpdated: Date;
417417
/**
418-
* The HTTP method used with sms_fallback_url
418+
* The HTTP method we use to call `sms_fallback_url`. Can be: `GET` or `POST`.
419419
*/
420420
smsFallbackMethod: DependentPhoneNumberSmsFallbackMethod;
421421
/**
422-
* The URL that we call when an error occurs while retrieving or executing the TwiML
422+
* The URL that we call when an error occurs while retrieving or executing the TwiML from `sms_url`.
423423
*/
424424
smsFallbackUrl: string;
425425
/**
426-
* The HTTP method to use with sms_url
426+
* The HTTP method we use to call `sms_url`. Can be: `GET` or `POST`.
427427
*/
428428
smsMethod: DependentPhoneNumberSmsMethod;
429429
/**
430-
* The URL we call when the phone number receives an incoming SMS message
430+
* The URL we call when the phone number receives an incoming SMS message.
431431
*/
432432
smsUrl: string;
433433
addressRequirements: DependentPhoneNumberAddressRequirement;
434434
/**
435-
* Indicate if a phone can receive calls or messages
435+
* The set of Boolean properties that indicates whether a phone number can receive calls or messages. Capabilities are `Voice`, `SMS`, and `MMS` and each capability can be: `true` or `false`.
436436
*/
437437
capabilities: any;
438438
/**
439-
* The URL to send status information to your application
439+
* The URL we call using the `status_callback_method` to send status information to your application.
440440
*/
441441
statusCallback: string;
442442
/**
443-
* The HTTP method we use to call status_callback
443+
* The HTTP method we use to call `status_callback`. Can be: `GET` or `POST`.
444444
*/
445445
statusCallbackMethod: DependentPhoneNumberStatusCallbackMethod;
446446
/**
447-
* The API version used to start a new TwiML session
447+
* The API version used to start a new TwiML session.
448448
*/
449449
apiVersion: string;
450450
/**
451-
* The SID of the application that handles SMS messages sent to the phone number
451+
* The SID of the application that handles SMS messages sent to the phone number. If an `sms_application_sid` is present, we ignore all `sms_*_url` values and use those of the application.
452452
*/
453453
smsApplicationSid: string;
454454
/**
455-
* The SID of the application that handles calls to the phone number
455+
* The SID of the application that handles calls to the phone number. If a `voice_application_sid` is present, we ignore all of the voice urls and use those set on the application. Setting a `voice_application_sid` will automatically delete your `trunk_sid` and vice versa.
456456
*/
457457
voiceApplicationSid: string;
458458
/**
459-
* The SID of the Trunk that handles calls to the phone number
459+
* The SID of the Trunk that handles calls to the phone number. If a `trunk_sid` is present, we ignore all of the voice urls and voice applications and use those set on the Trunk. Setting a `trunk_sid` will automatically delete your `voice_application_sid` and vice versa.
460460
*/
461461
trunkSid: string;
462462
emergencyStatus: DependentPhoneNumberEmergencyStatus;
463463
/**
464-
* The emergency address configuration to use for emergency calling
464+
* The SID of the emergency address configuration that we use for emergency calling from the phone number.
465465
*/
466466
emergencyAddressSid: string;
467467
/**
468-
* The URI of the resource, relative to `https://api.twilio.com`
468+
* The URI of the resource, relative to `https://api.twilio.com`.
469469
*/
470470
uri: string;
471471

0 commit comments

Comments
 (0)