Skip to content

Commit

Permalink
Adjust docs (#77)
Browse files Browse the repository at this point in the history
Signed-off-by: Tadayuki Onishi <tonishi@folio-sec.com>
Co-authored-by: Tadayuki Onishi <tonishi@folio-sec.com>
  • Loading branch information
kenchan0130 and Tadayuki Onishi authored Dec 23, 2024
1 parent ca9e6b1 commit dafc3a7
Show file tree
Hide file tree
Showing 48 changed files with 144 additions and 55 deletions.
5 changes: 3 additions & 2 deletions docs/data-sources/phone_auto_receptionist.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
# generated by https://github.com/hashicorp/terraform-plugin-docs with own template
page_title: "zoom_phone_auto_receptionist Data Source - zoom"
subcategory: ""
subcategory: "Phone"
description: |-
Auto receptionists answer calls with a personalized recording and routes calls to a phone user, call queue, common area, voicemail or an IVR system.
API Permissions
Expand All @@ -14,6 +14,7 @@ description: |-
Auto receptionists answer calls with a personalized recording and routes calls to a phone user, call queue, common area, voicemail or an IVR system.

## API Permissions

The following API permissions are required in order to use this resource.
This resource requires the `phone:read:auto_receptionist:admin`

Expand Down
5 changes: 3 additions & 2 deletions docs/data-sources/phone_blocked_list.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
# generated by https://github.com/hashicorp/terraform-plugin-docs with own template
page_title: "zoom_phone_blocked_list Data Source - zoom"
subcategory: ""
subcategory: "Phone"
description: |-
A Zoom account owner or a user with the admin privilege can block phone numbers for phone users in an account.
Blocked numbers can be inbound (numbers will be blocked from calling in) and outbound (phone users in your account won't be able to dial those numbers).
Expand All @@ -18,6 +18,7 @@ Blocked numbers can be inbound (numbers will be blocked from calling in) and out
Blocked callers will hear a generic message stating that the person they are calling is not available.

## API Permissions

The following API permissions are required in order to use this resource.
This resource requires the `phone:read:blocked_list:admin`.

Expand Down
5 changes: 3 additions & 2 deletions docs/data-sources/phone_call_queue.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
# generated by https://github.com/hashicorp/terraform-plugin-docs with own template
page_title: "zoom_phone_call_queue Data Source - zoom"
subcategory: ""
subcategory: "Phone"
description: |-
Call queues allow you to route incoming calls to a group of users. For instance, you can use call queues to route calls to various departments in your organization such as sales, engineering, billing, customer service etc.
API Permissions
Expand All @@ -14,6 +14,7 @@ description: |-
Call queues allow you to route incoming calls to a group of users. For instance, you can use call queues to route calls to various departments in your organization such as sales, engineering, billing, customer service etc.

## API Permissions

The following API permissions are required in order to use this resource.
This resource requires the `phone:read:call_queue:admin`.

Expand Down
5 changes: 3 additions & 2 deletions docs/data-sources/phone_phone_numbers.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
# generated by https://github.com/hashicorp/terraform-plugin-docs with own template
page_title: "zoom_phone_phone_numbers Data Source - zoom"
subcategory: ""
subcategory: "Phone"
description: |-
Zoom Phone numbers in a Zoom account.
API Permissions
Expand All @@ -14,6 +14,7 @@ description: |-
Zoom Phone numbers in a Zoom account.

## API Permissions

The following API permissions are required in order to use this resource.
This resource requires the `phone:read:list_numbers:admin`

Expand Down
5 changes: 3 additions & 2 deletions docs/data-sources/phone_shared_line_group.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
# generated by https://github.com/hashicorp/terraform-plugin-docs with own template
page_title: "zoom_phone_shared_line_group Data Source - zoom"
subcategory: ""
subcategory: "Phone"
description: |-
A shared line group https://support.zoom.us/hc/en-us/articles/360038850792 allows Zoom Phone admins to share a phone number and extension with a group of phone users or common areas. This gives members of the shared line group access to the group's direct phone number and voicemail.
API Permissions
Expand All @@ -14,6 +14,7 @@ description: |-
A [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) allows Zoom Phone admins to share a phone number and extension with a group of phone users or common areas. This gives members of the shared line group access to the group's direct phone number and voicemail.

## API Permissions

The following API permissions are required in order to use this resource.
This resource requires the `phone:read:shared_line_group:admin`.

Expand Down
5 changes: 3 additions & 2 deletions docs/data-sources/phone_users.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
# generated by https://github.com/hashicorp/terraform-plugin-docs with own template
page_title: "zoom_phone_users Data Source - zoom"
subcategory: ""
subcategory: "Phone"
description: |-
A list of all of an account's users who are assigned a Zoom Phone license.
API Permissions
Expand All @@ -14,6 +14,7 @@ description: |-
A list of all of an account's users who are assigned a Zoom Phone license.

## API Permissions

The following API permissions are required in order to use this resource.
This resource requires the `phone:read:list_users:admin`.

Expand Down
4 changes: 2 additions & 2 deletions docs/data-sources/user_users.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
# generated by https://github.com/hashicorp/terraform-plugin-docs with own template
page_title: "zoom_user_users Data Source - zoom"
subcategory: ""
subcategory: "User"
description: |-
Gets basic information for multiple Zoom users.
API Permissions
Expand Down
5 changes: 3 additions & 2 deletions docs/resources/phone_auto_receptionist.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
# generated by https://github.com/hashicorp/terraform-plugin-docs with own template
page_title: "zoom_phone_auto_receptionist Resource - zoom"
subcategory: ""
subcategory: "Phone"
description: |-
Auto receptionists answer calls with a personalized recording and routes calls to a phone user, call queue, common area, voicemail or an IVR system.
API Permissions
Expand All @@ -14,6 +14,7 @@ description: |-
Auto receptionists answer calls with a personalized recording and routes calls to a phone user, call queue, common area, voicemail or an IVR system.

## API Permissions

The following API permissions are required in order to use this resource.
This resource requires the `phone:read:auto_receptionist:admin`, `phone:write:auto_receptionist:admin`, `phone:update:auto_receptionist:admin`, `phone:delete:auto_receptionist:admin`.

Expand Down
9 changes: 5 additions & 4 deletions docs/resources/phone_auto_receptionist_ivr.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,20 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
# generated by https://github.com/hashicorp/terraform-plugin-docs with own template
page_title: "zoom_phone_auto_receptionist_ivr Resource - zoom"
subcategory: ""
subcategory: "Phone"
description: |-
[interactive voice response (IVR) system](https://support.zoom.// us/hc/en-us/articles/360038601971) of the specified auto receptionist.
interactive voice response (IVR) system https://support.zoom.us/hc/en-us/articles/360038601971 of the specified auto receptionist.
API Permissions
The following API permissions are required in order to use this resource.
This resource requires the phone:read:auto_receptionist_ivr:admin, phone:update:auto_receptionist_ivr:admin.
---

# zoom_phone_auto_receptionist_ivr (Resource)

[interactive voice response (IVR) system](https://support.zoom.// us/hc/en-us/articles/360038601971) of the specified auto receptionist.
[interactive voice response (IVR) system](https://support.zoom.us/hc/en-us/articles/360038601971) of the specified auto receptionist.

## API Permissions

The following API permissions are required in order to use this resource.
This resource requires the `phone:read:auto_receptionist_ivr:admin`, `phone:update:auto_receptionist_ivr:admin`.

Expand Down
5 changes: 3 additions & 2 deletions docs/resources/phone_blocked_list.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
# generated by https://github.com/hashicorp/terraform-plugin-docs with own template
page_title: "zoom_phone_blocked_list Resource - zoom"
subcategory: ""
subcategory: "Phone"
description: |-
A Zoom account owner or a user with the admin privilege can block phone numbers for phone users in an account.
Blocked numbers can be inbound (numbers will be blocked from calling in) and outbound (phone users in your account won't be able to dial those numbers).
Expand All @@ -18,6 +18,7 @@ Blocked numbers can be inbound (numbers will be blocked from calling in) and out
Blocked callers will hear a generic message stating that the person they are calling is not available.

## API Permissions

The following API permissions are required in order to use this resource.
This resource requires the `phone:read:blocked_list:admin`, `phone:write:blocked_list:admin`, `phone:delete:blocked_list:admin`.

Expand Down
5 changes: 3 additions & 2 deletions docs/resources/phone_call_handling_business_hours.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
# generated by https://github.com/hashicorp/terraform-plugin-docs with own template
page_title: "zoom_phone_call_handling_business_hours Resource - zoom"
subcategory: ""
subcategory: "Phone"
description: |-
Call handling settings allow you to control how your system routes calls during business hours.
For more information, read our Call Handling API guide https://developers.zoom.us/docs/zoom-phone/call-handling/ or Zoom support article Customizing call handling settings https://support.zoom.us/hc/en-us/articles/360059966372-Customizing-call-handling-settings.
Expand All @@ -16,6 +16,7 @@ Call handling settings allow you to control how your system routes calls during
For more information, read our [Call Handling API guide](https://developers.zoom.us/docs/zoom-phone/call-handling/) or Zoom support article [Customizing call handling settings](https://support.zoom.us/hc/en-us/articles/360059966372-Customizing-call-handling-settings).

## API Permissions

The following API permissions are required in order to use this resource.
This resource requires the `phone:read:call_handling_setting:admin`, `phone:write:call_handling_setting:admin`, `phone:update:call_handling_setting:admin`, `phone:delete:call_handling_setting:admin`.

Expand Down
5 changes: 3 additions & 2 deletions docs/resources/phone_call_handling_closed_hours.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
# generated by https://github.com/hashicorp/terraform-plugin-docs with own template
page_title: "zoom_phone_call_handling_closed_hours Resource - zoom"
subcategory: ""
subcategory: "Phone"
description: |-
Call handling settings allow you to control how your system routes calls during closed hours.
For more information, read our Call Handling API guide https://developers.zoom.us/docs/zoom-phone/call-handling/ or Zoom support article Customizing call handling settings https://support.zoom.us/hc/en-us/articles/360059966372-Customizing-call-handling-settings.
Expand All @@ -21,6 +21,7 @@ For more information, read our [Call Handling API guide](https://developers.zoom
This resource is depends on `zoom_phone_call_handling_business_hours`. Please set business hours type = 2 (Custom hours).

## API Permissions

The following API permissions are required in order to use this resource.
This resource requires the `phone:read:call_handling_setting:admin`, `phone:write:call_handling_setting:admin`, `phone:update:call_handling_setting:admin`, `phone:delete:call_handling_setting:admin`.

Expand Down
5 changes: 3 additions & 2 deletions docs/resources/phone_call_handling_holiday_hours.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
# generated by https://github.com/hashicorp/terraform-plugin-docs with own template
page_title: "zoom_phone_call_handling_holiday_hours Resource - zoom"
subcategory: ""
subcategory: "Phone"
description: |-
Call handling settings allow you to control how your system routes calls during holiday hours.
For more information, read our Call Handling API guide https://developers.zoom.us/docs/zoom-phone/call-handling/ or Zoom support article Customizing call handling settings https://support.zoom.us/hc/en-us/articles/360059966372-Customizing-call-handling-settings.
Expand All @@ -16,6 +16,7 @@ Call handling settings allow you to control how your system routes calls during
For more information, read our [Call Handling API guide](https://developers.zoom.us/docs/zoom-phone/call-handling/) or Zoom support article [Customizing call handling settings](https://support.zoom.us/hc/en-us/articles/360059966372-Customizing-call-handling-settings).

## API Permissions

The following API permissions are required in order to use this resource.
This resource requires the `phone:read:call_handling_setting:admin`, `phone:write:call_handling_setting:admin`, `phone:update:call_handling_setting:admin`, `phone:delete:call_handling_setting:admin`.

Expand Down
5 changes: 3 additions & 2 deletions docs/resources/phone_call_queue.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
# generated by https://github.com/hashicorp/terraform-plugin-docs with own template
page_title: "zoom_phone_call_queue Resource - zoom"
subcategory: ""
subcategory: "Phone"
description: |-
Call queues allow you to route incoming calls to a group of users. For instance, you can use call queues to route calls to various departments in your organization such as sales, engineering, billing, customer service etc.
API Permissions
Expand All @@ -14,6 +14,7 @@ description: |-
Call queues allow you to route incoming calls to a group of users. For instance, you can use call queues to route calls to various departments in your organization such as sales, engineering, billing, customer service etc.

## API Permissions

The following API permissions are required in order to use this resource.
This resource requires the `phone:read:call_queue:admin`, `phone:write:call_queue:admin`, `phone:update:call_queue:admin`, `phone:delete:call_queue:admin`.

Expand Down
5 changes: 3 additions & 2 deletions docs/resources/phone_call_queue_members.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
# generated by https://github.com/hashicorp/terraform-plugin-docs with own template
page_title: "zoom_phone_call_queue_members Resource - zoom"
subcategory: ""
subcategory: "Phone"
description: |-
Call queues allow you to route incoming calls to a group of users. For instance, you can use call queue members to route calls to various departments in your organization such as sales, engineering, billing, customer service etc.
API Permissions
Expand All @@ -14,6 +14,7 @@ description: |-
Call queues allow you to route incoming calls to a group of users. For instance, you can use call queue members to route calls to various departments in your organization such as sales, engineering, billing, customer service etc.

## API Permissions

The following API permissions are required in order to use this resource.
This resource requires the `phone:read:list_users:admin`, `phone:read:list_call_queue_members:admin`, `phone:write:call_queue_member:admin`, `phone:delete:call_queue_member:admin`.

Expand Down
5 changes: 3 additions & 2 deletions docs/resources/phone_call_queue_phone_numbers.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
# generated by https://github.com/hashicorp/terraform-plugin-docs with own template
page_title: "zoom_phone_call_queue_phone_numbers Resource - zoom"
subcategory: ""
subcategory: "Phone"
description: |-
After buying phone number(s) https://support.zoom.us/hc/en-us/articles/360020808292#h_007ec8c2-0914-4265-8351-96ab23efa3ad, you can assign it, allowing callers to directly dial a number to reach a call queue https://support.zoom.us/hc/en-us/articles/360021524831-Managing-Call-Queues.
API Permissions
Expand All @@ -14,6 +14,7 @@ description: |-
After [buying phone number(s)](https://support.zoom.us/hc/en-us/articles/360020808292#h_007ec8c2-0914-4265-8351-96ab23efa3ad), you can assign it, allowing callers to directly dial a number to reach a [call queue](https://support.zoom.us/hc/en-us/articles/360021524831-Managing-Call-Queues).

## API Permissions

The following API permissions are required in order to use this resource.
This resource requires the `phone:read:call_queue:admin`, `phone:read:list_call_queues:admin`, `phone:read:list_numbers:admin`, `phone:write:call_queue_number:admin`, `phone:delete:call_queue_number:admin`.

Expand Down
7 changes: 4 additions & 3 deletions docs/resources/phone_call_queue_policy_voice_mail.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
# generated by https://github.com/hashicorp/terraform-plugin-docs with own template
page_title: "zoom_phone_call_queue_policy_voice_mail Resource - zoom"
subcategory: ""
subcategory: "Phone"
description: |-
The policy sub-setting for a specific call queue according to the voice_mail.
API Permissions
Expand All @@ -14,6 +14,7 @@ description: |-
The policy sub-setting for a specific call queue according to the voice_mail.

## API Permissions

The following API permissions are required in order to use this resource.
This resource requires the `phone:read:call_queue:admin`, `phone:write:call_queue_policy:admin`, `phone:update:call_queue_policy:admin`, `phone:delete:call_queue_policy:admin`.

Expand Down Expand Up @@ -59,7 +60,7 @@ Required:

Read-Only:

- `shared_id` (String) The number is limited to the minimum value of 10 or the number of allowed access members account setting.
- `shared_id` (String) The shared ID of the voicemail access member.

## Import

Expand Down
5 changes: 3 additions & 2 deletions docs/resources/phone_external_contact.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
# generated by https://github.com/hashicorp/terraform-plugin-docs with own template
page_title: "zoom_phone_external_contact Resource - zoom"
subcategory: ""
subcategory: "Phone"
description: |-
External contact's information.
API Permissions
Expand All @@ -14,6 +14,7 @@ description: |-
External contact's information.

## API Permissions

The following API permissions are required in order to use this resource.
This resource requires the `phone:read:external_contact:admin`, `phone:write:external_contact:admin`, `phone:update:external_contact:admin`, `phone:delete:external_contact:admin`.

Expand Down
5 changes: 3 additions & 2 deletions docs/resources/phone_shared_line_group.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
# generated by https://github.com/hashicorp/terraform-plugin-docs with own template
page_title: "zoom_phone_shared_line_group Resource - zoom"
subcategory: ""
subcategory: "Phone"
description: |-
A shared line group https://support.zoom.us/hc/en-us/articles/360038850792 allows Zoom Phone admins to share a phone number and extension with a group of phone users or common areas. This gives members of the shared line group access to the group's direct phone number and voicemail.
API Permissions
Expand All @@ -14,6 +14,7 @@ description: |-
A [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) allows Zoom Phone admins to share a phone number and extension with a group of phone users or common areas. This gives members of the shared line group access to the group's direct phone number and voicemail.

## API Permissions

The following API permissions are required in order to use this resource.
This resource requires the `phone:read:shared_line_group:admin`, `phone:write:shared_line_group:admin`, `phone:update:shared_line_group:admin`, `phone:delete:shared_line_group:admin`.

Expand Down
5 changes: 3 additions & 2 deletions docs/resources/phone_shared_line_group_members.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
# generated by https://github.com/hashicorp/terraform-plugin-docs with own template
page_title: "zoom_phone_shared_line_group_members Resource - zoom"
subcategory: ""
subcategory: "Phone"
description: |-
A shared line group https://support.zoom.us/hc/en-us/articles/360038850792 allows Zoom Phone admins to share a phone number and extension with a group of phone users or common areas. This gives members of the shared line group access to the group's direct phone number and voicemail. Note that a member can only be added to one shared line group.
API Permissions
Expand All @@ -14,6 +14,7 @@ description: |-
A [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) allows Zoom Phone admins to share a phone number and extension with a group of phone users or common areas. This gives members of the shared line group access to the group's direct phone number and voicemail. Note that a member can only be added to one shared line group.

## API Permissions

The following API permissions are required in order to use this resource.
This resource requires the `phone:read:list_users:admin`, `phone:read:list_shared_line_group_members:admin`, `phone:write:shared_line_group_member:admin`, `phone:delete:shared_line_group_member:admin`.

Expand Down
Loading

0 comments on commit dafc3a7

Please sign in to comment.