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: adding docs for enums and getting rid of 'description' column in model docs #48

Merged
merged 3 commits into from
Feb 26, 2021
Merged

docs: adding docs for enums and getting rid of 'description' column in model docs #48

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
9e8b0e3
regenerating from latest specs
Feb 25, 2021
1fc744e
Trigger build
Feb 26, 2021
286a805
cleanup
Feb 26, 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
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ test:

goimports:
go get golang.org/x/tools/cmd/goimports
goimports -w twilio/rest
goimports -w twilio
15 changes: 7 additions & 8 deletions twilio/rest/accounts/v1/docs/AccountsV1AuthTokenPromotion.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
# AccountsV1AuthTokenPromotion

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccountSid** | Pointer to **string** | | [optional]
**AuthToken** | Pointer to **string** | | [optional]
**DateCreated** | Pointer to [**time.Time**](time.Time.md) | | [optional]
**DateUpdated** | Pointer to [**time.Time**](time.Time.md) | | [optional]
**Url** | Pointer to **string** | | [optional]
Name | Type | Notes
------------ | ------------- | -------------
**AccountSid** | Pointer to **string** | [optional]
**AuthToken** | Pointer to **string** | [optional]
**DateCreated** | Pointer to [**time.Time**](time.Time.md) | [optional]
**DateUpdated** | Pointer to [**time.Time**](time.Time.md) | [optional]
**Url** | Pointer to **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
17 changes: 8 additions & 9 deletions twilio/rest/accounts/v1/docs/AccountsV1CredentialCredentialAws.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,14 @@
# AccountsV1CredentialCredentialAws

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccountSid** | Pointer to **string** | | [optional]
**DateCreated** | Pointer to [**time.Time**](time.Time.md) | | [optional]
**DateUpdated** | Pointer to [**time.Time**](time.Time.md) | | [optional]
**FriendlyName** | Pointer to **string** | | [optional]
**Sid** | Pointer to **string** | | [optional]
**Url** | Pointer to **string** | | [optional]
Name | Type | Notes
------------ | ------------- | -------------
**AccountSid** | Pointer to **string** | [optional]
**DateCreated** | Pointer to [**time.Time**](time.Time.md) | [optional]
**DateUpdated** | Pointer to [**time.Time**](time.Time.md) | [optional]
**FriendlyName** | Pointer to **string** | [optional]
**Sid** | Pointer to **string** | [optional]
**Url** | Pointer to **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
17 changes: 8 additions & 9 deletions twilio/rest/accounts/v1/docs/AccountsV1CredentialCredentialPublicKey.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,14 @@
# AccountsV1CredentialCredentialPublicKey

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccountSid** | Pointer to **string** | | [optional]
**DateCreated** | Pointer to [**time.Time**](time.Time.md) | | [optional]
**DateUpdated** | Pointer to [**time.Time**](time.Time.md) | | [optional]
**FriendlyName** | Pointer to **string** | | [optional]
**Sid** | Pointer to **string** | | [optional]
**Url** | Pointer to **string** | | [optional]
Name | Type | Notes
------------ | ------------- | -------------
**AccountSid** | Pointer to **string** | [optional]
**DateCreated** | Pointer to [**time.Time**](time.Time.md) | [optional]
**DateUpdated** | Pointer to [**time.Time**](time.Time.md) | [optional]
**FriendlyName** | Pointer to **string** | [optional]
**Sid** | Pointer to **string** | [optional]
**Url** | Pointer to **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
15 changes: 7 additions & 8 deletions twilio/rest/accounts/v1/docs/AccountsV1SecondaryAuthToken.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
# AccountsV1SecondaryAuthToken

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccountSid** | Pointer to **string** | | [optional]
**DateCreated** | Pointer to [**time.Time**](time.Time.md) | | [optional]
**DateUpdated** | Pointer to [**time.Time**](time.Time.md) | | [optional]
**SecondaryAuthToken** | Pointer to **string** | | [optional]
**Url** | Pointer to **string** | | [optional]
Name | Type | Notes
------------ | ------------- | -------------
**AccountSid** | Pointer to **string** | [optional]
**DateCreated** | Pointer to [**time.Time**](time.Time.md) | [optional]
**DateUpdated** | Pointer to [**time.Time**](time.Time.md) | [optional]
**SecondaryAuthToken** | Pointer to **string** | [optional]
**Url** | Pointer to **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
11 changes: 5 additions & 6 deletions twilio/rest/accounts/v1/docs/CreateCredentialAwsRequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
# CreateCredentialAwsRequest

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccountSid** | **string** | The SID of the Subaccount that this Credential should be associated with. Must be a valid Subaccount of the account issuing the request. | [optional]
**Credentials** | **string** | A string that contains the AWS access credentials in the format `<AWS_ACCESS_KEY_ID>:<AWS_SECRET_ACCESS_KEY>`. For example, `AKIAIOSFODNN7EXAMPLE:wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY` |
**FriendlyName** | **string** | A descriptive string that you create to describe the resource. It can be up to 64 characters long. | [optional]
Name | Type | Notes
------------ | ------------- | -------------
**AccountSid** | **string** | [optional]
**Credentials** | **string** |
**FriendlyName** | **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
11 changes: 5 additions & 6 deletions twilio/rest/accounts/v1/docs/CreateCredentialPublicKeyRequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
# CreateCredentialPublicKeyRequest

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccountSid** | **string** | The SID of the Subaccount that this Credential should be associated with. Must be a valid Subaccount of the account issuing the request | [optional]
**FriendlyName** | **string** | A descriptive string that you create to describe the resource. It can be up to 64 characters long. | [optional]
**PublicKey** | **string** | A URL encoded representation of the public key. For example, `-----BEGIN PUBLIC KEY-----MIIBIjANB.pa9xQIDAQAB-----END PUBLIC KEY-----` |
Name | Type | Notes
------------ | ------------- | -------------
**AccountSid** | **string** | [optional]
**FriendlyName** | **string** | [optional]
**PublicKey** | **string** |

[[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
46 changes: 22 additions & 24 deletions twilio/rest/accounts/v1/docs/DefaultApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,18 +34,18 @@ Create a new AWS Credential
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**optional** | ***CreateCredentialAwsOpts** | optional parameters | nil if no parameters
**optional** | ***CreateCredentialAwsRequest** | optional parameters | nil if no parameters

### Optional Parameters

Optional parameters are passed through a pointer to a CreateCredentialAwsOpts struct
Optional parameters are passed through a pointer to a CreateCredentialAwsRequest struct


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**AccountSid** | **optional.String**| The SID of the Subaccount that this Credential should be associated with. Must be a valid Subaccount of the account issuing the request. |
**Credentials** | **optional.String**| A string that contains the AWS access credentials in the format `<AWS_ACCESS_KEY_ID>:<AWS_SECRET_ACCESS_KEY>`. For example, `AKIAIOSFODNN7EXAMPLE:wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY` |
**FriendlyName** | **optional.String**| A descriptive string that you create to describe the resource. It can be up to 64 characters long. |
**AccountSid** | **String**| The SID of the Subaccount that this Credential should be associated with. Must be a valid Subaccount of the account issuing the request. |
**Credentials** | **String**| A string that contains the AWS access credentials in the format `<AWS_ACCESS_KEY_ID>:<AWS_SECRET_ACCESS_KEY>`. For example, `AKIAIOSFODNN7EXAMPLE:wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY` |
**FriendlyName** | **String**| A descriptive string that you create to describe the resource. It can be up to 64 characters long. |

### Return type

Expand Down Expand Up @@ -79,18 +79,18 @@ Create a new Public Key Credential
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**optional** | ***CreateCredentialPublicKeyOpts** | optional parameters | nil if no parameters
**optional** | ***CreateCredentialPublicKeyRequest** | optional parameters | nil if no parameters

### Optional Parameters

Optional parameters are passed through a pointer to a CreateCredentialPublicKeyOpts struct
Optional parameters are passed through a pointer to a CreateCredentialPublicKeyRequest struct


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**AccountSid** | **optional.String**| The SID of the Subaccount that this Credential should be associated with. Must be a valid Subaccount of the account issuing the request |
**FriendlyName** | **optional.String**| A descriptive string that you create to describe the resource. It can be up to 64 characters long. |
**PublicKey** | **optional.String**| A URL encoded representation of the public key. For example, `-----BEGIN PUBLIC KEY-----MIIBIjANB.pa9xQIDAQAB-----END PUBLIC KEY-----` |
**AccountSid** | **String**| The SID of the Subaccount that this Credential should be associated with. Must be a valid Subaccount of the account issuing the request |
**FriendlyName** | **String**| A descriptive string that you create to describe the resource. It can be up to 64 characters long. |
**PublicKey** | **String**| A URL encoded representation of the public key. For example, `-----BEGIN PUBLIC KEY-----MIIBIjANB.pa9xQIDAQAB-----END PUBLIC KEY-----` |

### Return type

Expand Down Expand Up @@ -320,16 +320,16 @@ Retrieves a collection of AWS Credentials belonging to the account used to make
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**optional** | ***ListCredentialAwsOpts** | optional parameters | nil if no parameters
**optional** | ***ListCredentialAwsRequest** | optional parameters | nil if no parameters

### Optional Parameters

Optional parameters are passed through a pointer to a ListCredentialAwsOpts struct
Optional parameters are passed through a pointer to a ListCredentialAwsRequest struct


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**PageSize** | **optional.Int32**| How many resources to return in each list page. The default is 50, and the maximum is 1000. |
**PageSize** | **Int32**| How many resources to return in each list page. The default is 50, and the maximum is 1000. |

### Return type

Expand Down Expand Up @@ -363,16 +363,16 @@ Retrieves a collection of Public Key Credentials belonging to the account used t
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**optional** | ***ListCredentialPublicKeyOpts** | optional parameters | nil if no parameters
**optional** | ***ListCredentialPublicKeyRequest** | optional parameters | nil if no parameters

### Optional Parameters

Optional parameters are passed through a pointer to a ListCredentialPublicKeyOpts struct
Optional parameters are passed through a pointer to a ListCredentialPublicKeyRequest struct


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**PageSize** | **optional.Int32**| How many resources to return in each list page. The default is 50, and the maximum is 1000. |
**PageSize** | **Int32**| How many resources to return in each list page. The default is 50, and the maximum is 1000. |

### Return type

Expand Down Expand Up @@ -437,17 +437,16 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**Sid** | **string**| The Twilio-provided string that uniquely identifies the AWS resource to update. |
**optional** | ***UpdateCredentialAwsOpts** | optional parameters | nil if no parameters
**optional** | ***UpdateCredentialAwsRequest** | optional parameters | nil if no parameters

### Optional Parameters

Optional parameters are passed through a pointer to a UpdateCredentialAwsOpts struct
Optional parameters are passed through a pointer to a UpdateCredentialAwsRequest struct


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------

**FriendlyName** | **optional.String**| A descriptive string that you create to describe the resource. It can be up to 64 characters long. |
**FriendlyName** | **String**| A descriptive string that you create to describe the resource. It can be up to 64 characters long. |

### Return type

Expand Down Expand Up @@ -482,17 +481,16 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**Sid** | **string**| The Twilio-provided string that uniquely identifies the PublicKey resource to update. |
**optional** | ***UpdateCredentialPublicKeyOpts** | optional parameters | nil if no parameters
**optional** | ***UpdateCredentialPublicKeyRequest** | optional parameters | nil if no parameters

### Optional Parameters

Optional parameters are passed through a pointer to a UpdateCredentialPublicKeyOpts struct
Optional parameters are passed through a pointer to a UpdateCredentialPublicKeyRequest struct


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------

**FriendlyName** | **optional.String**| A descriptive string that you create to describe the resource. It can be up to 64 characters long. |
**FriendlyName** | **String**| A descriptive string that you create to describe the resource. It can be up to 64 characters long. |

### Return type

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

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Credentials** | [**[]AccountsV1CredentialCredentialAws**](accounts.v1.credential.credential_aws.md) | | [optional]
**Meta** | [**ListCredentialAwsResponseMeta**](ListCredentialAwsResponse_meta.md) | | [optional]
Name | Type | 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
19 changes: 9 additions & 10 deletions twilio/rest/accounts/v1/docs/ListCredentialAwsResponseMeta.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,15 @@
# ListCredentialAwsResponseMeta

## Properties

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]
Name | Type | 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
9 changes: 4 additions & 5 deletions twilio/rest/accounts/v1/docs/ListCredentialPublicKeyResponse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
# ListCredentialPublicKeyResponse

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Credentials** | [**[]AccountsV1CredentialCredentialPublicKey**](accounts.v1.credential.credential_public_key.md) | | [optional]
**Meta** | [**ListCredentialAwsResponseMeta**](ListCredentialAwsResponse_meta.md) | | [optional]
Name | Type | 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
7 changes: 3 additions & 4 deletions twilio/rest/accounts/v1/docs/UpdateCredentialAwsRequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
# UpdateCredentialAwsRequest

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**FriendlyName** | **string** | A descriptive string that you create to describe the resource. It can be up to 64 characters long. | [optional]
Name | Type | Notes
------------ | ------------- | -------------
**FriendlyName** | **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
7 changes: 3 additions & 4 deletions twilio/rest/accounts/v1/docs/UpdateCredentialPublicKeyRequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
# UpdateCredentialPublicKeyRequest

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**FriendlyName** | **string** | A descriptive string that you create to describe the resource. It can be up to 64 characters long. | [optional]
Name | Type | Notes
------------ | ------------- | -------------
**FriendlyName** | **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
9 changes: 6 additions & 3 deletions twilio/rest/api/v2010/docs/AccountStatus.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
# AccountStatus

## Properties
## Enum
Name | Type | Notes
------------ | ------------- | -------------
**ACTIVE** | string | (value: `"active"`)
**SUSPENDED** | string | (value: `"suspended"`)
**CLOSED** | string | (value: `"closed"`)

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------

[[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: 5 additions & 3 deletions twilio/rest/api/v2010/docs/AccountType.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
# AccountType

## Properties
## Enum
Name | Type | Notes
------------ | ------------- | -------------
**TRIAL** | string | (value: `"Trial"`)
**FULL** | string | (value: `"Full"`)

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------

[[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
Loading