Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: use long property descriptions if available #899

Merged
merged 1 commit into from Jan 24, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
8 changes: 4 additions & 4 deletions lib/rest/accounts/v1/authTokenPromotion.ts
Expand Up @@ -110,19 +110,19 @@ export class AuthTokenPromotionInstance {
}

/**
* The SID of the Account that the secondary Auth Token was created for
* The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that the secondary Auth Token was created for.
*/
accountSid: string;
/**
* The promoted Auth Token
* The promoted Auth Token that must be used to authenticate future API requests.
*/
authToken: string;
/**
* The ISO 8601 formatted date and time in UTC when the resource was created
* The date and time in UTC when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
*/
dateCreated: Date;
/**
* The ISO 8601 formatted date and time in UTC when the resource was last updated
* The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
*/
dateUpdated: Date;
/**
Expand Down
10 changes: 5 additions & 5 deletions lib/rest/accounts/v1/credential/aws.ts
Expand Up @@ -269,23 +269,23 @@ export class AwsInstance {
}

/**
* The unique string that identifies the resource
* The unique string that we created to identify the AWS resource.
*/
sid: string;
/**
* The SID of the Account that created the resource
* The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the AWS resource.
*/
accountSid: string;
/**
* The string that you assigned to describe the resource
* The string that you assigned to describe the resource.
*/
friendlyName: string;
/**
* The RFC 2822 date and time in GMT when the resource was created
* The date and time in GMT when the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
*/
dateCreated: Date;
/**
* The RFC 2822 date and time in GMT when the resource was last updated
* The date and time in GMT when the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
*/
dateUpdated: Date;
/**
Expand Down
10 changes: 5 additions & 5 deletions lib/rest/accounts/v1/credential/publicKey.ts
Expand Up @@ -273,23 +273,23 @@ export class PublicKeyInstance {
}

/**
* The unique string that identifies the resource
* The unique string that that we created to identify the PublicKey resource.
*/
sid: string;
/**
* The SID of the Account that created the Credential that the PublicKey resource belongs to
* The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Credential that the PublicKey resource belongs to.
*/
accountSid: string;
/**
* The string that you assigned to describe the resource
* The string that you assigned to describe the resource.
*/
friendlyName: string;
/**
* The RFC 2822 date and time in GMT when the resource was created
* The date and time in GMT when the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
*/
dateCreated: Date;
/**
* The RFC 2822 date and time in GMT when the resource was last updated
* The date and time in GMT when the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
*/
dateUpdated: Date;
/**
Expand Down
8 changes: 4 additions & 4 deletions lib/rest/accounts/v1/secondaryAuthToken.ts
Expand Up @@ -138,19 +138,19 @@ export class SecondaryAuthTokenInstance {
}

/**
* The SID of the Account that the secondary Auth Token was created for
* The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that the secondary Auth Token was created for.
*/
accountSid: string;
/**
* The ISO 8601 formatted date and time in UTC when the resource was created
* The date and time in UTC when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
*/
dateCreated: Date;
/**
* The ISO 8601 formatted date and time in UTC when the resource was last updated
* The date and time in UTC when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
*/
dateUpdated: Date;
/**
* The generated secondary Auth Token
* The generated secondary Auth Token that can be used to authenticate future API requests.
*/
secondaryAuthToken: string;
/**
Expand Down
12 changes: 6 additions & 6 deletions lib/rest/api/v2010/account.ts
Expand Up @@ -502,23 +502,23 @@ export class AccountInstance {
}

/**
* The authorization token for this account
* The authorization token for this account. This token should be kept a secret, so no sharing.
*/
authToken: string;
/**
* The date this account was created
* The date that this account was created, in GMT in RFC 2822 format
*/
dateCreated: Date;
/**
* The date this account was last updated
* The date that this account was last updated, in GMT in RFC 2822 format.
*/
dateUpdated: Date;
/**
* A human readable description of this account
* A human readable description of this account, up to 64 characters long. By default the FriendlyName is your email address.
*/
friendlyName: string;
/**
* The unique 34 character id representing the parent of this account
* The unique 34 character id that represents the parent of this account. The OwnerAccountSid of a parent account is it\'s own sid.
*/
ownerAccountSid: string;
/**
Expand All @@ -527,7 +527,7 @@ export class AccountInstance {
sid: string;
status: AccountStatus;
/**
* Account Instance Subresources
* A Map of various subresources available for the given Account Instance
*/
subresourceUris: Record<string, string>;
type: AccountType;
Expand Down
32 changes: 16 additions & 16 deletions lib/rest/api/v2010/account/address.ts
Expand Up @@ -386,67 +386,67 @@ export class AddressInstance {
}

/**
* The SID of the Account that is responsible for the resource
* The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that is responsible for the Address resource.
*/
accountSid: string;
/**
* The city in which the address is located
* The city in which the address is located.
*/
city: string;
/**
* The name associated with the address
* The name associated with the address.This property has a maximum length of 16 4-byte characters, or 21 3-byte characters.
*/
customerName: string;
/**
* The RFC 2822 date and time in GMT that the resource was created
* The date and time in GMT that the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
*/
dateCreated: Date;
/**
* The RFC 2822 date and time in GMT that the resource was last updated
* The date and time in GMT that the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
*/
dateUpdated: Date;
/**
* The string that you assigned to describe the resource
* The string that you assigned to describe the resource.
*/
friendlyName: string;
/**
* The ISO country code of the address
* The ISO country code of the address.
*/
isoCountry: string;
/**
* The postal code of the address
* The postal code of the address.
*/
postalCode: string;
/**
* The state or region of the address
* The state or region of the address.
*/
region: string;
/**
* The unique string that identifies the resource
* The unique string that that we created to identify the Address resource.
*/
sid: string;
/**
* The number and street address of the address
* The number and street address of the address.
*/
street: string;
/**
* The URI of the resource, relative to `https://api.twilio.com`
* The URI of the resource, relative to `https://api.twilio.com`.
*/
uri: string;
/**
* Whether emergency calling has been enabled on this number
* Whether emergency calling has been enabled on this number.
*/
emergencyEnabled: boolean;
/**
* Whether the address has been validated to comply with local regulation
* 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.
*/
validated: boolean;
/**
* Whether the address has been verified to comply with regulation
* 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.
*/
verified: boolean;
/**
* The additional number and street address of the address
* The additional number and street address of the address.
*/
streetSecondary: string;

Expand Down
48 changes: 24 additions & 24 deletions lib/rest/api/v2010/account/address/dependentPhoneNumber.ts
Expand Up @@ -371,101 +371,101 @@ export class DependentPhoneNumberInstance {
}

/**
* The unique string that identifies the resource
* The unique string that that we created to identify the DependentPhoneNumber resource.
*/
sid: string;
/**
* The SID of the Account that created the resource
* The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the DependentPhoneNumber resource.
*/
accountSid: string;
/**
* The string that you assigned to describe the resource
* The string that you assigned to describe the resource.
*/
friendlyName: string;
/**
* The phone number in E.164 format
* 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.
*/
phoneNumber: string;
/**
* The URL we call when the phone number receives a call
* 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.
*/
voiceUrl: string;
/**
* The HTTP method used with the voice_url
* The HTTP method we use to call `voice_url`. Can be: `GET` or `POST`.
*/
voiceMethod: DependentPhoneNumberVoiceMethod;
/**
* The HTTP method used with voice_fallback_url
* The HTTP method we use to call `voice_fallback_url`. Can be: `GET` or `POST`.
*/
voiceFallbackMethod: DependentPhoneNumberVoiceFallbackMethod;
/**
* The URL we call when an error occurs in TwiML
* The URL that we call when an error occurs retrieving or executing the TwiML requested by `url`.
*/
voiceFallbackUrl: string;
/**
* Whether to lookup the caller\'s name
* 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.
*/
voiceCallerIdLookup: boolean;
/**
* The RFC 2822 date and time in GMT that the resource was created
* The date and time in GMT that the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
*/
dateCreated: Date;
/**
* The RFC 2822 date and time in GMT that the resource was last updated
* The date and time in GMT that the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
*/
dateUpdated: Date;
/**
* The HTTP method used with sms_fallback_url
* The HTTP method we use to call `sms_fallback_url`. Can be: `GET` or `POST`.
*/
smsFallbackMethod: DependentPhoneNumberSmsFallbackMethod;
/**
* The URL that we call when an error occurs while retrieving or executing the TwiML
* The URL that we call when an error occurs while retrieving or executing the TwiML from `sms_url`.
*/
smsFallbackUrl: string;
/**
* The HTTP method to use with sms_url
* The HTTP method we use to call `sms_url`. Can be: `GET` or `POST`.
*/
smsMethod: DependentPhoneNumberSmsMethod;
/**
* The URL we call when the phone number receives an incoming SMS message
* The URL we call when the phone number receives an incoming SMS message.
*/
smsUrl: string;
addressRequirements: DependentPhoneNumberAddressRequirement;
/**
* Indicate if a phone can receive calls or messages
* 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`.
*/
capabilities: any;
/**
* The URL to send status information to your application
* The URL we call using the `status_callback_method` to send status information to your application.
*/
statusCallback: string;
/**
* The HTTP method we use to call status_callback
* The HTTP method we use to call `status_callback`. Can be: `GET` or `POST`.
*/
statusCallbackMethod: DependentPhoneNumberStatusCallbackMethod;
/**
* The API version used to start a new TwiML session
* The API version used to start a new TwiML session.
*/
apiVersion: string;
/**
* The SID of the application that handles SMS messages sent to the phone number
* 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.
*/
smsApplicationSid: string;
/**
* The SID of the application that handles calls to the phone number
* 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.
*/
voiceApplicationSid: string;
/**
* The SID of the Trunk that handles calls to the phone number
* 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.
*/
trunkSid: string;
emergencyStatus: DependentPhoneNumberEmergencyStatus;
/**
* The emergency address configuration to use for emergency calling
* The SID of the emergency address configuration that we use for emergency calling from the phone number.
*/
emergencyAddressSid: string;
/**
* The URI of the resource, relative to `https://api.twilio.com`
* The URI of the resource, relative to `https://api.twilio.com`.
*/
uri: string;

Expand Down