update some descriptions based on code review

Co-authored-by: Traci Porter <[email protected]>
bigcommerce · Sep 20, 2024 · f53e242 · f53e242
1 parent ac4bdb2
commit f53e242
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 15 deletions.
diff --git a/docs/b2b-edition/specs/api-v3/company/company.yaml b/docs/b2b-edition/specs/api-v3/company/company.yaml
@@ -450,8 +450,8 @@ paths:
       summary: Create a Company
       description: |-
         Create a company.
-        * When the `independent company behavior` is enabled, the system will not automatically create a dedicated customer group for each new Company account. Instead, you can assign a customer group to a Company account as needed, using the `customerGroupId` field. If the `customerGroupId` field is not provided, the B2B company will be associated with the default customer group you have configured. If no default customer group is configured, the B2B company will not be associated with any customer group, and the company users within the company will have their corresponding customer record assigned to No Group in BigCommerce.
-        * When the `independent company behavior` is disabled, a new customer group will be automatically created and associated with each new Company account. In this case, the `customerGroupId` field will not be used.
+        * When the `independent company behavior` is enabled, the system will not automatically create a dedicated customer group for each new Company account. Instead, you can assign a customer group to a Company account as needed using the `customerGroupId` field. If the `customerGroupId` field is not provided, the B2B company will be associated with your configured default customer group. If you have not configured a default customer group, the B2B company will not be associated with any customer group, and the company users within the company will have their corresponding customer record assigned to "No Group" in BigCommerce.
+        * When the `independent company behavior` is disabled, a new customer group will be automatically created and associated with each new Company account. In this case, you will not use the `customerGroupId` field.
       operationId: post-companies
       requestBody:
         content:
@@ -536,7 +536,7 @@ paths:
                       description: "BigCommerce channel ID, used for BigCommerce customer origin channel ID. This field takes effect only when you do not configure the store default B2B channel."
                     customerGroupId:
                       type: integer
-                      description: BigCommerce Customer Group ID. Used to associate a BigCommerce Customer Group to a B2B company when the  independent company behavior is enabled.
+                      description: BigCommerce Customer Group ID. Used to associate a BigCommerce Customer Group to a B2B company when the independent company behavior is enabled.
             examples:
               example-1:
                 value:
@@ -875,7 +875,7 @@ paths:
       description: |
         Update a company's attributes.
         * When the `independent company behavior` is enabled, you can assign a customer group to a Company using the `customerGroupId` field. Once assigned, the customer group will be associated with all users within that Company. If `customerGroupId` is set to 0, the customer group association will be removed from the Company, and all users within the Company will no longer have a group assigned. The `priceListAssign` field will not take effect; please configure the price list for the customer group directly in the BigCommerce Control Panel.
-        * When the `independent company behavior` is disabled, the `customerGroupId` field will not take effect. The association between B2B companies and BigCommerce customer groups cannot be changed. The `priceListAssign` field will be used to configure the price list assigned to the Company.
+        * When the `independent company behavior` is disabled, the `customerGroupId` field will not take effect. You cannot change the association between B2B companies and BigCommerce customer groups. You will use the `priceListAssign` field to configure the price list assigned to the Company.
       operationId: put-companies-companyId
       parameters:
         - name: companyId
@@ -1045,7 +1045,7 @@ paths:
       description: |-
         Delete A Company.
         * When the `independent company behavior` is disabled. Deleting a company will also delete the corresponding BigCommerce Customer Group.
-        * When the `independent company behavior` is enabled. Deleting a company will not affect the customer group associated with the company
+        * When the `independent company behavior` is enabled. Deleting a company will not affect the customer group associated with the company.
       operationId: delete-companies-companyId
       parameters:
         - name: companyId
@@ -1129,9 +1129,9 @@ paths:
         - Company
       summary: Convert from BigCommerce CustomerGroup into Company
       description: |-
-        Create company from bigCommerce customer group. 
-        * This API is disabled for MSF store
-        * This API is disabled when independent company feature enabled
+        Create company from a BigCommerce customer group. 
+        * This API is turned off for the MSF store.
+        * This API is turned off when the independent company feature is enabled.
       operationId: post-companies-conversion-customerGroups
       parameters:
         - name: customerGroupId
@@ -1598,8 +1598,8 @@ paths:
                       message: string
       description: |-
         Bulk create companies
-        * When the `independent company behavior` is enabled, the system will not automatically create a dedicated customer group for each new Company account. Instead, you can assign a customer group to a Company account as needed, using the `customerGroupId` field. If the `customerGroupId` field is not provided, the B2B company will be associated with the default customer group you have configured. If no default customer group is configured, the B2B company will not be associated with any customer group, and the company users within the company will have their corresponding customer record assigned to No Group in BigCommerce.
-        * When the `independent company behavior` is disabled, a new customer group will be automatically created and associated with each new Company account. In this case, the `customerGroupId` field will not be used.
+        * When the `independent company behavior` is enabled, the system will not automatically create a dedicated customer group for each new Company account. Instead, you can assign a customer group to a Company account as needed using the `customerGroupId` field. If the `customerGroupId` field is not provided, the B2B company will be associated with the configured default customer group. If you have not configured a default customer group, the B2B company will not be associated with any customer group, and the company users within the company will have their corresponding customer record assigned to "No Group" in BigCommerce.
+        * When the `independent company behavior` is turned off, a new customer group will be automatically created and associated with each new Company account. In this case, you will not use the `customerGroupId` field.
       security:
         - authToken: []
       requestBody:
@@ -1670,7 +1670,7 @@ paths:
       description: |
         Batch update companies.
         * When the `independent company behavior` is enabled, you can assign a customer group to a Company using the `customerGroupId` field. Once assigned, the customer group will be associated with all users within that Company. If `customerGroupId` is set to 0, the customer group association will be removed from the Company, and all users within the Company will no longer have a group assigned. The `priceListAssign` field will not take effect; please configure the price list for the customer group directly in the BigCommerce Control Panel.
-        * When the `independent company behavior` is disabled, the `customerGroupId` field will not take effect. The association between B2B companies and BigCommerce customer groups cannot be changed. The `priceListAssign` field will be used to configure the price list assigned to the Company.
+        * When the `independent company behavior` is turned off, the `customerGroupId` field will not take effect. You cannot change the association between B2B companies and BigCommerce customer groups. You will use the `priceListAssign` field to configure the price list assigned to the Company.
       operationId: put-companies
       requestBody:
         content:

diff --git a/docs/b2b-edition/specs/api-v3/user/user.yaml b/docs/b2b-edition/specs/api-v3/user/user.yaml
@@ -357,8 +357,8 @@ paths:
       summary: Create a User
       description: |-
         Create a company user within an existing company. 
-        * When the `independent company behavior` is enabled, B2B Edition company accounts are the source of truth for defining a company user’s customer group assignment. If no default customer group is configured or set value of `customerGroupId` to 0,  the B2B company will not be associated with any customer group, and the company users within the company will have their corresponding customer record assigned to No Group in BigCommerce
-        * When the `independent company behavior` is disabled, the BigCommerce customer record’s customer group assignment will be the source of truth for defining a company user’s company assignment.
+        * When the `independent company behavior` is enabled, B2B Edition company accounts are the source of truth for defining a company user’s customer group assignment. If you do not configure a default customer group or the value of `customerGroupId` is 0,  the B2B company will not be associated with any customer group, and the company users within the company will have their corresponding customer record assigned to "No Group" in BigCommerce.
+        * When the `independent company behavior` is turned off, the BigCommerce customer record’s customer group assignment will be the source of truth for defining a company user’s company assignment.
       operationId: companies_users_create
       requestBody:
         content:
@@ -510,8 +510,8 @@ paths:
       description: |-
         Create company users in batch. All of the user should be in same 
          company.
-         * When the `independent company behavior` is enabled, B2B Edition company accounts are the source of truth for defining a company user’s customer group assignment. If no default customer group is configured or set value of `customerGroupId` to 0,  the B2B company will not be associated with any customer group, and the company users within the company will have their corresponding customer record assigned to No Group in BigCommerce
-        * When the `independent company behavior` is disabled, the BigCommerce customer record’s customer group assignment will be the source of truth for defining a company user’s company assignment.
+         * When the `independent company behavior` is enabled, B2B Edition company accounts are the source of truth for defining a company user’s customer group assignment. If you do not configure a default customer group or the value of `customerGroupId` is 0,  the B2B company will not be associated with any customer group, and the company users within the company will have their corresponding customer record assigned to "No Group" in BigCommerce.
+        * When the `independent company behavior` is turned off, the BigCommerce customer record’s customer group assignment will be the source of truth for defining a company user’s company assignment.
       operationId: companies_users_bulk_create_create
       requestBody:
         content: