Skip to content

Commit

Permalink
feat: updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@demeyerthom
demeyerthom committed Aug 16, 2024
1 parent f787489 commit 59f5ce8
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 26 deletions.
16 changes: 8 additions & 8 deletions docs/resources/business_unit_company.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@
page_title: "commercetools_business_unit_company Resource - terraform-provider-commercetools"
subcategory: ""
description: |-
Business Unit type to represent the top level of a business. Contains specific fields and values that differentiate a Company from the generic BusinessUnit.
Business Unit type to represent the top level of a business. Contains specific fields and values that differentiate a company from the generic business unit.
See also the [Business Unit API Documentation](https://docs.commercetools.com/api/projects/business-units
---

# commercetools_business_unit_company (Resource)

Business Unit type to represent the top level of a business. Contains specific fields and values that differentiate a Company from the generic BusinessUnit.
Business Unit type to represent the top level of a business. Contains specific fields and values that differentiate a company from the generic business unit.

See also the [Business Unit API Documentation](https://docs.commercetools.com/api/projects/business-units

Expand Down Expand Up @@ -68,18 +68,18 @@ resource "commercetools_business_unit_company" "my-company" {

### Required

- `key` (String) User-defined unique identifier for the Company.
- `name` (String) The name of the Company.
- `key` (String) User-defined unique key for the company. Must be unique within the project. Updating this value is not supported.
- `name` (String) The name of the company.

### Optional

- `address` (Block List) Addresses used by the Business Unit. (see [below for nested schema](#nestedblock--address))
- `billing_address_keys` (Set of String) Indexes of entries in addresses to set as billing addresses. The billingAddressIds of the [Customer](https://docs.commercetools.com/api/projects/customers) will be replaced by these addresses.
- `contact_email` (String) The email address of the Company.
- `contact_email` (String) The email address of the company.
- `default_billing_address_key` (String) Index of the entry in addresses to set as the default billing address.
- `default_shipping_address_key` (String) Index of the entry in addresses to set as the default shipping address.
- `shipping_address_keys` (Set of String) Indexes of entries in addresses to set as shipping addresses. The shippingAddressIds of the [Customer](https://docs.commercetools.com/api/projects/customers) will be replaced by these addresses.
- `status` (String) The status of the Company.
- `status` (String) The status of the company.
- `store` (Block List) Sets the Stores the Business Unit is associated with.

If the Business Unit has Stores defined, then all of its Carts, Orders, Quotes, or Quote Requests must belong to one of the Business Unit's Stores.
Expand All @@ -88,8 +88,8 @@ If the Business Unit has no Stores, then all of its Carts, Orders, Quotes, or Qu

### Read-Only

- `id` (String) Unique identifier of the Company.
- `version` (Number) The current version of the Company.
- `id` (String) Unique identifier of the company.
- `version` (Number) The current version of the company.

<a id="nestedblock--address"></a>
### Nested Schema for `address`
Expand Down
36 changes: 18 additions & 18 deletions docs/resources/business_unit_division.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@
page_title: "commercetools_business_unit_division Resource - terraform-provider-commercetools"
subcategory: ""
description: |-
Business Unit type to represent the top level of a business. Contains specific fields and values that differentiate a Division from the generic BusinessUnit.
See also the [Business Unit API Documentation](https://docs.commercetools.com/api/projects/business-units
business unit type to represent the top level of a business. Contains specific fields and values that differentiate a Division from the generic BusinessUnit.
See also the [business unit API Documentation](https://docs.commercetools.com/api/projects/business-units
---

# commercetools_business_unit_division (Resource)

Business Unit type to represent the top level of a business. Contains specific fields and values that differentiate a Division from the generic BusinessUnit.
business unit type to represent the top level of a business. Contains specific fields and values that differentiate a Division from the generic BusinessUnit.

See also the [Business Unit API Documentation](https://docs.commercetools.com/api/projects/business-units
See also the [business unit API Documentation](https://docs.commercetools.com/api/projects/business-units

## Example Usage

Expand Down Expand Up @@ -80,32 +80,32 @@ resource "commercetools_business_unit_division" "my-division" {

### Required

- `key` (String) User-defined unique identifier for the Division.
- `name` (String) The name of the Division.
- `key` (String) User-defined unique key for the division. Must be unique within the project. Updating this value is not supported.
- `name` (String) The name of the division.

### Optional

- `address` (Block List) Addresses used by the Business Unit. (see [below for nested schema](#nestedblock--address))
- `approval_rule_mode` (String) Determines whether the Business Unit can inherit Approval Rules from a parent. Defaults to `ExplicitAndFromParent`.
- `associate_mode` (String) Determines whether the Business Unit can inherit Associates from a parent. Defaults to `ExplicitAndFromParent`.
- `billing_address_keys` (List of String) List of the billing addresses used by the Division.
- `contact_email` (String) The email address of the Division.
- `approval_rule_mode` (String) Determines whether the business unit can inherit Approval Rules from a parent. Defaults to `ExplicitAndFromParent`.
- `associate_mode` (String) Determines whether the business unit can inherit Associates from a parent. Defaults to `ExplicitAndFromParent`.
- `billing_address_keys` (List of String) List of the billing addresses used by the division.
- `contact_email` (String) The email address of the division.
- `default_billing_address_key` (String) Key of the default billing Address.
- `default_shipping_address_key` (String) Key of the default shipping Address.
- `parent_unit` (Block, Optional) Reference to a parent Business Unit by its key. (see [below for nested schema](#nestedblock--parent_unit))
- `shipping_address_keys` (List of String) List of the shipping addresses used by the Division.
- `status` (String) Indicates whether the Business Unit can be edited and used in [Orders](https://docs.commercetools.com/api/projects/orders). Defaults to `Active`.
- `parent_unit` (Block, Optional) Reference to a parent business unit by its key or id. One of either is required. (see [below for nested schema](#nestedblock--parent_unit))
- `shipping_address_keys` (List of String) List of the shipping addresses used by the division.
- `status` (String) Indicates whether the business unit can be edited and used in [Orders](https://docs.commercetools.com/api/projects/orders). Defaults to `Active`.
- `store` (Block List) Sets the Stores the Business Unit is associated with.

If the Business Unit has Stores defined, then all of its Carts, Orders, Quotes, or Quote Requests must belong to one of the Business Unit's Stores.

If the Business Unit has no Stores, then all of its Carts, Orders, Quotes, or Quote Requests must not belong to any Store. (see [below for nested schema](#nestedblock--store))
- `store_mode` (String) Defines whether the Stores of the Business Unit are set directly on the Business Unit or are inherited from a parent. Defaults to `FromParent`
- `store_mode` (String) Defines whether the Stores of the business unit are set directly on the business unit or are inherited from a parent. Defaults to `FromParent`

### Read-Only

- `id` (String) Unique identifier of the Division.
- `version` (Number) The current version of the Division.
- `id` (String) Unique identifier of the division.
- `version` (Number) The current version of the division.

<a id="nestedblock--address"></a>
### Nested Schema for `address`
Expand Down Expand Up @@ -150,8 +150,8 @@ Read-Only:

Optional:

- `id` (String) User-defined unique identifier of the Business Unit
- `key` (String) User-defined unique key of the Business Unit
- `id` (String) User-defined unique identifier of the business unit
- `key` (String) User-defined unique key of the business unit


<a id="nestedblock--store"></a>
Expand Down

0 comments on commit 59f5ce8

Please sign in to comment.