From d96820e4fc91015aa53234f3f36a49c708fbb585 Mon Sep 17 00:00:00 2001 From: Ryan Liu Date: Tue, 10 Oct 2023 11:27:03 -0700 Subject: [PATCH] docs: mark new properties endpoints as preview (#1712) --- .../api/v2/metadata/create-property.api.mdx | 7 +- .../docs/api/v2/metadata/get-property.api.mdx | 15 ++-- .../list-properties-deprecated.api.mdx | 46 ------------ .../metadata/list-properties-preview.api.mdx | 53 ++++++++++++++ .../api/v2/metadata/list-properties.api.mdx | 16 ++--- .../api/v2/metadata/register-property.api.mdx | 13 ++-- docs/docs/api/v2/metadata/sidebar.js | 2 +- .../api/v2/metadata/update-property.api.mdx | 12 ++-- openapi/v2/metadata/openapi.bundle.json | 22 +++--- openapi/v2/metadata/paths/properties.yaml | 4 +- .../paths/properties@{object_name}.yaml | 11 ++- .../properties@{object_name}@register.yaml | 5 +- ...perties@{object_name}@{property_name}.yaml | 10 ++- packages/schemas/gen/v2/metadata.ts | 72 +++++++++++++------ packages/schemas/v2/metadata.ts | 4 +- 15 files changed, 176 insertions(+), 116 deletions(-) delete mode 100644 docs/docs/api/v2/metadata/list-properties-deprecated.api.mdx create mode 100644 docs/docs/api/v2/metadata/list-properties-preview.api.mdx diff --git a/docs/docs/api/v2/metadata/create-property.api.mdx b/docs/docs/api/v2/metadata/create-property.api.mdx index 6b47e1aa7..292617140 100644 --- a/docs/docs/api/v2/metadata/create-property.api.mdx +++ b/docs/docs/api/v2/metadata/create-property.api.mdx @@ -1,11 +1,11 @@ --- id: create-property title: "Create property" -description: "Creates a custom property in the provider and registers it in Supaglue." +description: ":::note" sidebar_label: "Create property" hide_title: true hide_table_of_contents: true -api: {"operationId":"createProperty","description":"Creates a custom property in the provider and registers it in Supaglue.\n","tags":["Properties"],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The unique identifier to be used to refer to this property across all customers. Supaglue will use this to appropriately map to the provider field ID.\n","example":"ticketId"},"label":{"type":"string","description":"The human-readable name of the property as provided by the third-party Provider.","example":"First Name"},"description":{"type":"string","description":"A description of the field."},"is_required":{"type":"boolean","description":"Defaults to false.","example":false},"group_name":{"type":"string","example":"supaglue","description":"Only applicable for Hubspot. If specified, Supaglue will attempt to attach the field to this group if it exists, or create it if it doesn't."},"type":{"type":"string","enum":["text","textarea","number","picklist","multipicklist","date","datetime","boolean"],"description":"Type of the field.\nSupport:\n\n| Field | Hubspot (type-fieldType) | Salesforce | Pipedrive |\n| ------------------ | ------------------------ | -------------- | ------------- |\n| text | string-text | Text | varchar_auto |\n| textarea | string-textarea | Longtextarea | text |\n| number | number-number | Number | double |\n| picklist | enumeration-select | Picklist | enum |\n| multipicklist | enumeration-checkbox | Multipicklist | set |\n| date | date-date | Date | date |\n| datetime | datetime-date | Datetime | date |\n| boolean | boolean-booleancheckbox | Checkbox | enum |\n","title":"property_type"},"precision":{"type":"number","description":"Only applicable in Salesforce. If not given, will default to 18."},"scale":{"type":"number","description":"Only applicable in Salesforce. If not given, will default to 0."},"options":{"type":"array","description":"The list of options for a picklist/multipicklist field.","items":{"type":"object","properties":{"label":{"type":"string","example":"Option 1"},"value":{"type":"string","example":"option_1"},"description":{"type":"string","description":"A description of this option."},"hidden":{"type":"boolean","description":"Defaults to false."}},"required":["label","value"],"title":"picklist_option"}}},"required":["name","label","type"],"title":"create_property"}}}},"responses":{"200":{"description":"Create a property","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The machine name of the property as it appears in the third-party Provider.","example":"FirstName"},"custom_name":{"type":"string","description":"Only applicable for custom properties. This represents the unique identifier that can be used to refer to this property across all customers."},"label":{"type":"string","description":"The human-readable name of the property as provided by the third-party Provider.","example":"First Name"},"description":{"type":"string","description":"A description of the field."},"is_required":{"type":"boolean","example":false},"group_name":{"type":"string","example":"supaglue","description":"Only applicable for Hubspot. If specified, Supaglue will attempt to attach the field to this group if it exists, or create it if it doesn't."},"type":{"type":"string","enum":["text","textarea","number","picklist","multipicklist","date","datetime","boolean"],"description":"Type of the field.\nSupport:\n\n| Field | Hubspot (type-fieldType) | Salesforce | Pipedrive |\n| ------------------ | ------------------------ | -------------- | ------------- |\n| text | string-text | Text | varchar_auto |\n| textarea | string-textarea | Longtextarea | text |\n| number | number-number | Number | double |\n| picklist | enumeration-select | Picklist | enum |\n| multipicklist | enumeration-checkbox | Multipicklist | set |\n| date | date-date | Date | date |\n| datetime | datetime-date | Datetime | date |\n| boolean | boolean-booleancheckbox | Checkbox | enum |\n","title":"property_type"},"precision":{"type":"number","description":"Only applicable in Salesforce. If not given, will default to 18."},"scale":{"type":"number","description":"Only applicable in Salesforce. If not given, will default to 0."},"options":{"type":"array","description":"The list of options for a picklist/multipicklist field.","items":{"type":"object","properties":{"label":{"type":"string","example":"Option 1"},"value":{"type":"string","example":"option_1"},"description":{"type":"string","description":"A description of this option."},"hidden":{"type":"boolean","description":"Defaults to false."}},"required":["label","value"],"title":"picklist_option"}},"raw_details":{"type":"object","description":"The raw details of the property as provided by the third-party Provider, if available.","additionalProperties":true,"example":{}}},"required":["id","label","type"],"title":"property_unified"}}}}},"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"object_name","in":"path","required":true,"schema":{"type":"string","description":"The name of the object.","example":"contact"}}],"method":"post","path":"/properties/{object_name}","servers":[{"url":"https://api.supaglue.io/metadata/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"name":"ticketId","label":"First Name","description":"string","is_required":false,"group_name":"supaglue","type":"text","precision":0,"scale":0,"options":[{"label":"Option 1","value":"option_1","description":"string","hidden":true}]},"info":{"version":"0.13.1","title":"Metadata API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Metadata API documentation for CRM. You can use this API to operate on metadata across multiple third-party providers.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/metadata/v2\n```\n"},"postman":{"name":"Create property","description":{"content":"Creates a custom property in the provider and registers it in Supaglue.\n","type":"text/plain"},"url":{"path":["properties",":object_name"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"object_name"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"createProperty","description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\nCreates a custom property in the provider and registers it in Supaglue.\n","tags":["Properties"],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The unique identifier to be used to refer to this property across all customers. Supaglue will use this to appropriately map to the provider field ID.\n","example":"ticketId"},"label":{"type":"string","description":"The human-readable name of the property as provided by the third-party Provider.","example":"First Name"},"description":{"type":"string","description":"A description of the field."},"is_required":{"type":"boolean","description":"Defaults to false.","example":false},"group_name":{"type":"string","example":"supaglue","description":"Only applicable for Hubspot. If specified, Supaglue will attempt to attach the field to this group if it exists, or create it if it doesn't."},"type":{"type":"string","enum":["text","textarea","number","picklist","multipicklist","date","datetime","boolean"],"description":"Type of the field.\nSupport:\n\n| Field | Hubspot (type-fieldType) | Salesforce | Pipedrive |\n| ------------------ | ------------------------ | -------------- | ------------- |\n| text | string-text | Text | varchar_auto |\n| textarea | string-textarea | Longtextarea | text |\n| number | number-number | Number | double |\n| picklist | enumeration-select | Picklist | enum |\n| multipicklist | enumeration-checkbox | Multipicklist | set |\n| date | date-date | Date | date |\n| datetime | datetime-date | Datetime | date |\n| boolean | boolean-booleancheckbox | Checkbox | enum |\n","title":"property_type"},"precision":{"type":"number","description":"Only applicable in Salesforce. If not given, will default to 18."},"scale":{"type":"number","description":"Only applicable in Salesforce. If not given, will default to 0."},"options":{"type":"array","description":"The list of options for a picklist/multipicklist field.","items":{"type":"object","properties":{"label":{"type":"string","example":"Option 1"},"value":{"type":"string","example":"option_1"},"description":{"type":"string","description":"A description of this option."},"hidden":{"type":"boolean","description":"Defaults to false."}},"required":["label","value"],"title":"picklist_option"}}},"required":["name","label","type"],"title":"create_property"}}}},"responses":{"200":{"description":"Create a property","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The machine name of the property as it appears in the third-party Provider.","example":"FirstName"},"custom_name":{"type":"string","description":"Only applicable for custom properties. This represents the unique identifier that can be used to refer to this property across all customers."},"label":{"type":"string","description":"The human-readable name of the property as provided by the third-party Provider.","example":"First Name"},"description":{"type":"string","description":"A description of the field."},"is_required":{"type":"boolean","example":false},"group_name":{"type":"string","example":"supaglue","description":"Only applicable for Hubspot. If specified, Supaglue will attempt to attach the field to this group if it exists, or create it if it doesn't."},"type":{"type":"string","enum":["text","textarea","number","picklist","multipicklist","date","datetime","boolean"],"description":"Type of the field.\nSupport:\n\n| Field | Hubspot (type-fieldType) | Salesforce | Pipedrive |\n| ------------------ | ------------------------ | -------------- | ------------- |\n| text | string-text | Text | varchar_auto |\n| textarea | string-textarea | Longtextarea | text |\n| number | number-number | Number | double |\n| picklist | enumeration-select | Picklist | enum |\n| multipicklist | enumeration-checkbox | Multipicklist | set |\n| date | date-date | Date | date |\n| datetime | datetime-date | Datetime | date |\n| boolean | boolean-booleancheckbox | Checkbox | enum |\n","title":"property_type"},"precision":{"type":"number","description":"Only applicable in Salesforce. If not given, will default to 18."},"scale":{"type":"number","description":"Only applicable in Salesforce. If not given, will default to 0."},"options":{"type":"array","description":"The list of options for a picklist/multipicklist field.","items":{"type":"object","properties":{"label":{"type":"string","example":"Option 1"},"value":{"type":"string","example":"option_1"},"description":{"type":"string","description":"A description of this option."},"hidden":{"type":"boolean","description":"Defaults to false."}},"required":["label","value"],"title":"picklist_option"}},"raw_details":{"type":"object","description":"The raw details of the property as provided by the third-party Provider, if available.","additionalProperties":true,"example":{}}},"required":["id","label","type"],"title":"property_unified"}}}}},"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"object_name","in":"path","required":true,"schema":{"type":"string","description":"The name of the object.","example":"contact"}}],"method":"post","path":"/properties/{object_name}","servers":[{"url":"https://api.supaglue.io/metadata/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"name":"ticketId","label":"First Name","description":"string","is_required":false,"group_name":"supaglue","type":"text","precision":0,"scale":0,"options":[{"label":"Option 1","value":"option_1","description":"string","hidden":true}]},"info":{"version":"0.13.1","title":"Metadata API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Metadata API documentation for CRM. You can use this API to operate on metadata across multiple third-party providers.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/metadata/v2\n```\n"},"postman":{"name":"Create property","description":{"content":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\nCreates a custom property in the provider and registers it in Supaglue.\n","type":"text/plain"},"url":{"path":["properties",":object_name"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"object_name"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/metadata/metadata-api custom_edit_url: null @@ -30,6 +30,9 @@ import TabItem from "@theme/TabItem"; +:::note +This feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information. +::: Creates a custom property in the provider and registers it in Supaglue. diff --git a/docs/docs/api/v2/metadata/get-property.api.mdx b/docs/docs/api/v2/metadata/get-property.api.mdx index 0777cc619..fa7cbc797 100644 --- a/docs/docs/api/v2/metadata/get-property.api.mdx +++ b/docs/docs/api/v2/metadata/get-property.api.mdx @@ -1,11 +1,11 @@ --- id: get-property -title: "Get property" -description: "Get property" -sidebar_label: "Get property" +title: "Get property (preview)" +description: ":::note" +sidebar_label: "Get property (preview)" hide_title: true hide_table_of_contents: true -api: {"operationId":"getProperty","tags":["Properties"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"Get property","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The machine name of the property as it appears in the third-party Provider.","example":"FirstName"},"custom_name":{"type":"string","description":"Only applicable for custom properties. This represents the unique identifier that can be used to refer to this property across all customers."},"label":{"type":"string","description":"The human-readable name of the property as provided by the third-party Provider.","example":"First Name"},"description":{"type":"string","description":"A description of the field."},"is_required":{"type":"boolean","example":false},"group_name":{"type":"string","example":"supaglue","description":"Only applicable for Hubspot. If specified, Supaglue will attempt to attach the field to this group if it exists, or create it if it doesn't."},"type":{"type":"string","enum":["text","textarea","number","picklist","multipicklist","date","datetime","boolean"],"description":"Type of the field.\nSupport:\n\n| Field | Hubspot (type-fieldType) | Salesforce | Pipedrive |\n| ------------------ | ------------------------ | -------------- | ------------- |\n| text | string-text | Text | varchar_auto |\n| textarea | string-textarea | Longtextarea | text |\n| number | number-number | Number | double |\n| picklist | enumeration-select | Picklist | enum |\n| multipicklist | enumeration-checkbox | Multipicklist | set |\n| date | date-date | Date | date |\n| datetime | datetime-date | Datetime | date |\n| boolean | boolean-booleancheckbox | Checkbox | enum |\n","title":"property_type"},"precision":{"type":"number","description":"Only applicable in Salesforce. If not given, will default to 18."},"scale":{"type":"number","description":"Only applicable in Salesforce. If not given, will default to 0."},"options":{"type":"array","description":"The list of options for a picklist/multipicklist field.","items":{"type":"object","properties":{"label":{"type":"string","example":"Option 1"},"value":{"type":"string","example":"option_1"},"description":{"type":"string","description":"A description of this option."},"hidden":{"type":"boolean","description":"Defaults to false."}},"required":["label","value"],"title":"picklist_option"}},"raw_details":{"type":"object","description":"The raw details of the property as provided by the third-party Provider, if available.","additionalProperties":true,"example":{}}},"required":["id","label","type"],"title":"property_unified"}}}}},"description":"Get property","parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"object_name","in":"path","required":true,"schema":{"type":"string","description":"The name of the object.","example":"contact"}},{"name":"property_name","in":"path","required":true,"schema":{"type":"string","description":"The name of the property.","example":"contact"}}],"method":"get","path":"/properties/{object_name}/{property_name}","servers":[{"url":"https://api.supaglue.io/metadata/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.13.1","title":"Metadata API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Metadata API documentation for CRM. You can use this API to operate on metadata across multiple third-party providers.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/metadata/v2\n```\n"},"postman":{"name":"Get property","description":{"type":"text/plain"},"url":{"path":["properties",":object_name",":property_name"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"object_name"},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"property_name"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getProperty","description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n","tags":["Properties"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"Get property","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The machine name of the property as it appears in the third-party Provider.","example":"FirstName"},"custom_name":{"type":"string","description":"Only applicable for custom properties. This represents the unique identifier that can be used to refer to this property across all customers."},"label":{"type":"string","description":"The human-readable name of the property as provided by the third-party Provider.","example":"First Name"},"description":{"type":"string","description":"A description of the field."},"is_required":{"type":"boolean","example":false},"group_name":{"type":"string","example":"supaglue","description":"Only applicable for Hubspot. If specified, Supaglue will attempt to attach the field to this group if it exists, or create it if it doesn't."},"type":{"type":"string","enum":["text","textarea","number","picklist","multipicklist","date","datetime","boolean"],"description":"Type of the field.\nSupport:\n\n| Field | Hubspot (type-fieldType) | Salesforce | Pipedrive |\n| ------------------ | ------------------------ | -------------- | ------------- |\n| text | string-text | Text | varchar_auto |\n| textarea | string-textarea | Longtextarea | text |\n| number | number-number | Number | double |\n| picklist | enumeration-select | Picklist | enum |\n| multipicklist | enumeration-checkbox | Multipicklist | set |\n| date | date-date | Date | date |\n| datetime | datetime-date | Datetime | date |\n| boolean | boolean-booleancheckbox | Checkbox | enum |\n","title":"property_type"},"precision":{"type":"number","description":"Only applicable in Salesforce. If not given, will default to 18."},"scale":{"type":"number","description":"Only applicable in Salesforce. If not given, will default to 0."},"options":{"type":"array","description":"The list of options for a picklist/multipicklist field.","items":{"type":"object","properties":{"label":{"type":"string","example":"Option 1"},"value":{"type":"string","example":"option_1"},"description":{"type":"string","description":"A description of this option."},"hidden":{"type":"boolean","description":"Defaults to false."}},"required":["label","value"],"title":"picklist_option"}},"raw_details":{"type":"object","description":"The raw details of the property as provided by the third-party Provider, if available.","additionalProperties":true,"example":{}}},"required":["id","label","type"],"title":"property_unified"}}}}},"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"object_name","in":"path","required":true,"schema":{"type":"string","description":"The name of the object.","example":"contact"}},{"name":"property_name","in":"path","required":true,"schema":{"type":"string","description":"The name of the property.","example":"contact"}}],"method":"get","path":"/properties/{object_name}/{property_name}","servers":[{"url":"https://api.supaglue.io/metadata/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.13.1","title":"Metadata API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Metadata API documentation for CRM. You can use this API to operate on metadata across multiple third-party providers.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/metadata/v2\n```\n"},"postman":{"name":"Get property (preview)","description":{"content":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n","type":"text/plain"},"url":{"path":["properties",":object_name",":property_name"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"object_name"},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"property_name"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/metadata/metadata-api custom_edit_url: null @@ -22,7 +22,7 @@ import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; import TabItem from "@theme/TabItem"; -

Get property

+

Get property (preview)

@@ -30,7 +30,10 @@ import TabItem from "@theme/TabItem"; -Get property +:::note +This feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information. +::: + ## Request diff --git a/docs/docs/api/v2/metadata/list-properties-deprecated.api.mdx b/docs/docs/api/v2/metadata/list-properties-deprecated.api.mdx deleted file mode 100644 index db506c838..000000000 --- a/docs/docs/api/v2/metadata/list-properties-deprecated.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: list-properties-deprecated -title: "List properties (deprecated)" -description: "List properties (deprecated)" -sidebar_label: "List properties (deprecated)" -hide_title: true -hide_table_of_contents: true -api: {"operationId":"listPropertiesDeprecated","tags":["Properties"],"security":[{"x-api-key":[]}],"parameters":[{"name":"type","in":"query","required":true,"schema":{"type":"string","enum":["standard","custom"]}},{"name":"name","in":"query","required":true,"schema":{"type":"string","description":"The name of the object for which you want to list properties."}},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"List of properties","content":{"application/json":{"schema":{"type":"object","properties":{"properties":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The machine name of the property as it appears in the third-party Provider.","example":"FirstName"},"label":{"type":"string","description":"The human-readable name of the property as provided by the third-party Provider.","example":"First Name"},"type":{"type":"string","description":"The type of the property as provided by the third-party Provider. These types are not unified by Supaglue. For Intercom, this is string, integer, boolean, or object. For Outreach, this is integer, boolean, number, array, or string.","example":"string"},"raw_details":{"type":"object","description":"The raw details of the property as provided by the third-party Provider, if available.","additionalProperties":true,"example":{}}},"required":["id","label"],"title":"property_deprecated"}}},"required":["properties"]}}}}},"description":"List properties (deprecated)","method":"get","path":"/properties","servers":[{"url":"https://api.supaglue.io/metadata/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.13.1","title":"Metadata API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Metadata API documentation for CRM. You can use this API to operate on metadata across multiple third-party providers.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/metadata/v2\n```\n"},"postman":{"name":"List properties (deprecated)","description":{"type":"text/plain"},"url":{"path":["properties"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"key":"type","value":""},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"key":"name","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} -sidebar_class_name: "get api-method" -info_path: api/v2/metadata/metadata-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; - -

List properties (deprecated)

- - - - - - - -List properties (deprecated) - -## Request - -

Query Parameters

Header Parameters

- -List of properties - -
Schema
    properties object[]required
  • Array [
    • raw_details object
    - -The raw details of the property as provided by the third-party Provider, if available. - -
  • ]
- \ No newline at end of file diff --git a/docs/docs/api/v2/metadata/list-properties-preview.api.mdx b/docs/docs/api/v2/metadata/list-properties-preview.api.mdx new file mode 100644 index 000000000..c0eb80718 --- /dev/null +++ b/docs/docs/api/v2/metadata/list-properties-preview.api.mdx @@ -0,0 +1,53 @@ +--- +id: list-properties-preview +title: "List properties (preview)" +description: ":::note" +sidebar_label: "List properties (preview)" +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listPropertiesPreview","description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n","tags":["Properties"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"List properties","content":{"application/json":{"schema":{"type":"object","properties":{"properties":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The machine name of the property as it appears in the third-party Provider.","example":"FirstName"},"custom_name":{"type":"string","description":"Only applicable for custom properties. This represents the unique identifier that can be used to refer to this property across all customers."},"label":{"type":"string","description":"The human-readable name of the property as provided by the third-party Provider.","example":"First Name"},"description":{"type":"string","description":"A description of the field."},"is_required":{"type":"boolean","example":false},"group_name":{"type":"string","example":"supaglue","description":"Only applicable for Hubspot. If specified, Supaglue will attempt to attach the field to this group if it exists, or create it if it doesn't."},"type":{"type":"string","enum":["text","textarea","number","picklist","multipicklist","date","datetime","boolean"],"description":"Type of the field.\nSupport:\n\n| Field | Hubspot (type-fieldType) | Salesforce | Pipedrive |\n| ------------------ | ------------------------ | -------------- | ------------- |\n| text | string-text | Text | varchar_auto |\n| textarea | string-textarea | Longtextarea | text |\n| number | number-number | Number | double |\n| picklist | enumeration-select | Picklist | enum |\n| multipicklist | enumeration-checkbox | Multipicklist | set |\n| date | date-date | Date | date |\n| datetime | datetime-date | Datetime | date |\n| boolean | boolean-booleancheckbox | Checkbox | enum |\n","title":"property_type"},"precision":{"type":"number","description":"Only applicable in Salesforce. If not given, will default to 18."},"scale":{"type":"number","description":"Only applicable in Salesforce. If not given, will default to 0."},"options":{"type":"array","description":"The list of options for a picklist/multipicklist field.","items":{"type":"object","properties":{"label":{"type":"string","example":"Option 1"},"value":{"type":"string","example":"option_1"},"description":{"type":"string","description":"A description of this option."},"hidden":{"type":"boolean","description":"Defaults to false."}},"required":["label","value"],"title":"picklist_option"}},"raw_details":{"type":"object","description":"The raw details of the property as provided by the third-party Provider, if available.","additionalProperties":true,"example":{}}},"required":["id","label","type"],"title":"property_unified"}}},"required":["properties"]}}}}},"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"object_name","in":"path","required":true,"schema":{"type":"string","description":"The name of the object.","example":"contact"}}],"method":"get","path":"/properties/{object_name}","servers":[{"url":"https://api.supaglue.io/metadata/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.13.1","title":"Metadata API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Metadata API documentation for CRM. You can use this API to operate on metadata across multiple third-party providers.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/metadata/v2\n```\n"},"postman":{"name":"List properties (preview)","description":{"content":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n","type":"text/plain"},"url":{"path":["properties",":object_name"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"object_name"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +sidebar_class_name: "get api-method" +info_path: api/v2/metadata/metadata-api +custom_edit_url: null +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import TabItem from "@theme/TabItem"; + +

List properties (preview)

+ + + + + + + +:::note +This feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information. +::: + + +## Request + +

Path Parameters

Header Parameters

+ +List properties + +
Schema
    properties object[]required
  • Array [
    • options object[]
    + +The list of options for a picklist/multipicklist field. + +
  • Array [
  • ]
    • raw_details object
    + +The raw details of the property as provided by the third-party Provider, if available. + +
  • ]
+ \ No newline at end of file diff --git a/docs/docs/api/v2/metadata/list-properties.api.mdx b/docs/docs/api/v2/metadata/list-properties.api.mdx index 5564b50b5..39409d743 100644 --- a/docs/docs/api/v2/metadata/list-properties.api.mdx +++ b/docs/docs/api/v2/metadata/list-properties.api.mdx @@ -5,7 +5,7 @@ description: "List properties" sidebar_label: "List properties" hide_title: true hide_table_of_contents: true -api: {"operationId":"listProperties","tags":["Properties"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"List properties","content":{"application/json":{"schema":{"type":"object","properties":{"properties":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The machine name of the property as it appears in the third-party Provider.","example":"FirstName"},"custom_name":{"type":"string","description":"Only applicable for custom properties. This represents the unique identifier that can be used to refer to this property across all customers."},"label":{"type":"string","description":"The human-readable name of the property as provided by the third-party Provider.","example":"First Name"},"description":{"type":"string","description":"A description of the field."},"is_required":{"type":"boolean","example":false},"group_name":{"type":"string","example":"supaglue","description":"Only applicable for Hubspot. If specified, Supaglue will attempt to attach the field to this group if it exists, or create it if it doesn't."},"type":{"type":"string","enum":["text","textarea","number","picklist","multipicklist","date","datetime","boolean"],"description":"Type of the field.\nSupport:\n\n| Field | Hubspot (type-fieldType) | Salesforce | Pipedrive |\n| ------------------ | ------------------------ | -------------- | ------------- |\n| text | string-text | Text | varchar_auto |\n| textarea | string-textarea | Longtextarea | text |\n| number | number-number | Number | double |\n| picklist | enumeration-select | Picklist | enum |\n| multipicklist | enumeration-checkbox | Multipicklist | set |\n| date | date-date | Date | date |\n| datetime | datetime-date | Datetime | date |\n| boolean | boolean-booleancheckbox | Checkbox | enum |\n","title":"property_type"},"precision":{"type":"number","description":"Only applicable in Salesforce. If not given, will default to 18."},"scale":{"type":"number","description":"Only applicable in Salesforce. If not given, will default to 0."},"options":{"type":"array","description":"The list of options for a picklist/multipicklist field.","items":{"type":"object","properties":{"label":{"type":"string","example":"Option 1"},"value":{"type":"string","example":"option_1"},"description":{"type":"string","description":"A description of this option."},"hidden":{"type":"boolean","description":"Defaults to false."}},"required":["label","value"],"title":"picklist_option"}},"raw_details":{"type":"object","description":"The raw details of the property as provided by the third-party Provider, if available.","additionalProperties":true,"example":{}}},"required":["id","label","type"],"title":"property_unified"}}},"required":["properties"]}}}}},"description":"List properties","parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"object_name","in":"path","required":true,"schema":{"type":"string","description":"The name of the object.","example":"contact"}}],"method":"get","path":"/properties/{object_name}","servers":[{"url":"https://api.supaglue.io/metadata/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.13.1","title":"Metadata API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Metadata API documentation for CRM. You can use this API to operate on metadata across multiple third-party providers.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/metadata/v2\n```\n"},"postman":{"name":"List properties","description":{"type":"text/plain"},"url":{"path":["properties",":object_name"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"object_name"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"listProperties","tags":["Properties"],"security":[{"x-api-key":[]}],"parameters":[{"name":"type","in":"query","required":true,"schema":{"type":"string","enum":["standard","custom"]}},{"name":"name","in":"query","required":true,"schema":{"type":"string","description":"The name of the object for which you want to list properties."}},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"List of properties","content":{"application/json":{"schema":{"type":"object","properties":{"properties":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The machine name of the property as it appears in the third-party Provider.","example":"FirstName"},"label":{"type":"string","description":"The human-readable name of the property as provided by the third-party Provider.","example":"First Name"},"type":{"type":"string","description":"The type of the property as provided by the third-party Provider. These types are not unified by Supaglue. For Intercom, this is string, integer, boolean, or object. For Outreach, this is integer, boolean, number, array, or string.","example":"string"},"raw_details":{"type":"object","description":"The raw details of the property as provided by the third-party Provider, if available.","additionalProperties":true,"example":{}}},"required":["id","label"],"title":"property_deprecated"}}},"required":["properties"]}}}}},"description":"List properties","method":"get","path":"/properties","servers":[{"url":"https://api.supaglue.io/metadata/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.13.1","title":"Metadata API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Metadata API documentation for CRM. You can use this API to operate on metadata across multiple third-party providers.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/metadata/v2\n```\n"},"postman":{"name":"List properties","description":{"type":"text/plain"},"url":{"path":["properties"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"key":"type","value":""},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"key":"name","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/metadata/metadata-api custom_edit_url: null @@ -24,7 +24,7 @@ import TabItem from "@theme/TabItem";

List properties

- + @@ -34,17 +34,13 @@ List properties ## Request -

Path Parameters

Header Parameters

+

Query Parameters

Header Parameters

-List properties - -
Schema
    properties object[]required
  • Array [
    • options object[]
    - -The list of options for a picklist/multipicklist field. +List of properties -
  • Array [
  • ]
    • raw_details object
    +
    Schema
      properties object[]required
    • Array [
      • raw_details object
      The raw details of the property as provided by the third-party Provider, if available. -
    • ]
    +
  • ]
    • \ No newline at end of file diff --git a/docs/docs/api/v2/metadata/register-property.api.mdx b/docs/docs/api/v2/metadata/register-property.api.mdx index 98dbdfee6..2cd6f9ee0 100644 --- a/docs/docs/api/v2/metadata/register-property.api.mdx +++ b/docs/docs/api/v2/metadata/register-property.api.mdx @@ -1,11 +1,11 @@ --- id: register-property -title: "Register Property" -description: "Registers a custom property in Supaglue." -sidebar_label: "Register Property" +title: "Register Property (preview)" +description: ":::note" +sidebar_label: "Register Property (preview)" hide_title: true hide_table_of_contents: true -api: {"operationId":"registerProperty","description":"Registers a custom property in Supaglue.\nThis may be useful for custom properties that were already created in the Customer's provider.\nE.g. a custom field has some machine ID for a particular customer that you want to map to `my_custom_field`.\n","tags":["Properties"],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The machine name of the property as it appears in the third-party Provider.","example":"FirstName"},"name":{"type":"string","description":"The unique identifier to be used to refer to this property across all customers. Supaglue will use this to appropriately map to the provider field ID.\n","example":"ticketId"}},"required":["name","id"]}}}},"responses":{"200":{"description":"Register a property","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The machine name of the property as it appears in the third-party Provider.","example":"FirstName"},"custom_name":{"type":"string","description":"Only applicable for custom properties. This represents the unique identifier that can be used to refer to this property across all customers."},"label":{"type":"string","description":"The human-readable name of the property as provided by the third-party Provider.","example":"First Name"},"description":{"type":"string","description":"A description of the field."},"is_required":{"type":"boolean","example":false},"group_name":{"type":"string","example":"supaglue","description":"Only applicable for Hubspot. If specified, Supaglue will attempt to attach the field to this group if it exists, or create it if it doesn't."},"type":{"type":"string","enum":["text","textarea","number","picklist","multipicklist","date","datetime","boolean"],"description":"Type of the field.\nSupport:\n\n| Field | Hubspot (type-fieldType) | Salesforce | Pipedrive |\n| ------------------ | ------------------------ | -------------- | ------------- |\n| text | string-text | Text | varchar_auto |\n| textarea | string-textarea | Longtextarea | text |\n| number | number-number | Number | double |\n| picklist | enumeration-select | Picklist | enum |\n| multipicklist | enumeration-checkbox | Multipicklist | set |\n| date | date-date | Date | date |\n| datetime | datetime-date | Datetime | date |\n| boolean | boolean-booleancheckbox | Checkbox | enum |\n","title":"property_type"},"precision":{"type":"number","description":"Only applicable in Salesforce. If not given, will default to 18."},"scale":{"type":"number","description":"Only applicable in Salesforce. If not given, will default to 0."},"options":{"type":"array","description":"The list of options for a picklist/multipicklist field.","items":{"type":"object","properties":{"label":{"type":"string","example":"Option 1"},"value":{"type":"string","example":"option_1"},"description":{"type":"string","description":"A description of this option."},"hidden":{"type":"boolean","description":"Defaults to false."}},"required":["label","value"],"title":"picklist_option"}},"raw_details":{"type":"object","description":"The raw details of the property as provided by the third-party Provider, if available.","additionalProperties":true,"example":{}}},"required":["id","label","type"],"title":"property_unified"}}}}},"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"object_name","in":"path","required":true,"schema":{"type":"string","description":"The name of the object.","example":"contact"}}],"method":"post","path":"/properties/{object_name}/register","servers":[{"url":"https://api.supaglue.io/metadata/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"id":"FirstName","name":"ticketId"},"info":{"version":"0.13.1","title":"Metadata API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Metadata API documentation for CRM. You can use this API to operate on metadata across multiple third-party providers.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/metadata/v2\n```\n"},"postman":{"name":"Register Property","description":{"content":"Registers a custom property in Supaglue.\nThis may be useful for custom properties that were already created in the Customer's provider.\nE.g. a custom field has some machine ID for a particular customer that you want to map to `my_custom_field`.\n","type":"text/plain"},"url":{"path":["properties",":object_name","register"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"object_name"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"registerProperty","description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\nRegisters a custom property in Supaglue.\nThis may be useful for custom properties that were already created in the Customer's provider.\nE.g. a custom field has some machine ID for a particular customer that you want to map to `my_custom_field`.\n","tags":["Properties"],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The machine name of the property as it appears in the third-party Provider.","example":"FirstName"},"name":{"type":"string","description":"The unique identifier to be used to refer to this property across all customers. Supaglue will use this to appropriately map to the provider field ID.\n","example":"ticketId"}},"required":["name","id"]}}}},"responses":{"200":{"description":"Register a property","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The machine name of the property as it appears in the third-party Provider.","example":"FirstName"},"custom_name":{"type":"string","description":"Only applicable for custom properties. This represents the unique identifier that can be used to refer to this property across all customers."},"label":{"type":"string","description":"The human-readable name of the property as provided by the third-party Provider.","example":"First Name"},"description":{"type":"string","description":"A description of the field."},"is_required":{"type":"boolean","example":false},"group_name":{"type":"string","example":"supaglue","description":"Only applicable for Hubspot. If specified, Supaglue will attempt to attach the field to this group if it exists, or create it if it doesn't."},"type":{"type":"string","enum":["text","textarea","number","picklist","multipicklist","date","datetime","boolean"],"description":"Type of the field.\nSupport:\n\n| Field | Hubspot (type-fieldType) | Salesforce | Pipedrive |\n| ------------------ | ------------------------ | -------------- | ------------- |\n| text | string-text | Text | varchar_auto |\n| textarea | string-textarea | Longtextarea | text |\n| number | number-number | Number | double |\n| picklist | enumeration-select | Picklist | enum |\n| multipicklist | enumeration-checkbox | Multipicklist | set |\n| date | date-date | Date | date |\n| datetime | datetime-date | Datetime | date |\n| boolean | boolean-booleancheckbox | Checkbox | enum |\n","title":"property_type"},"precision":{"type":"number","description":"Only applicable in Salesforce. If not given, will default to 18."},"scale":{"type":"number","description":"Only applicable in Salesforce. If not given, will default to 0."},"options":{"type":"array","description":"The list of options for a picklist/multipicklist field.","items":{"type":"object","properties":{"label":{"type":"string","example":"Option 1"},"value":{"type":"string","example":"option_1"},"description":{"type":"string","description":"A description of this option."},"hidden":{"type":"boolean","description":"Defaults to false."}},"required":["label","value"],"title":"picklist_option"}},"raw_details":{"type":"object","description":"The raw details of the property as provided by the third-party Provider, if available.","additionalProperties":true,"example":{}}},"required":["id","label","type"],"title":"property_unified"}}}}},"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"object_name","in":"path","required":true,"schema":{"type":"string","description":"The name of the object.","example":"contact"}}],"method":"post","path":"/properties/{object_name}/register","servers":[{"url":"https://api.supaglue.io/metadata/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"id":"FirstName","name":"ticketId"},"info":{"version":"0.13.1","title":"Metadata API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Metadata API documentation for CRM. You can use this API to operate on metadata across multiple third-party providers.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/metadata/v2\n```\n"},"postman":{"name":"Register Property (preview)","description":{"content":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\nRegisters a custom property in Supaglue.\nThis may be useful for custom properties that were already created in the Customer's provider.\nE.g. a custom field has some machine ID for a particular customer that you want to map to `my_custom_field`.\n","type":"text/plain"},"url":{"path":["properties",":object_name","register"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"object_name"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/metadata/metadata-api custom_edit_url: null @@ -22,7 +22,7 @@ import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; import TabItem from "@theme/TabItem"; -

    Register Property

    +

    Register Property (preview)

    @@ -30,6 +30,9 @@ import TabItem from "@theme/TabItem"; +:::note +This feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information. +::: Registers a custom property in Supaglue. This may be useful for custom properties that were already created in the Customer's provider. E.g. a custom field has some machine ID for a particular customer that you want to map to `my_custom_field`. diff --git a/docs/docs/api/v2/metadata/sidebar.js b/docs/docs/api/v2/metadata/sidebar.js index 86180c3e7..c3657c334 100644 --- a/docs/docs/api/v2/metadata/sidebar.js +++ b/docs/docs/api/v2/metadata/sidebar.js @@ -1 +1 @@ -module.exports = [{"type":"doc","id":"api/v2/metadata/metadata-api"},{"type":"category","label":"CustomObjects","link":{"type":"doc","id":"api/v2/metadata/custom-objects"},"collapsed":true,"items":[{"type":"doc","id":"api/v2/metadata/list-custom-objects","label":"List customObjects","className":"api-method get"},{"type":"doc","id":"api/v2/metadata/create-custom-object","label":"Create customObject","className":"api-method post"},{"type":"doc","id":"api/v2/metadata/get-custom-object","label":"Get customObject","className":"api-method get"},{"type":"doc","id":"api/v2/metadata/update-custom-object","label":"Update customObject","className":"api-method put"}]},{"type":"category","label":"StandardObjects","link":{"type":"doc","id":"api/v2/metadata/standard-objects"},"collapsed":true,"items":[{"type":"doc","id":"api/v2/metadata/list-standard-objects","label":"List standardObjects","className":"api-method get"}]},{"type":"category","label":"AssociationTypes","link":{"type":"doc","id":"api/v2/metadata/association-types"},"collapsed":true,"items":[{"type":"doc","id":"api/v2/metadata/get-association-types","label":"List associationTypes","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/v2/metadata/create-association-type","label":"Create associationType","className":"menu__list-item--deprecated api-method post"}]},{"type":"category","label":"Properties","link":{"type":"doc","id":"api/v2/metadata/properties"},"collapsed":true,"items":[{"type":"doc","id":"api/v2/metadata/list-properties-deprecated","label":"List properties (deprecated)","className":"api-method get"},{"type":"doc","id":"api/v2/metadata/list-properties","label":"List properties","className":"api-method get"},{"type":"doc","id":"api/v2/metadata/create-property","label":"Create property","className":"api-method post"},{"type":"doc","id":"api/v2/metadata/register-property","label":"Register Property","className":"api-method post"},{"type":"doc","id":"api/v2/metadata/get-property","label":"Get property","className":"api-method get"},{"type":"doc","id":"api/v2/metadata/update-property","label":"Update property","className":"api-method patch"}]}]; \ No newline at end of file +module.exports = [{"type":"doc","id":"api/v2/metadata/metadata-api"},{"type":"category","label":"CustomObjects","link":{"type":"doc","id":"api/v2/metadata/custom-objects"},"collapsed":true,"items":[{"type":"doc","id":"api/v2/metadata/list-custom-objects","label":"List customObjects","className":"api-method get"},{"type":"doc","id":"api/v2/metadata/create-custom-object","label":"Create customObject","className":"api-method post"},{"type":"doc","id":"api/v2/metadata/get-custom-object","label":"Get customObject","className":"api-method get"},{"type":"doc","id":"api/v2/metadata/update-custom-object","label":"Update customObject","className":"api-method put"}]},{"type":"category","label":"StandardObjects","link":{"type":"doc","id":"api/v2/metadata/standard-objects"},"collapsed":true,"items":[{"type":"doc","id":"api/v2/metadata/list-standard-objects","label":"List standardObjects","className":"api-method get"}]},{"type":"category","label":"AssociationTypes","link":{"type":"doc","id":"api/v2/metadata/association-types"},"collapsed":true,"items":[{"type":"doc","id":"api/v2/metadata/get-association-types","label":"List associationTypes","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/v2/metadata/create-association-type","label":"Create associationType","className":"menu__list-item--deprecated api-method post"}]},{"type":"category","label":"Properties","link":{"type":"doc","id":"api/v2/metadata/properties"},"collapsed":true,"items":[{"type":"doc","id":"api/v2/metadata/list-properties","label":"List properties","className":"api-method get"},{"type":"doc","id":"api/v2/metadata/list-properties-preview","label":"List properties (preview)","className":"api-method get"},{"type":"doc","id":"api/v2/metadata/create-property","label":"Create property","className":"api-method post"},{"type":"doc","id":"api/v2/metadata/register-property","label":"Register Property (preview)","className":"api-method post"},{"type":"doc","id":"api/v2/metadata/get-property","label":"Get property (preview)","className":"api-method get"},{"type":"doc","id":"api/v2/metadata/update-property","label":"Update property (preview)","className":"api-method patch"}]}]; \ No newline at end of file diff --git a/docs/docs/api/v2/metadata/update-property.api.mdx b/docs/docs/api/v2/metadata/update-property.api.mdx index a4f60479e..4ef10b6fb 100644 --- a/docs/docs/api/v2/metadata/update-property.api.mdx +++ b/docs/docs/api/v2/metadata/update-property.api.mdx @@ -1,11 +1,11 @@ --- id: update-property -title: "Update property" -description: "Update custom property" -sidebar_label: "Update property" +title: "Update property (preview)" +description: "Update custom property (preview)" +sidebar_label: "Update property (preview)" hide_title: true hide_table_of_contents: true -api: {"operationId":"updateProperty","description":"Update custom property","tags":["Properties"],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"label":{"type":"string","description":"The human-readable name of the property as provided by the third-party Provider.","example":"First Name"},"description":{"type":"string","description":"A description of the field."},"is_required":{"type":"boolean","description":"Defaults to false.","example":false},"group_name":{"type":"string","example":"supaglue","description":"Only applicable for Hubspot. If specified, Supaglue will attempt to attach the field to this group if it exists, or create it if it doesn't."},"type":{"type":"string","enum":["text","textarea","number","picklist","multipicklist","date","datetime","boolean"],"description":"Type of the field.\nSupport:\n\n| Field | Hubspot (type-fieldType) | Salesforce | Pipedrive |\n| ------------------ | ------------------------ | -------------- | ------------- |\n| text | string-text | Text | varchar_auto |\n| textarea | string-textarea | Longtextarea | text |\n| number | number-number | Number | double |\n| picklist | enumeration-select | Picklist | enum |\n| multipicklist | enumeration-checkbox | Multipicklist | set |\n| date | date-date | Date | date |\n| datetime | datetime-date | Datetime | date |\n| boolean | boolean-booleancheckbox | Checkbox | enum |\n","title":"property_type"},"precision":{"type":"number","description":"Only applicable in Salesforce. If not given, will default to 18."},"scale":{"type":"number","description":"Only applicable in Salesforce. If not given, will default to 0."},"options":{"type":"array","description":"The list of options for a picklist/multipicklist field.","items":{"type":"object","properties":{"label":{"type":"string","example":"Option 1"},"value":{"type":"string","example":"option_1"},"description":{"type":"string","description":"A description of this option."},"hidden":{"type":"boolean","description":"Defaults to false."}},"required":["label","value"],"title":"picklist_option"}}},"title":"update_property"}}}},"responses":{"200":{"description":"Create a property","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The machine name of the property as it appears in the third-party Provider.","example":"FirstName"},"custom_name":{"type":"string","description":"Only applicable for custom properties. This represents the unique identifier that can be used to refer to this property across all customers."},"label":{"type":"string","description":"The human-readable name of the property as provided by the third-party Provider.","example":"First Name"},"description":{"type":"string","description":"A description of the field."},"is_required":{"type":"boolean","example":false},"group_name":{"type":"string","example":"supaglue","description":"Only applicable for Hubspot. If specified, Supaglue will attempt to attach the field to this group if it exists, or create it if it doesn't."},"type":{"type":"string","enum":["text","textarea","number","picklist","multipicklist","date","datetime","boolean"],"description":"Type of the field.\nSupport:\n\n| Field | Hubspot (type-fieldType) | Salesforce | Pipedrive |\n| ------------------ | ------------------------ | -------------- | ------------- |\n| text | string-text | Text | varchar_auto |\n| textarea | string-textarea | Longtextarea | text |\n| number | number-number | Number | double |\n| picklist | enumeration-select | Picklist | enum |\n| multipicklist | enumeration-checkbox | Multipicklist | set |\n| date | date-date | Date | date |\n| datetime | datetime-date | Datetime | date |\n| boolean | boolean-booleancheckbox | Checkbox | enum |\n","title":"property_type"},"precision":{"type":"number","description":"Only applicable in Salesforce. If not given, will default to 18."},"scale":{"type":"number","description":"Only applicable in Salesforce. If not given, will default to 0."},"options":{"type":"array","description":"The list of options for a picklist/multipicklist field.","items":{"type":"object","properties":{"label":{"type":"string","example":"Option 1"},"value":{"type":"string","example":"option_1"},"description":{"type":"string","description":"A description of this option."},"hidden":{"type":"boolean","description":"Defaults to false."}},"required":["label","value"],"title":"picklist_option"}},"raw_details":{"type":"object","description":"The raw details of the property as provided by the third-party Provider, if available.","additionalProperties":true,"example":{}}},"required":["id","label","type"],"title":"property_unified"}}}}},"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"object_name","in":"path","required":true,"schema":{"type":"string","description":"The name of the object.","example":"contact"}},{"name":"property_name","in":"path","required":true,"schema":{"type":"string","description":"The name of the property.","example":"contact"}}],"method":"patch","path":"/properties/{object_name}/{property_name}","servers":[{"url":"https://api.supaglue.io/metadata/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"label":"First Name","description":"string","is_required":false,"group_name":"supaglue","type":"text","precision":0,"scale":0,"options":[{"label":"Option 1","value":"option_1","description":"string","hidden":true}]},"info":{"version":"0.13.1","title":"Metadata API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Metadata API documentation for CRM. You can use this API to operate on metadata across multiple third-party providers.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/metadata/v2\n```\n"},"postman":{"name":"Update property","description":{"content":"Update custom property","type":"text/plain"},"url":{"path":["properties",":object_name",":property_name"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"object_name"},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"property_name"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"updateProperty","description":"Update custom property (preview)","tags":["Properties"],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"label":{"type":"string","description":"The human-readable name of the property as provided by the third-party Provider.","example":"First Name"},"description":{"type":"string","description":"A description of the field."},"is_required":{"type":"boolean","description":"Defaults to false.","example":false},"group_name":{"type":"string","example":"supaglue","description":"Only applicable for Hubspot. If specified, Supaglue will attempt to attach the field to this group if it exists, or create it if it doesn't."},"type":{"type":"string","enum":["text","textarea","number","picklist","multipicklist","date","datetime","boolean"],"description":"Type of the field.\nSupport:\n\n| Field | Hubspot (type-fieldType) | Salesforce | Pipedrive |\n| ------------------ | ------------------------ | -------------- | ------------- |\n| text | string-text | Text | varchar_auto |\n| textarea | string-textarea | Longtextarea | text |\n| number | number-number | Number | double |\n| picklist | enumeration-select | Picklist | enum |\n| multipicklist | enumeration-checkbox | Multipicklist | set |\n| date | date-date | Date | date |\n| datetime | datetime-date | Datetime | date |\n| boolean | boolean-booleancheckbox | Checkbox | enum |\n","title":"property_type"},"precision":{"type":"number","description":"Only applicable in Salesforce. If not given, will default to 18."},"scale":{"type":"number","description":"Only applicable in Salesforce. If not given, will default to 0."},"options":{"type":"array","description":"The list of options for a picklist/multipicklist field.","items":{"type":"object","properties":{"label":{"type":"string","example":"Option 1"},"value":{"type":"string","example":"option_1"},"description":{"type":"string","description":"A description of this option."},"hidden":{"type":"boolean","description":"Defaults to false."}},"required":["label","value"],"title":"picklist_option"}}},"title":"update_property"}}}},"responses":{"200":{"description":"Create a property","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The machine name of the property as it appears in the third-party Provider.","example":"FirstName"},"custom_name":{"type":"string","description":"Only applicable for custom properties. This represents the unique identifier that can be used to refer to this property across all customers."},"label":{"type":"string","description":"The human-readable name of the property as provided by the third-party Provider.","example":"First Name"},"description":{"type":"string","description":"A description of the field."},"is_required":{"type":"boolean","example":false},"group_name":{"type":"string","example":"supaglue","description":"Only applicable for Hubspot. If specified, Supaglue will attempt to attach the field to this group if it exists, or create it if it doesn't."},"type":{"type":"string","enum":["text","textarea","number","picklist","multipicklist","date","datetime","boolean"],"description":"Type of the field.\nSupport:\n\n| Field | Hubspot (type-fieldType) | Salesforce | Pipedrive |\n| ------------------ | ------------------------ | -------------- | ------------- |\n| text | string-text | Text | varchar_auto |\n| textarea | string-textarea | Longtextarea | text |\n| number | number-number | Number | double |\n| picklist | enumeration-select | Picklist | enum |\n| multipicklist | enumeration-checkbox | Multipicklist | set |\n| date | date-date | Date | date |\n| datetime | datetime-date | Datetime | date |\n| boolean | boolean-booleancheckbox | Checkbox | enum |\n","title":"property_type"},"precision":{"type":"number","description":"Only applicable in Salesforce. If not given, will default to 18."},"scale":{"type":"number","description":"Only applicable in Salesforce. If not given, will default to 0."},"options":{"type":"array","description":"The list of options for a picklist/multipicklist field.","items":{"type":"object","properties":{"label":{"type":"string","example":"Option 1"},"value":{"type":"string","example":"option_1"},"description":{"type":"string","description":"A description of this option."},"hidden":{"type":"boolean","description":"Defaults to false."}},"required":["label","value"],"title":"picklist_option"}},"raw_details":{"type":"object","description":"The raw details of the property as provided by the third-party Provider, if available.","additionalProperties":true,"example":{}}},"required":["id","label","type"],"title":"property_unified"}}}}},"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"object_name","in":"path","required":true,"schema":{"type":"string","description":"The name of the object.","example":"contact"}},{"name":"property_name","in":"path","required":true,"schema":{"type":"string","description":"The name of the property.","example":"contact"}}],"method":"patch","path":"/properties/{object_name}/{property_name}","servers":[{"url":"https://api.supaglue.io/metadata/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"label":"First Name","description":"string","is_required":false,"group_name":"supaglue","type":"text","precision":0,"scale":0,"options":[{"label":"Option 1","value":"option_1","description":"string","hidden":true}]},"info":{"version":"0.13.1","title":"Metadata API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Metadata API documentation for CRM. You can use this API to operate on metadata across multiple third-party providers.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/metadata/v2\n```\n"},"postman":{"name":"Update property (preview)","description":{"content":"Update custom property (preview)","type":"text/plain"},"url":{"path":["properties",":object_name",":property_name"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"object_name"},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"property_name"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "patch api-method" info_path: api/v2/metadata/metadata-api custom_edit_url: null @@ -22,7 +22,7 @@ import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; import TabItem from "@theme/TabItem"; -

    Update property

    +

    Update property (preview)

    @@ -30,7 +30,7 @@ import TabItem from "@theme/TabItem"; -Update custom property +Update custom property (preview) ## Request diff --git a/openapi/v2/metadata/openapi.bundle.json b/openapi/v2/metadata/openapi.bundle.json index af7888598..37bc22f51 100644 --- a/openapi/v2/metadata/openapi.bundle.json +++ b/openapi/v2/metadata/openapi.bundle.json @@ -369,8 +369,8 @@ }, "/properties": { "get": { - "operationId": "listPropertiesDeprecated", - "summary": "List properties (deprecated)", + "operationId": "listProperties", + "summary": "List properties", "tags": [ "Properties" ], @@ -444,8 +444,9 @@ }, "/properties/{object_name}": { "get": { - "operationId": "listProperties", - "summary": "List properties", + "operationId": "listPropertiesPreview", + "summary": "List properties (preview)", + "description": ":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n", "tags": [ "Properties" ], @@ -481,7 +482,7 @@ "post": { "operationId": "createProperty", "summary": "Create property", - "description": "Creates a custom property in the provider and registers it in Supaglue.\n", + "description": ":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\nCreates a custom property in the provider and registers it in Supaglue.\n", "tags": [ "Properties" ], @@ -535,8 +536,8 @@ "/properties/{object_name}/register": { "post": { "operationId": "registerProperty", - "summary": "Register Property", - "description": "Registers a custom property in Supaglue.\nThis may be useful for custom properties that were already created in the Customer's provider.\nE.g. a custom field has some machine ID for a particular customer that you want to map to `my_custom_field`.\n", + "summary": "Register Property (preview)", + "description": ":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\nRegisters a custom property in Supaglue.\nThis may be useful for custom properties that were already created in the Customer's provider.\nE.g. a custom field has some machine ID for a particular customer that you want to map to `my_custom_field`.\n", "tags": [ "Properties" ], @@ -606,7 +607,8 @@ "/properties/{object_name}/{property_name}": { "get": { "operationId": "getProperty", - "summary": "Get property", + "summary": "Get property (preview)", + "description": ":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n", "tags": [ "Properties" ], @@ -630,8 +632,8 @@ }, "patch": { "operationId": "updateProperty", - "summary": "Update property", - "description": "Update custom property", + "summary": "Update property (preview)", + "description": "Update custom property (preview)", "tags": [ "Properties" ], diff --git a/openapi/v2/metadata/paths/properties.yaml b/openapi/v2/metadata/paths/properties.yaml index 638909c0a..d7521d623 100644 --- a/openapi/v2/metadata/paths/properties.yaml +++ b/openapi/v2/metadata/paths/properties.yaml @@ -1,6 +1,6 @@ get: - operationId: listPropertiesDeprecated - summary: List properties (deprecated) + operationId: listProperties + summary: List properties tags: - Properties security: diff --git a/openapi/v2/metadata/paths/properties@{object_name}.yaml b/openapi/v2/metadata/paths/properties@{object_name}.yaml index 7eb10b6ff..78331f309 100644 --- a/openapi/v2/metadata/paths/properties@{object_name}.yaml +++ b/openapi/v2/metadata/paths/properties@{object_name}.yaml @@ -1,6 +1,10 @@ get: - operationId: listProperties - summary: List properties + operationId: listPropertiesPreview + summary: List properties (preview) + description: | + :::note + This feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information. + ::: tags: - Properties security: @@ -23,6 +27,9 @@ post: operationId: createProperty summary: Create property description: | + :::note + This feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information. + ::: Creates a custom property in the provider and registers it in Supaglue. tags: - Properties diff --git a/openapi/v2/metadata/paths/properties@{object_name}@register.yaml b/openapi/v2/metadata/paths/properties@{object_name}@register.yaml index 987cc3b96..234a930ed 100644 --- a/openapi/v2/metadata/paths/properties@{object_name}@register.yaml +++ b/openapi/v2/metadata/paths/properties@{object_name}@register.yaml @@ -1,7 +1,10 @@ post: operationId: registerProperty - summary: Register Property + summary: Register Property (preview) description: | + :::note + This feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information. + ::: Registers a custom property in Supaglue. This may be useful for custom properties that were already created in the Customer's provider. E.g. a custom field has some machine ID for a particular customer that you want to map to `my_custom_field`. diff --git a/openapi/v2/metadata/paths/properties@{object_name}@{property_name}.yaml b/openapi/v2/metadata/paths/properties@{object_name}@{property_name}.yaml index e353f47aa..7ab63c681 100644 --- a/openapi/v2/metadata/paths/properties@{object_name}@{property_name}.yaml +++ b/openapi/v2/metadata/paths/properties@{object_name}@{property_name}.yaml @@ -1,6 +1,10 @@ get: operationId: getProperty - summary: Get property + summary: Get property (preview) + description: | + :::note + This feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information. + ::: tags: - Properties security: @@ -14,8 +18,8 @@ get: $ref: ../components/schemas/objects/property_unified.yaml patch: operationId: updateProperty - summary: Update property - description: Update custom property + summary: Update property (preview) + description: Update custom property (preview) tags: - Properties security: diff --git a/packages/schemas/gen/v2/metadata.ts b/packages/schemas/gen/v2/metadata.ts index 450de16cb..a19e71fe8 100644 --- a/packages/schemas/gen/v2/metadata.ts +++ b/packages/schemas/gen/v2/metadata.ts @@ -62,8 +62,8 @@ export interface paths { }; }; "/properties": { - /** List properties (deprecated) */ - get: operations["listPropertiesDeprecated"]; + /** List properties */ + get: operations["listProperties"]; parameters: { header: { "x-customer-id": components["parameters"]["x-customer-id"]; @@ -73,11 +73,19 @@ export interface paths { }; }; "/properties/{object_name}": { - /** List properties */ - get: operations["listProperties"]; + /** + * List properties (preview) + * @description :::note + * This feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information. + * ::: + */ + get: operations["listPropertiesPreview"]; /** * Create property - * @description Creates a custom property in the provider and registers it in Supaglue. + * @description :::note + * This feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information. + * ::: + * Creates a custom property in the provider and registers it in Supaglue. */ post: operations["createProperty"]; parameters: { @@ -91,8 +99,11 @@ export interface paths { }; "/properties/{object_name}/register": { /** - * Register Property - * @description Registers a custom property in Supaglue. + * Register Property (preview) + * @description :::note + * This feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information. + * ::: + * Registers a custom property in Supaglue. * This may be useful for custom properties that were already created in the Customer's provider. * E.g. a custom field has some machine ID for a particular customer that you want to map to `my_custom_field`. */ @@ -107,11 +118,16 @@ export interface paths { }; }; "/properties/{object_name}/{property_name}": { - /** Get property */ + /** + * Get property (preview) + * @description :::note + * This feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information. + * ::: + */ get: operations["getProperty"]; /** - * Update property - * @description Update custom property + * Update property (preview) + * @description Update custom property (preview) */ patch: operations["updateProperty"]; parameters: { @@ -574,8 +590,8 @@ export interface operations { }; }; }; - /** List properties (deprecated) */ - listPropertiesDeprecated: { + /** List properties */ + listProperties: { parameters: { query: { type: "standard" | "custom"; @@ -598,8 +614,13 @@ export interface operations { }; }; }; - /** List properties */ - listProperties: { + /** + * List properties (preview) + * @description :::note + * This feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information. + * ::: + */ + listPropertiesPreview: { parameters: { header: { "x-customer-id": components["parameters"]["x-customer-id"]; @@ -621,7 +642,10 @@ export interface operations { }; /** * Create property - * @description Creates a custom property in the provider and registers it in Supaglue. + * @description :::note + * This feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information. + * ::: + * Creates a custom property in the provider and registers it in Supaglue. */ createProperty: { parameters: { @@ -647,8 +671,11 @@ export interface operations { }; }; /** - * Register Property - * @description Registers a custom property in Supaglue. + * Register Property (preview) + * @description :::note + * This feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information. + * ::: + * Registers a custom property in Supaglue. * This may be useful for custom properties that were already created in the Customer's provider. * E.g. a custom field has some machine ID for a particular customer that you want to map to `my_custom_field`. */ @@ -687,7 +714,12 @@ export interface operations { }; }; }; - /** Get property */ + /** + * Get property (preview) + * @description :::note + * This feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information. + * ::: + */ getProperty: { parameters: { header: { @@ -708,8 +740,8 @@ export interface operations { }; }; /** - * Update property - * @description Update custom property + * Update property (preview) + * @description Update custom property (preview) */ updateProperty: { parameters: { diff --git a/packages/schemas/v2/metadata.ts b/packages/schemas/v2/metadata.ts index b3bb3d817..41b838763 100644 --- a/packages/schemas/v2/metadata.ts +++ b/packages/schemas/v2/metadata.ts @@ -55,6 +55,6 @@ export type CreateAssociationTypeResponse = export type ListPropertiesPathParams = never; export type ListPropertiesRequest = never; -export type ListPropertiesQueryParams = Required['parameters']['query']; +export type ListPropertiesQueryParams = Required['parameters']['query']; export type ListPropertiesResponse = - operations['listPropertiesDeprecated']['responses'][keyof operations['listPropertiesDeprecated']['responses']]['content']['application/json']; + operations['listProperties']['responses'][keyof operations['listProperties']['responses']]['content']['application/json'];