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.

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

add form_fields to Customer #156

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

millerjs
Copy link

Form fields exist on Customer but are missing from the customer resource object.

Schema definition:

  $ curl https://developer.bigcommerce.com/api-reference/store-management/customers-v2/BigCommerce_Customers_API.oas2.json \
   | jq '.definitions.Customer.properties.form_fields'
  {
    "description": "Array of custom fields. This is a READ-ONLY field; do not set or modify its value in a POST or PUT request.",
    "type": "array",
    "items": {
      "title": "Form Fields",
      "type": "object",
      "properties": {
        "name": {
          "description": "Name of the form field",
          "type": "string",
          "example": "License Id"
        },
        "value": {
          "description": "Value of the form field",
          "type": "string",
          "example": "123BAF"
        }
      }
    }
  }

Form fields exist on Customer but are missing from the customer resource object.

Schema definition:

  $ curl https://developer.bigcommerce.com/api-reference/store-management/customers-v2/BigCommerce_Customers_API.oas2.json | jq '.definitions.Customer.properties.form_fields'

  {
    "description": "Array of custom fields. This is a READ-ONLY field; do not set or modify its value in a POST or PUT request.",
    "type": "array",
    "items": {
      "title": "Form Fields",
      "type": "object",
      "properties": {
        "name": {
          "description": "Name of the form field",
          "type": "string",
          "example": "License Id"
        },
        "value": {
          "description": "Value of the form field",
          "type": "string",
          "example": "123BAF"
        }
      }
    }
  }
millerjs added a commit to watermelonexpress/bigcommerce-api-ruby that referenced this pull request Oct 10, 2023
- vendor open PR from bigcommerce#156
- replacing existing vendor of https://github.com/watermelonexpress/bigcommerce-api-ruby (renaming repo) to ensure the fork remote is bigcommerce's rather than a github user's.

Form fields exist on Customer but are missing from the customer resource object.

Schema definition:

  $ curl https://developer.bigcommerce.com/api-reference/store-management/customers-v2/BigCommerce_Customers_API.oas2.json | jq '.definitions.Customer.properties.form_fields'

  {
    "description": "Array of custom fields. This is a READ-ONLY field; do not set or modify its value in a POST or PUT request.",
    "type": "array",
    "items": {
      "title": "Form Fields",
      "type": "object",
      "properties": {
        "name": {
          "description": "Name of the form field",
          "type": "string",
          "example": "License Id"
        },
        "value": {
          "description": "Value of the form field",
          "type": "string",
          "example": "123BAF"
        }
      }
    }
  }
@millerjs
Copy link
Author

Hi all! Is this something worth considering including in main?

@nick-desteffen
Copy link

@bc-chaz @johnhebron looking to get this merged please

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants