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.

Sign up for GitHub

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: add property descriptions to docs #54

Merged
merged 3 commits into from
Mar 12, 2021
Merged

docs: add property descriptions to docs #54

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
81a0cc8
docs: add property descriptions to docs
JenniferMah Mar 11, 2021
c2c8470
regenerate with imports from oai-generator
JenniferMah Mar 12, 2021
757a601
reformat
JenniferMah Mar 12, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
14 changes: 7 additions & 7 deletions twilio/rest/accounts/v1/docs/AccountsV1AuthTokenPromotion.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# AccountsV1AuthTokenPromotion

## Properties
Name | Type | Notes
------------ | ------------- | -------------
**AccountSid** | Pointer to **string** |
**AuthToken** | Pointer to **string** |
**DateCreated** | Pointer to [**time.Time**](time.Time.md) |
**DateUpdated** | Pointer to [**time.Time**](time.Time.md) |
**Url** | Pointer to **string** |
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccountSid** | Pointer to **string** | The SID of the Account that the secondary Auth Token was created for |
**AuthToken** | Pointer to **string** | The promoted Auth Token |
**DateCreated** | Pointer to [**time.Time**](time.Time.md) | The ISO 8601 formatted date and time in UTC when the resource was created |
**DateUpdated** | Pointer to [**time.Time**](time.Time.md) | The ISO 8601 formatted date and time in UTC when the resource was last updated |
**Url** | Pointer to **string** | The URI for this resource, relative to `https://accounts.twilio.com` |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
16 changes: 8 additions & 8 deletions twilio/rest/accounts/v1/docs/AccountsV1CredentialCredentialAws.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# AccountsV1CredentialCredentialAws

## Properties
Name | Type | Notes
------------ | ------------- | -------------
**AccountSid** | Pointer to **string** |
**DateCreated** | Pointer to [**time.Time**](time.Time.md) |
**DateUpdated** | Pointer to [**time.Time**](time.Time.md) |
**FriendlyName** | Pointer to **string** |
**Sid** | Pointer to **string** |
**Url** | Pointer to **string** |
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccountSid** | Pointer to **string** | The SID of the Account that created the resource |
**DateCreated** | Pointer to [**time.Time**](time.Time.md) | The RFC 2822 date and time in GMT when the resource was created |
**DateUpdated** | Pointer to [**time.Time**](time.Time.md) | The RFC 2822 date and time in GMT when the resource was last updated |
**FriendlyName** | Pointer to **string** | The string that you assigned to describe the resource |
**Sid** | Pointer to **string** | The unique string that identifies the resource |
**Url** | Pointer to **string** | The URI for this resource, relative to `https://accounts.twilio.com` |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
16 changes: 8 additions & 8 deletions twilio/rest/accounts/v1/docs/AccountsV1CredentialCredentialPublicKey.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# AccountsV1CredentialCredentialPublicKey

## Properties
Name | Type | Notes
------------ | ------------- | -------------
**AccountSid** | Pointer to **string** |
**DateCreated** | Pointer to [**time.Time**](time.Time.md) |
**DateUpdated** | Pointer to [**time.Time**](time.Time.md) |
**FriendlyName** | Pointer to **string** |
**Sid** | Pointer to **string** |
**Url** | Pointer to **string** |
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccountSid** | Pointer to **string** | The SID of the Account that created the Credential that the PublicKey resource belongs to |
**DateCreated** | Pointer to [**time.Time**](time.Time.md) | The RFC 2822 date and time in GMT when the resource was created |
**DateUpdated** | Pointer to [**time.Time**](time.Time.md) | The RFC 2822 date and time in GMT when the resource was last updated |
**FriendlyName** | Pointer to **string** | The string that you assigned to describe the resource |
**Sid** | Pointer to **string** | The unique string that identifies the resource |
**Url** | Pointer to **string** | The URI for this resource, relative to `https://accounts.twilio.com` |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
14 changes: 7 additions & 7 deletions twilio/rest/accounts/v1/docs/AccountsV1SecondaryAuthToken.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# AccountsV1SecondaryAuthToken

## Properties
Name | Type | Notes
------------ | ------------- | -------------
**AccountSid** | Pointer to **string** |
**DateCreated** | Pointer to [**time.Time**](time.Time.md) |
**DateUpdated** | Pointer to [**time.Time**](time.Time.md) |
**SecondaryAuthToken** | Pointer to **string** |
**Url** | Pointer to **string** |
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccountSid** | Pointer to **string** | The SID of the Account that the secondary Auth Token was created for |
**DateCreated** | Pointer to [**time.Time**](time.Time.md) | The ISO 8601 formatted date and time in UTC when the resource was created |
**DateUpdated** | Pointer to [**time.Time**](time.Time.md) | The ISO 8601 formatted date and time in UTC when the resource was last updated |
**SecondaryAuthToken** | Pointer to **string** | The generated secondary Auth Token |
**Url** | Pointer to **string** | The URI for this resource, relative to `https://accounts.twilio.com` |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
8 changes: 4 additions & 4 deletions twilio/rest/accounts/v1/docs/ListCredentialAwsResponse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# ListCredentialAwsResponse

## Properties
Name | Type | Notes
------------ | ------------- | -------------
**Credentials** | [**[]AccountsV1CredentialCredentialAws**](accounts.v1.credential.credential_aws.md) | [optional]
**Meta** | [**ListCredentialAwsResponseMeta**](ListCredentialAwsResponse_meta.md) | [optional]
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Credentials** | [**[]AccountsV1CredentialCredentialAws**](accounts.v1.credential.credential_aws.md) | |[optional]
**Meta** | [**ListCredentialAwsResponseMeta**](ListCredentialAwsResponse_meta.md) | |[optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
18 changes: 9 additions & 9 deletions twilio/rest/accounts/v1/docs/ListCredentialAwsResponseMeta.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# ListCredentialAwsResponseMeta

## Properties
Name | Type | Notes
------------ | ------------- | -------------
**FirstPageUrl** | **string** | [optional]
**Key** | **string** | [optional]
**NextPageUrl** | **string** | [optional]
**Page** | **int32** | [optional]
**PageSize** | **int32** | [optional]
**PreviousPageUrl** | **string** | [optional]
**Url** | **string** | [optional]
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**FirstPageUrl** | **string** | |[optional]
**Key** | **string** | |[optional]
**NextPageUrl** | **string** | |[optional]
**Page** | **int32** | |[optional]
**PageSize** | **int32** | |[optional]
**PreviousPageUrl** | **string** | |[optional]
**Url** | **string** | |[optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
8 changes: 4 additions & 4 deletions twilio/rest/accounts/v1/docs/ListCredentialPublicKeyResponse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# ListCredentialPublicKeyResponse

## Properties
Name | Type | Notes
------------ | ------------- | -------------
**Credentials** | [**[]AccountsV1CredentialCredentialPublicKey**](accounts.v1.credential.credential_public_key.md) | [optional]
**Meta** | [**ListCredentialAwsResponseMeta**](ListCredentialAwsResponse_meta.md) | [optional]
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Credentials** | [**[]AccountsV1CredentialCredentialPublicKey**](accounts.v1.credential.credential_public_key.md) | |[optional]
**Meta** | [**ListCredentialAwsResponseMeta**](ListCredentialAwsResponse_meta.md) | |[optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
11 changes: 8 additions & 3 deletions twilio/rest/accounts/v1/model_accounts_v1_auth_token_promotion.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

18 changes: 12 additions & 6 deletions twilio/rest/accounts/v1/model_accounts_v1_credential_credential_aws.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

18 changes: 12 additions & 6 deletions twilio/rest/accounts/v1/model_accounts_v1_credential_credential_public_key.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

15 changes: 10 additions & 5 deletions twilio/rest/accounts/v1/model_accounts_v1_secondary_auth_token.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

51 changes: 4 additions & 47 deletions twilio/rest/api/v2010/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,15 +227,14 @@ Class | Method | HTTP request | Description

## Documentation For Models

- [AccountStatus](docs/AccountStatus.md)
- [AccountType](docs/AccountType.md)
- [ApiV2010Account](docs/ApiV2010Account.md)
- [ApiV2010AccountAddress](docs/ApiV2010AccountAddress.md)
- [ApiV2010AccountAddressDependentPhoneNumber](docs/ApiV2010AccountAddressDependentPhoneNumber.md)
- [ApiV2010AccountApplication](docs/ApiV2010AccountApplication.md)
- [ApiV2010AccountAuthorizedConnectApp](docs/ApiV2010AccountAuthorizedConnectApp.md)
- [ApiV2010AccountAvailablePhoneNumberCountry](docs/ApiV2010AccountAvailablePhoneNumberCountry.md)
- [ApiV2010AccountAvailablePhoneNumberCountryAvailablePhoneNumberLocal](docs/ApiV2010AccountAvailablePhoneNumberCountryAvailablePhoneNumberLocal.md)
- [ApiV2010AccountAvailablePhoneNumberCountryAvailablePhoneNumberLocalCapabilities](docs/ApiV2010AccountAvailablePhoneNumberCountryAvailablePhoneNumberLocalCapabilities.md)
- [ApiV2010AccountAvailablePhoneNumberCountryAvailablePhoneNumberMachineToMachine](docs/ApiV2010AccountAvailablePhoneNumberCountryAvailablePhoneNumberMachineToMachine.md)
- [ApiV2010AccountAvailablePhoneNumberCountryAvailablePhoneNumberMobile](docs/ApiV2010AccountAvailablePhoneNumberCountryAvailablePhoneNumberMobile.md)
- [ApiV2010AccountAvailablePhoneNumberCountryAvailablePhoneNumberNational](docs/ApiV2010AccountAvailablePhoneNumberCountryAvailablePhoneNumberNational.md)
Expand All @@ -247,6 +246,7 @@ Class | Method | HTTP request | Description
- [ApiV2010AccountCallCallEvent](docs/ApiV2010AccountCallCallEvent.md)
- [ApiV2010AccountCallCallFeedback](docs/ApiV2010AccountCallCallFeedback.md)
- [ApiV2010AccountCallCallFeedbackSummary](docs/ApiV2010AccountCallCallFeedbackSummary.md)
- [ApiV2010AccountCallCallFeedbackSummaryIssues](docs/ApiV2010AccountCallCallFeedbackSummaryIssues.md)
- [ApiV2010AccountCallCallNotification](docs/ApiV2010AccountCallCallNotification.md)
- [ApiV2010AccountCallCallNotificationInstance](docs/ApiV2010AccountCallCallNotificationInstance.md)
- [ApiV2010AccountCallCallRecording](docs/ApiV2010AccountCallCallRecording.md)
Expand All @@ -256,6 +256,7 @@ Class | Method | HTTP request | Description
- [ApiV2010AccountConferenceParticipant](docs/ApiV2010AccountConferenceParticipant.md)
- [ApiV2010AccountConnectApp](docs/ApiV2010AccountConnectApp.md)
- [ApiV2010AccountIncomingPhoneNumber](docs/ApiV2010AccountIncomingPhoneNumber.md)
- [ApiV2010AccountIncomingPhoneNumberCapabilities](docs/ApiV2010AccountIncomingPhoneNumberCapabilities.md)
- [ApiV2010AccountIncomingPhoneNumberIncomingPhoneNumberAssignedAddOn](docs/ApiV2010AccountIncomingPhoneNumberIncomingPhoneNumberAssignedAddOn.md)
- [ApiV2010AccountIncomingPhoneNumberIncomingPhoneNumberAssignedAddOnIncomingPhoneNumberAssignedAddOnExtension](docs/ApiV2010AccountIncomingPhoneNumberIncomingPhoneNumberAssignedAddOnIncomingPhoneNumberAssignedAddOnExtension.md)
- [ApiV2010AccountIncomingPhoneNumberIncomingPhoneNumberLocal](docs/ApiV2010AccountIncomingPhoneNumberIncomingPhoneNumberLocal.md)
Expand Down Expand Up @@ -289,6 +290,7 @@ Class | Method | HTTP request | Description
- [ApiV2010AccountSipSipIpAccessControlList](docs/ApiV2010AccountSipSipIpAccessControlList.md)
- [ApiV2010AccountSipSipIpAccessControlListSipIpAddress](docs/ApiV2010AccountSipSipIpAccessControlListSipIpAddress.md)
- [ApiV2010AccountToken](docs/ApiV2010AccountToken.md)
- [ApiV2010AccountTokenIceServers](docs/ApiV2010AccountTokenIceServers.md)
- [ApiV2010AccountTranscription](docs/ApiV2010AccountTranscription.md)
- [ApiV2010AccountUsageUsageRecord](docs/ApiV2010AccountUsageUsageRecord.md)
- [ApiV2010AccountUsageUsageRecordUsageRecordAllTime](docs/ApiV2010AccountUsageUsageRecordUsageRecordAllTime.md)
Expand All @@ -301,29 +303,6 @@ Class | Method | HTTP request | Description
- [ApiV2010AccountUsageUsageRecordUsageRecordYesterday](docs/ApiV2010AccountUsageUsageRecordUsageRecordYesterday.md)
- [ApiV2010AccountUsageUsageTrigger](docs/ApiV2010AccountUsageUsageTrigger.md)
- [ApiV2010AccountValidationRequest](docs/ApiV2010AccountValidationRequest.md)
- [CallFeedbackSummaryStatus](docs/CallFeedbackSummaryStatus.md)
- [CallRecordingSource](docs/CallRecordingSource.md)
- [CallRecordingStatus](docs/CallRecordingStatus.md)
- [CallStatus](docs/CallStatus.md)
- [ConferenceReasonConferenceEnded](docs/ConferenceReasonConferenceEnded.md)
- [ConferenceRecordingSource](docs/ConferenceRecordingSource.md)
- [ConferenceRecordingStatus](docs/ConferenceRecordingStatus.md)
- [ConferenceStatus](docs/ConferenceStatus.md)
- [DependentPhoneNumberAddressRequirement](docs/DependentPhoneNumberAddressRequirement.md)
- [DependentPhoneNumberEmergencyStatus](docs/DependentPhoneNumberEmergencyStatus.md)
- [HttpMethod](docs/HttpMethod.md)
- [IncomingPhoneNumberAddressRequirement](docs/IncomingPhoneNumberAddressRequirement.md)
- [IncomingPhoneNumberEmergencyStatus](docs/IncomingPhoneNumberEmergencyStatus.md)
- [IncomingPhoneNumberLocalAddressRequirement](docs/IncomingPhoneNumberLocalAddressRequirement.md)
- [IncomingPhoneNumberLocalEmergencyStatus](docs/IncomingPhoneNumberLocalEmergencyStatus.md)
- [IncomingPhoneNumberLocalVoiceReceiveMode](docs/IncomingPhoneNumberLocalVoiceReceiveMode.md)
- [IncomingPhoneNumberMobileAddressRequirement](docs/IncomingPhoneNumberMobileAddressRequirement.md)
- [IncomingPhoneNumberMobileEmergencyStatus](docs/IncomingPhoneNumberMobileEmergencyStatus.md)
- [IncomingPhoneNumberMobileVoiceReceiveMode](docs/IncomingPhoneNumberMobileVoiceReceiveMode.md)
- [IncomingPhoneNumberTollFreeAddressRequirement](docs/IncomingPhoneNumberTollFreeAddressRequirement.md)
- [IncomingPhoneNumberTollFreeEmergencyStatus](docs/IncomingPhoneNumberTollFreeEmergencyStatus.md)
- [IncomingPhoneNumberTollFreeVoiceReceiveMode](docs/IncomingPhoneNumberTollFreeVoiceReceiveMode.md)
- [IncomingPhoneNumberVoiceReceiveMode](docs/IncomingPhoneNumberVoiceReceiveMode.md)
- [ListAccountResponse](docs/ListAccountResponse.md)
- [ListAddressResponse](docs/ListAddressResponse.md)
- [ListApplicationResponse](docs/ListApplicationResponse.md)
Expand Down Expand Up @@ -385,28 +364,6 @@ Class | Method | HTTP request | Description
- [ListUsageRecordYearlyResponse](docs/ListUsageRecordYearlyResponse.md)
- [ListUsageRecordYesterdayResponse](docs/ListUsageRecordYesterdayResponse.md)
- [ListUsageTriggerResponse](docs/ListUsageTriggerResponse.md)
- [MessageDirection](docs/MessageDirection.md)
- [MessageFeedbackOutcome](docs/MessageFeedbackOutcome.md)
- [MessageStatus](docs/MessageStatus.md)
- [ParticipantStatus](docs/ParticipantStatus.md)
- [PhoneNumberCapabilities](docs/PhoneNumberCapabilities.md)
- [RecordingAddOnResultStatus](docs/RecordingAddOnResultStatus.md)
- [RecordingSource](docs/RecordingSource.md)
- [RecordingStatus](docs/RecordingStatus.md)
- [RecordingTranscriptionStatus](docs/RecordingTranscriptionStatus.md)
- [TranscriptionStatus](docs/TranscriptionStatus.md)
- [UsageRecordAllTimeCategory](docs/UsageRecordAllTimeCategory.md)
- [UsageRecordCategory](docs/UsageRecordCategory.md)
- [UsageRecordDailyCategory](docs/UsageRecordDailyCategory.md)
- [UsageRecordLastMonthCategory](docs/UsageRecordLastMonthCategory.md)
- [UsageRecordMonthlyCategory](docs/UsageRecordMonthlyCategory.md)
- [UsageRecordThisMonthCategory](docs/UsageRecordThisMonthCategory.md)
- [UsageRecordTodayCategory](docs/UsageRecordTodayCategory.md)
- [UsageRecordYearlyCategory](docs/UsageRecordYearlyCategory.md)
- [UsageRecordYesterdayCategory](docs/UsageRecordYesterdayCategory.md)
- [UsageTriggerRecurring](docs/UsageTriggerRecurring.md)
- [UsageTriggerTriggerField](docs/UsageTriggerTriggerField.md)
- [UsageTriggerUsageCategory](docs/UsageTriggerUsageCategory.md)


## Documentation For Authorization
Expand Down
Loading