From d5cecef59bcce1fb966bd8fe4b32ed374e36077f Mon Sep 17 00:00:00 2001 From: Wixplorer Date: Sat, 13 Feb 2021 19:47:28 +0200 Subject: [PATCH 1/5] Auto commit from WixDocs server --- all/all-apis/app-intsance.service.json | 1 + 1 file changed, 1 insertion(+) create mode 100644 all/all-apis/app-intsance.service.json diff --git a/all/all-apis/app-intsance.service.json b/all/all-apis/app-intsance.service.json new file mode 100644 index 0000000000..1346de1935 --- /dev/null +++ b/all/all-apis/app-intsance.service.json @@ -0,0 +1 @@ +{"name":"App Intsance","memberOf":"All APIs","category":"core","mixes":[],"labels":[],"docs":{"summary":"Instance Related APIs","description":[]},"properties":[],"tags":[{"name":"App Instance","entity":"_com_wixpress_market_aim_api_AppInstance"},{"name":"Embedded Scripts","entity":"_com_wixpress_market_aim_api_ScriptProperties"},{"name":"Billing","entity":null},{"name":"BI Event","entity":null}],"relatedGuides":[{"path":"../guides/app-intsance/docs/EmbeddedScripts.md","name":"Introduction","tag":"Embedded Scripts"},{"path":"../guides/app-intsance/docs/README.md","name":"Introduction","tag":"App Instance"},{"path":"../guides/app-intsance/docs/Billing.md","name":"Introduction","tag":"Billing"},{"path":"../guides/app-intsance/docs/BIEvents.md","name":"Introduction","tag":"BI Event"}],"operations":[{"name":"Embed Script","methodName":"EmbedScript","serviceName":"EmbeddedScriptsService","tag":"Embedded Scripts","permissions":[{"name":"Manage Embedded Scripts","description":"Request permission to read, create and modify embedded scripts on the site."}],"events":[],"labels":[],"nameParams":[],"requiredFields":["properties"],"params":[{"in":"BODY","name":"properties","type":"All APIs.App Intsance._com_wixpress_market_aim_api_ScriptProperties","doc":" Parameters to embed\n","required":true},{"in":"BODY","name":"componentId","type":"string","doc":"","required":false}],"ret":{"type":{"name":"EmbedScript","statusCode":"200","typeParams":["All APIs.App Intsance._com_wixpress_market_aim_api_EmbedScriptResponse"]},"doc":""},"locations":[],"docs":{"summary":" Inject a script in an app with an existing embedded script component, with the given parameters\n \n","description":[],"request":"POST","url":"https://www.wixapis.com/apps/v1/scripts","links":[],"examples":[{"title":"","body":["curl -X POST \\\n https://www.wixapis.com/apps/v1/scripts \\\n -H 'Authorization: ' \\\n -d '{\n \"properties\": {\n \"parameters\": {\n \"MY_DYNAMIC_PARAMETER\": \"HB-23466-35\"\n }\n }\n }'"],"response":["{\"properties\": {\"parameters\": {\"MY_DYNAMIC_PARAMETER\": \"HB-23461-35\"}}} "],"type":"curl","extra":{}}],"extra":{}},"extra":{"hasRest":true,"rpcRequestName":"EmbedScriptRequest","rpcResponseName":"EmbedScriptResponse"},"customLabels":[]},{"name":"Get App Instance","methodName":"GetAppInstance","serviceName":"AppInstanceService","tag":"App Instance","permissions":[{"name":"Manage Your App","description":"Request permission to manage basic app activity."}],"events":[],"labels":[],"nameParams":[],"params":[],"ret":{"type":{"name":"GetAppInstance","statusCode":"200","typeParams":["All APIs.App Intsance._com_wixpress_market_aim_api_GetAppInstanceResponse"]},"doc":""},"locations":[],"docs":{"summary":" Retrieves data about the installation of your app on the user's website\n \n","description":[],"request":"GET","url":"https://www.wixapis.com/apps/v1/instance","links":[],"examples":[{"title":"","body":["curl -X GET \\\n https://www.wixapis.com/apps/v1/instance \\\n -H 'Authorization: '"],"response":["{\n \"instance\": {\n \"appName\": \"MY_SHINY_APP\",\n \"appVersion\": \"0.0.53\",\n \"billing\": {\n \"billingCycle\": \"MONTHLY\",\n \"packageName\": \"e8f429d4-0a6a-468f-8044-87f519a53202\"\n },\n \"instanceId\": \"07864c16-3a6f-4dd2-9973-028705762b2c\",\n \"isFree\": false,\n \"permissions\": [\n \"WIX_DEVELOPERS.CREATE_CHECKOUT\",\n \"WIX_DEVELOPERS.MANAGE_APP_INSTANCE\",\n \"WIX_DEVELOPERS.MANAGE_CHARGE\"\n ]\n },\n \"site\": {\n \"locale\": \"he\",\n \"multilingual\": {\n \"isMultiLingual\": false,\n \"supportedLanguages\": []\n },\n \"paymentCurrency\": \"ILS\",\n \"siteDisplayName\": \"Mysite 34\",\n \"url\": \"https://doereg11.wixsite.com/mysite-34\",\n \"description\": \"My awesome site is all about selling stuff\"\n }\n} "],"type":"curl","extra":{}}],"extra":{}},"extra":{"hasRest":true,"rpcRequestName":"GetAppInstanceRequest","rpcResponseName":"GetAppInstanceResponse"},"customLabels":[]},{"name":"Get Embedded Script","methodName":"GetEmbeddedScript","serviceName":"EmbeddedScriptsService","tag":"Embedded Scripts","permissions":[{"name":"Manage Embedded Scripts","description":"Request permission to read, create and modify embedded scripts on the site."}],"events":[],"labels":[],"nameParams":[],"params":[{"in":"QUERY","name":"componentId","type":"string","doc":"","required":false}],"ret":{"type":{"name":"GetEmbeddedScript","statusCode":"200","typeParams":["All APIs.App Intsance._com_wixpress_market_aim_api_GetEmbeddedScriptResponse"]},"doc":""},"locations":[],"docs":{"summary":" Retrieves this app's existing embedded script parameters\n If the app does not have an embed on the site, this endpoint will return 404\n \n","description":[],"request":"GET","url":"https://www.wixapis.com/apps/v1/scripts","links":[],"examples":[{"title":"","body":["curl -X GET \\\n https://www.wixapis.com/apps/v1/scripts \\\n -H 'Authorization: '"],"response":["{\"properties\": {\"parameters\": {\"MY_DYNAMIC_PARAMETER\": \"HB-23461-35\"}}} "],"type":"curl","extra":{}}],"extra":{}},"extra":{"hasRest":true,"rpcRequestName":"GetEmbeddedScriptRequest","rpcResponseName":"GetEmbeddedScriptResponse"},"customLabels":[]},{"name":"Get Purchase History","methodName":"GetPurchaseHistory","serviceName":"Checkout","tag":"Billing","permissions":[{"name":"Manage Your App","description":"Request permission to manage basic app activity."}],"events":[],"labels":[],"nameParams":[],"params":[],"ret":{"type":{"name":"GetPurchaseHistory","statusCode":"200","typeParams":["All APIs.App Intsance._com_wixpress_market_aim_api_GetPurchaseHistoryResponse"]},"doc":""},"locations":[],"docs":{"summary":" The Purchase History API provides a list of your user's purchase history for your app (particularly relevant for one-time purchases). \n Note: Cancellations of recurring plans are not included.\n \n","description":[],"request":"GET","url":"https://www.wixapis.com/apps/v1/checkout/history","links":[],"examples":[{"title":"","body":["curl -X GET \\\nhttps://www.wixapis.com/apps/v1/checkout/history\\\n-H 'Authorization: ' \\"],"response":["{\"purchases\": [{\n \"productId\": \"mid-tier\",\n \"price\": \"0\",\n \"currency\": \"USD\",\n \"billingCycle\": \"YEARLY\",\n \"dateCreated\": \"2020-07-21T08:45:18Z\"\n}]} "],"type":"curl","extra":{}}],"extra":{}},"extra":{"hasRest":true,"rpcRequestName":"GetPurchaseHistoryRequest","rpcResponseName":"GetPurchaseHistoryResponse"},"customLabels":[{"id":"maturity-beta"}]},{"name":"Get Url","methodName":"GetUrl","serviceName":"Checkout","tag":"Billing","permissions":[{"name":"Manage Your App","description":"Request permission to manage basic app activity."}],"events":[],"labels":[],"nameParams":[],"params":[{"in":"BODY","name":"productId","type":"string","doc":" Product to bill the user for (details taken from Developers Center).\n","required":false},{"in":"BODY","name":"successUrl","type":"string","doc":" URL to redirect user to after a successful purchase.\n","required":false},{"in":"BODY","name":"testCheckout","type":"boolean","doc":" Whether this checkout is for testing purposes only (relevant only for in-app purchases). When true, the price charged will be 0.00\n","required":false},{"in":"BODY","name":"billingCycle","type":"All APIs.App Intsance._com_wixpress_market_aim_api_PaymentCycle","doc":" Billing cycle (MONTHLY/YEARLY/ONE_TIME).\n","required":false},{"in":"BODY","name":"countryCode","type":"string","doc":" ISO-3166-1 alpha-2. Defaults to \"US\"\n","required":false},{"in":"BODY","name":"languageCode","type":"string","doc":" ISO-639-1. Defaults to \"en\"\n","required":false}],"ret":{"type":{"name":"GetUrl","statusCode":"200","typeParams":["All APIs.App Intsance._com_wixpress_market_aim_api_GetUrlResponse"]},"doc":""},"locations":[],"docs":{"summary":"\nThe Wix Billing API enables your app to lead customers seamlessly into Wix's checkout process from your platform (e.g., hosting your app's pricing page independently and redirecting to Wix checkout for purchase).\nThe returned checkout link is valid for 48 hours.\nNote: Use of this functionality is dependent on [setup in the Wix Developers Center](https://devforum.wix.com/en/article/setting-up-an-external-pricing-page).\n \n","description":[],"request":"POST","url":"https://www.wixapis.com/apps/v1/checkout","links":[],"examples":[{"title":"","body":["curl -X POST \\\n https://www.wixapis.com/apps/v1/checkout \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"productId\": \"e8f429d4-0a6a-468f-8044-87f519a53202\",\n \"billingCycle\": \"MONTHLY\"\n }'"],"response":["{\"checkoutUrl\": \"https://www.wix.com/apps/upgrade/order-checkout?token=JWS.eyJraWQiOiJaUnliMG5pbCIsImFsZyI6IkhTMjU2In0.eyJkYXRhIjoie1wib3JkZXJJdGVtc1wiOlt7XCJwcm9kdWN0SWRdIjpcImIwZjgwOGMzLWM4YmUtNGNkYS1iNmQyLTc0YTExNTM2ZDdiZFwiLFwicXVhbnRpdHlcIjoxLFwicGF5bWVudEN5Y2xlXCI6XCJNT05USExZXCIsXCJkaXNwbGF5TmFtZVwiOlwiXCIsXCJjb3Vwb25Db2RlXCI6bnVsbCxcImJpbGxpbmdTZXJ2aWNlSWRcIjpudWxsLFwib3ZlcnJpZGVQcmljZVwiOlwiOC4wXCIsXCJleHRlcm5hbE9yZGVySXRlbUlkXCI6XCJMaW5lSXRlbV8wXCJ9XSxcInN1Y2Nlc3NVcmxcIjpcImh0dHBzOi8vd3d3LndpeC5jb20vYXBwcy91cGdyYWRlL29yZGVyLXJlc3VsdFwiLFwid2l4VXNlckd1aWRcIjpudWxsLFwidXNlckVtYWlsXCI6bnVsbCxcImxhbmd1YWdlQ29kZVwiOlwiZW5cIixcImN1cnJlbmN5Q29kZVwiOlwiVVNEXCIsXCJvcmRlclBhcmFtc1wiOntcInNpdGVHdWlkXCI6XCIxMTE0MjExNC0yZDExLTRkNzYtOWEzZS0zZjUzMzBiNjBhYzdcIn0sXCJldmVudEFnZ3JlZ2F0b3JcIjpcImYzNGY1MGE4LTc3ZDMtNDE1Ny1iM2Q3LTZiMDJkYzI2ODQ1NlwiLFwiaW5pdGlhdG9yXCI6XCJBcHAgTWFya2V0IFRQQSBBUElcIixcImNvdXBvbkRpc3BsYXlOYW1lXCI6bnVsbH0iLCJpYXQiOjE1NzQ1OTAyMDcsImV4cCI6MTU3NDc2MzAwN30.quYK2ND5tCTsaRPlQA5349ULQoWUwkdPzQEwcQhqc9s&appId=5bc2068d-010b-448c-a62a-d6bb269c5a4c&planId=e8f429d4-0a6a-468f-8044-87f519a53202\"} "],"type":"curl","extra":{}}],"extra":{}},"extra":{"hasRest":true,"rpcRequestName":"GetUrlRequest","rpcResponseName":"GetUrlResponse"},"customLabels":[]},{"name":"send BI Event","methodName":"sendBIEvent","serviceName":"BIEventsService","tag":"BI Event","permissions":[{"name":"Manage Your App","description":"Request permission to manage basic app activity."}],"events":[],"labels":[],"nameParams":[],"params":[{"in":"BODY","name":"eventName","type":"All APIs.App Intsance._com_wixpress_market_aim_api_EventName","doc":"\n- \"APP_DASHBOARD_LOADED\" - should be fired each time your app's dashboard is loaded by a user,\n- \"APP_FINISHED_CONFIGURATION\" - should be fired when the user is completely onboarded and has completed all required configurations for the app to function properly,\n- \"APP_UPGRADED\" - should be fired when a user upgrades the app to a higher plan (when the upgrade and checkout flow is done on the app side and not via Wix),\n- \"PRIMARY_ACTION_PERFORMED\" - should be fired every time a user triggers the primary action in the app (for example, “review written” for a product reviews app),\n- \"CUSTOM\" - should be fired for any other event which is not supported by the above. When sending this event. Make sure to also send `customEventName`,\n- \"CHARGE\" - should be fired each time you charge money from the user, can be fired for a new purchase or subscription renewal,\n- \"FUNDS_RETURNED\" - should be fired each time you send money back to the users. Can be for refunds or chargebacks for example.\n\n","required":false},{"in":"BODY","name":"customEventName","type":"string","doc":" Custom event name. required when eventName = \"CUSTOM\".\n","required":false},{"in":"BODY","name":"eventData","type":"All APIs.App Intsance.eventDataMapEntry","doc":"Set of key-value pairs. Additional data about the event.\n","required":false}],"ret":{"type":{"name":"sendBIEvent","statusCode":"200","typeParams":["All APIs.App Intsance._com_wixpress_market_aim_api_SendBIEventResponse"]},"doc":""},"locations":[],"docs":{"summary":" Submit a BI event to Wix.\n \n","description":[],"request":"POST","url":"https://www.wixapis.com/apps/v1/bi-event","links":[],"examples":[{"title":"","body":["curl -X POST \\\n https://www.wixapis.com/apps/v1/bi-event \\\n -H 'Authorization: ' \\\n -d '{\n \"eventName\": \"CUSTOM\",\n \"customEventName\": \"Contact form submitted\",\n \"eventData\": {\n \"User name\": \"John Doe\",\n \"Title\": \"Need help with the app\",\n \"Description\": \"I've run into a little bit of an issue with my app\"\n },"],"response":["{} "],"type":"curl","extra":{}}],"extra":{}},"extra":{"hasRest":true,"rpcRequestName":"SendBIEventRequest","rpcResponseName":"SendBIEventResponse"},"customLabels":[{"id":"maturity-beta"}]}],"events":[{"type":"_com_wixpress_market_aim_api_AppInstalled","name":"App Installed Webhook","docs":{"summary":" When you sign up for the App Installed webhook, you will receive this notification when your app is installed on a site\n"},"topic":"app-provisioned-webhook","tag":"App Instance","permissions":[],"customLabels":[]},{"type":"_com_wixpress_market_aim_api_AppRemoved","name":"App Removed Webhook","docs":{"summary":" When you sign up for the App Removed webhook, you will receive this notification when your app is uninstalled from a site\n"},"topic":"app-removed-webhook","tag":"App Instance","permissions":[],"customLabels":[]},{"type":"_com_wixpress_market_aim_api_PaidPlanPurchased","name":"Paid Plan Purchased Webhook","docs":{"summary":"When you sign up for the Paid Plan Purchased webhook, you will receive this notification when a site owner purchases a paid plan\n"},"topic":"app-subscription-created-webhook","tag":"App Instance","permissions":[],"customLabels":[]},{"type":"_com_wixpress_market_aim_api_PaidPlanChanged","name":"Paid Plan Changed Webhook","docs":{"summary":"When you sign up for the Paid Plan Changed webhook, you will receive this notification when a user changes the app’s paid plan (to another paid plan)\n"},"topic":"app-subscription-changed-webhook","tag":"App Instance","permissions":[],"customLabels":[]},{"type":"_com_wixpress_market_aim_api_PaidPlanAutoRenewalCancelled","name":"Paid Plan Auto Renewal Cancelled Webhook","docs":{"summary":" When you sign up for the Paid Plan Auto-Renewal Cancelled webhook, you will receive this notification when a user cancels their paid plan. (The user will remain a paying user until the plan expires)\n"},"topic":"app-subscription-canceled-webhook","tag":"App Instance","permissions":[],"customLabels":[]}],"callbacks":[],"messages":[{"name":"_com_wixpress_siteproperties_api_v4_Locale","displayName":"Locale Object","locations":[],"docs":{"summary":"","links":[],"examples":[]},"members":[{"name":"languageCode","type":"string","doc":" Language code (ISO 639-1).\n"},{"name":"country","type":"string","doc":" Country code (ISO 3166-1).\n"}],"enum":null,"extra":{},"labels":[]},{"name":"_com_wixpress_siteproperties_api_v4_SupportedLanguage","displayName":"Supported Language Object","locations":[],"docs":{"summary":"","links":[],"examples":[]},"members":[{"name":"languageCode","type":"string","doc":" Language code (ISO 639-1).\n"},{"name":"locale","type":"All APIs.App Intsance._com_wixpress_siteproperties_api_v4_Locale","doc":" Locale.\n"},{"name":"isPrimary","type":"boolean","doc":" Whether the supported language is the primary language for the site.\n"},{"name":"countryCode","type":"string","doc":" Language icon.\n"},{"name":"resolutionMethod","type":"All APIs.App Intsance._com_wixpress_siteproperties_api_v4_ResolutionMethod","doc":" How the language will be resolved. For internal use.\n"}],"enum":null,"extra":{},"labels":[]},{"name":"_com_wixpress_market_aim_api_BillingInfo","displayName":"Billing Info Object","locations":[],"docs":{"summary":"","links":[],"examples":[]},"members":[{"name":"packageName","type":"string","doc":" Name of the paid package the site owner has paid for.\n"},{"name":"billingCycle","type":"All APIs.App Intsance._com_wixpress_market_aim_api_PaymentCycle","doc":" Billing cycle type for the user's paid package - monthly/yearly.\n"},{"name":"timeStamp","type":"string","doc":" App/plan date of purchase.\n"},{"name":"expirationDate","type":"string","doc":" App/plan expiration date. Only relevant for yearly plans.\n"},{"name":"autoRenewing","type":"boolean","doc":" Whether the app/plan will auto renew on the expiration date. \n"},{"name":"invoiceId","type":"string","doc":" App/plan invoice ID.\n"}],"enum":null,"extra":{},"labels":[]},{"name":"_com_wixpress_market_aim_api_AppInstance","displayName":"App Instance Object","locations":[],"docs":{"summary":"","links":[],"examples":[{"title":"","body":["{\n \"instance\": {\n \"appName\": \"MY_SHINY_APP\",\n \"appVersion\": \"0.0.53\",\n \"billing\": {\n \"billingCycle\": \"MONTHLY\",\n \"packageName\": \"e8f429d4-0a6a-468f-8044-87f519a53202\"\n },\n \"instanceId\": \"07864c16-3a6f-4dd2-9973-028705762b2c\",\n \"isFree\": false,\n \"permissions\": [\n \"WIX_DEVELOPERS.CREATE_CHECKOUT\",\n \"WIX_DEVELOPERS.MANAGE_APP_INSTANCE\",\n \"WIX_DEVELOPERS.MANAGE_CHARGE\"\n ]\n },\n \"site\": {\n \"locale\": \"he\",\n \"multilingual\": {\n \"isMultiLingual\": false,\n \"supportedLanguages\": []\n },\n \"paymentCurrency\": \"ILS\",\n \"siteDisplayName\": \"Mysite 34\",\n \"url\": \"https://doereg11.wixsite.com/mysite-34\",\n \"description\": \"My awesome site is all about selling stuff\"\n }\n} "],"type":"json","extra":{}}]},"members":[{"name":"instanceId","type":"string","doc":" App instance ID - a unique ID assigned to each app in each site.\n"},{"name":"appName","type":"string","doc":" App name.\n"},{"name":"appVersion","type":"string","doc":" App version installed in this instance.\n"},{"name":"isFree","type":"boolean","doc":" Whether the site owner has a free version of the app (and no paid plan is found). Otherwise false\n"},{"name":"billing","type":"All APIs.App Intsance._com_wixpress_market_aim_api_BillingInfo","doc":" Billing info for the purchased app/plan in this site.\n"},{"name":"permissions","type":{"name":"array","typeParams":["string"]},"doc":" Permissions included in this app's access token.\n"},{"name":"availablePlans","type":{"name":"array","typeParams":["All APIs.App Intsance._com_wixpress_market_aim_api_AvailablePlan"]},"doc":" Plans available to this instance.\n"}],"enum":null,"extra":{},"labels":[]},{"name":"_com_wixpress_market_aim_api_AvailablePlan","displayName":"Available Plan Object","locations":[],"docs":{"summary":"","links":[],"examples":[]},"members":[{"name":"packageName","type":"string","doc":" Name of the package.\n"},{"name":"source","type":"string","doc":" Plan from bundle or from third party app upgrade.\n"}],"enum":null,"extra":{},"labels":[]},{"name":"_com_wixpress_market_aim_api_SiteInfo","displayName":"Site Info Object","locations":[],"docs":{"summary":"","links":[],"examples":[]},"members":[{"name":"siteDisplayName","type":"string","doc":" Site display name.\n"},{"name":"locale","type":"string","doc":" Language code (ISO 639-1) used on this site.\n"},{"name":"paymentCurrency","type":"string","doc":" Currency code (ISO 4217) selected to bill customers on this site.\n"},{"name":"multilingual","type":"All APIs.App Intsance._com_wixpress_market_aim_api_Multilingual","doc":""},{"name":"url","type":"string","doc":" Site URL.\n"},{"name":"description","type":"string","doc":" Site description.\n"},{"name":"installedWixApps","type":{"name":"array","typeParams":["string"]},"doc":"Names of Wix apps that are installed on this site.\n"}],"enum":null,"extra":{},"labels":[]},{"name":"_com_wixpress_market_aim_api_Multilingual","displayName":"Multilingual Object","locations":[],"docs":{"summary":"","links":[],"examples":[]},"members":[{"name":"isMultiLingual","type":"boolean","doc":" Whether multiple languages are supported. When true, an array of supported languages is returned.\n"},{"name":"supportedLanguages","type":{"name":"array","typeParams":["All APIs.App Intsance._com_wixpress_siteproperties_api_v4_SupportedLanguage"]},"doc":" An array of supported languages. Returned only when isMultiLingual is true.\n"}],"enum":null,"extra":{},"labels":[]},{"name":"_com_wixpress_market_aim_api_GetAppInstanceRequest","displayName":"Get App Instance Request Object","locations":[],"docs":{"summary":"","links":[],"examples":[]},"members":[],"enum":null,"extra":{},"labels":[]},{"name":"_com_wixpress_market_aim_api_GetAppInstanceResponse","displayName":"Get App Instance Response Object","locations":[],"docs":{"summary":"","links":[],"examples":[]},"members":[{"name":"instance","type":"All APIs.App Intsance._com_wixpress_market_aim_api_AppInstance","doc":""},{"name":"site","type":"All APIs.App Intsance._com_wixpress_market_aim_api_SiteInfo","doc":""}],"enum":null,"extra":{},"labels":[]},{"name":"_com_wixpress_market_aim_api_GetAppInstanceByInstanceIdRequest","displayName":"Get App Instance By Instance Id Request Object","locations":[],"docs":{"summary":"","links":[],"examples":[]},"members":[{"name":"instanceId","type":"string","doc":""}],"enum":null,"extra":{},"labels":[]},{"name":"eventDataMapEntry","displayName":"event Data Map Entry Object","locations":[],"docs":{"summary":"Set of key-value pairs. Additional data about the event.\n","links":[],"examples":[]},"members":[{"name":"key:value","type":"string","doc":"`key` of type string, `value` of type string"}],"enum":null,"extra":{},"labels":[]},{"name":"_com_wixpress_market_aim_api_SendBIEventRequest","displayName":"Send BI Event Request Object","locations":[],"docs":{"summary":"","links":[],"examples":[]},"members":[{"name":"eventName","type":"All APIs.App Intsance._com_wixpress_market_aim_api_EventName","doc":"\n- \"APP_DASHBOARD_LOADED\" - should be fired each time your app's dashboard is loaded by a user,\n- \"APP_FINISHED_CONFIGURATION\" - should be fired when the user is completely onboarded and has completed all required configurations for the app to function properly,\n- \"APP_UPGRADED\" - should be fired when a user upgrades the app to a higher plan (when the upgrade and checkout flow is done on the app side and not via Wix),\n- \"PRIMARY_ACTION_PERFORMED\" - should be fired every time a user triggers the primary action in the app (for example, “review written” for a product reviews app),\n- \"CUSTOM\" - should be fired for any other event which is not supported by the above. When sending this event. Make sure to also send `customEventName`,\n- \"CHARGE\" - should be fired each time you charge money from the user, can be fired for a new purchase or subscription renewal,\n- \"FUNDS_RETURNED\" - should be fired each time you send money back to the users. Can be for refunds or chargebacks for example.\n\n"},{"name":"customEventName","type":"string","doc":" Custom event name. required when eventName = \"CUSTOM\".\n"},{"name":"eventData","type":"All APIs.App Intsance.eventDataMapEntry","doc":"Set of key-value pairs. Additional data about the event.\n"}],"enum":null,"extra":{},"labels":[]},{"name":"_com_wixpress_market_aim_api_SendBIEventResponse","displayName":"Send BI Event Response Object","locations":[],"docs":{"summary":"","links":[],"examples":[]},"members":[],"enum":null,"extra":{},"labels":[]},{"name":"_com_wixpress_market_aim_api_GetUrlRequest","displayName":"Get Url Request Object","locations":[],"docs":{"summary":"","links":[],"examples":[]},"members":[{"name":"productId","type":"string","doc":" Product to bill the user for (details taken from Developers Center).\n"},{"name":"successUrl","type":"string","doc":" URL to redirect user to after a successful purchase.\n"},{"name":"testCheckout","type":"boolean","doc":" Whether this checkout is for testing purposes only (relevant only for in-app purchases). When true, the price charged will be 0.00\n"},{"name":"billingCycle","type":"All APIs.App Intsance._com_wixpress_market_aim_api_PaymentCycle","doc":" Billing cycle (MONTHLY/YEARLY/ONE_TIME).\n"},{"name":"countryCode","type":"string","doc":" ISO-3166-1 alpha-2. Defaults to \"US\"\n"},{"name":"languageCode","type":"string","doc":" ISO-639-1. Defaults to \"en\"\n"}],"enum":null,"extra":{},"labels":[]},{"name":"_com_wixpress_market_aim_api_GetUrlResponse","displayName":"Get Url Response Object","locations":[],"docs":{"summary":"","links":[],"examples":[]},"members":[{"name":"checkoutUrl","type":"string","doc":" Wix checkout URL based on the parameters in the request\n"}],"enum":null,"extra":{},"labels":[]},{"name":"_com_wixpress_market_aim_api_GetPurchaseHistoryRequest","displayName":"Get Purchase History Request Object","locations":[],"docs":{"summary":"","links":[],"examples":[]},"members":[],"enum":null,"extra":{},"labels":[]},{"name":"_com_wixpress_market_aim_api_GetPurchaseHistoryResponse","displayName":"Get Purchase History Response Object","locations":[],"docs":{"summary":"","links":[],"examples":[]},"members":[{"name":"purchases","type":{"name":"array","typeParams":["All APIs.App Intsance._com_wixpress_market_aim_api_PurchasedItem"]},"doc":""}],"enum":null,"extra":{},"labels":[]},{"name":"_com_wixpress_market_aim_api_PurchasedItem","displayName":"Purchased Item Object","locations":[],"docs":{"summary":"","links":[],"examples":[]},"members":[{"name":"productId","type":"string","doc":" Product ID.\n"},{"name":"price","type":"string","doc":" Product price.\n"},{"name":"currency","type":"string","doc":" Payment currency.\n"},{"name":"billingCycle","type":"All APIs.App Intsance._com_wixpress_market_aim_api_PaymentCycle","doc":""},{"name":"dateCreated","type":"string","doc":" Order date.\n"}],"enum":null,"extra":{},"labels":[]},{"name":"parametersMapEntry","displayName":"parameters Map Entry Object","locations":[],"docs":{"summary":"Set of key-value pairs. Script parameters\n","links":[],"examples":[]},"members":[{"name":"key:value","type":"string","doc":"`key` of type string, `value` of type string"}],"enum":null,"extra":{},"labels":[]},{"name":"_com_wixpress_market_aim_api_ScriptProperties","displayName":"Script Properties Object","locations":[],"docs":{"summary":" Embedded script data\n","links":[],"examples":[]},"members":[{"name":"parameters","type":"All APIs.App Intsance.parametersMapEntry","doc":"Set of key-value pairs. Script parameters\n"},{"name":"disabled","type":"boolean","doc":" Whether script is disabled or not, defaults to false (not disabled)\n"}],"enum":null,"extra":{},"labels":[]},{"name":"_com_wixpress_market_aim_api_EmbedScriptRequest","displayName":"Embed Script Request Object","locations":[],"docs":{"summary":"","links":[],"examples":[]},"members":[{"name":"properties","type":"All APIs.App Intsance._com_wixpress_market_aim_api_ScriptProperties","doc":" Parameters to embed\n"},{"name":"componentId","type":"string","doc":""}],"enum":null,"extra":{},"labels":[]},{"name":"_com_wixpress_market_aim_api_EmbedScriptResponse","displayName":"Embed Script Response Object","locations":[],"docs":{"summary":"","links":[],"examples":[]},"members":[{"name":"properties","type":"All APIs.App Intsance._com_wixpress_market_aim_api_ScriptProperties","doc":" Script instance on this website\n"}],"enum":null,"extra":{},"labels":[]},{"name":"_com_wixpress_market_aim_api_GetEmbeddedScriptRequest","displayName":"Get Embedded Script Request Object","locations":[],"docs":{"summary":"","links":[],"examples":[]},"members":[{"name":"componentId","type":"string","doc":""}],"enum":null,"extra":{},"labels":[]},{"name":"_com_wixpress_market_aim_api_GetEmbeddedScriptResponse","displayName":"Get Embedded Script Response Object","locations":[],"docs":{"summary":"","links":[],"examples":[]},"members":[{"name":"properties","type":"All APIs.App Intsance._com_wixpress_market_aim_api_ScriptProperties","doc":" Script instance on this website\n"}],"enum":null,"extra":{},"labels":[]},{"name":"_com_wixpress_market_aim_api_EmbedScriptByInstanceIdRequest","displayName":"Embed Script By Instance Id Request Object","locations":[],"docs":{"summary":"","links":[],"examples":[]},"members":[{"name":"instanceId","type":"string","doc":""},{"name":"properties","type":"All APIs.App Intsance._com_wixpress_market_aim_api_ScriptProperties","doc":" Parameters to embed\n"},{"name":"componentId","type":"string","doc":""}],"enum":null,"extra":{},"labels":[]},{"name":"_com_wixpress_market_aim_api_GetEmbeddedScriptByInstanceIdRequest","displayName":"Get Embedded Script By Instance Id Request Object","locations":[],"docs":{"summary":"","links":[],"examples":[]},"members":[{"name":"instanceId","type":"string","doc":""},{"name":"componentId","type":"string","doc":""}],"enum":null,"extra":{},"labels":[]},{"name":"_com_wixpress_market_aim_api_AppInstalled","displayName":"App Installed Object","locations":[],"docs":{"summary":"","links":[],"examples":[{"title":"","body":["{\n \"data\": {\"appId\": \"5bc2062d-010b-448c-a62a-d6bb269c5a4c\"},\n \"instanceId\": \"3bbcabc7-ebb7-4fc8-8829-13ea0e142123\",\n \"eventType\": \"AppInstalled\"\n} "],"type":"json","extra":{}}]},"members":[{"name":"appId","type":"string","doc":" Unique identifier of the app within the website.\n"}],"enum":null,"extra":{},"labels":[]},{"name":"_com_wixpress_market_aim_api_AppRemoved","displayName":"App Removed Object","locations":[],"docs":{"summary":"","links":[],"examples":[{"title":"","body":["{\n \"data\": {\"appId\": \"5bc2068d-010b-448c-a62a-d6bb269c5a4c\"},\n \"instanceId\": \"8e9d6b70-6eb9-4ab3-a62d-e033063e2f05\",\n \"eventType\": \"AppRemoved\"\n} "],"type":"json","extra":{}}]},"members":[{"name":"appId","type":"string","doc":" Unique identifier of the app within the website.\n"}],"enum":null,"extra":{},"labels":[]},{"name":"_com_wixpress_market_aim_api_PaidPlanPurchased","displayName":"Paid Plan Purchased Object","locations":[],"docs":{"summary":"","links":[],"examples":[{"title":"","body":["{\n \"data\": {\n \"operationTimeStamp\": \"2019-12-09T07:44:53.659Z\",\n \"vendorProductId\": \"e8f429d5-0a6a-468f-8044-87f519a53202\",\n \"cycle\": \"MONTHLY\",\n \"expiresOn\": \"2020-01-09T07:44:53Z\"\n },\n \"instanceId\": \"8e9d6b70-6eb9-4ab4-a62d-e033063e2f05\",\n \"eventType\": \"PaidPlanPurchased\"\n} "],"type":"json","extra":{}}]},"members":[{"name":"operationTimeStamp","type":"string","doc":" Date and time of purchase.\n"},{"name":"vendorProductId","type":"string","doc":" Purchased app plan.\n"},{"name":"cycle","type":"All APIs.App Intsance._com_wixpress_market_aim_api_PaymentCycle","doc":" Selected payment cycle.\n"},{"name":"expiresOn","type":"string","doc":" Plan expiration date.\n"},{"name":"couponName","type":"string","doc":" Coupon applied to purchase (if relevant).\n"},{"name":"invoiceId","type":"string","doc":" Invoice ID.\n"}],"enum":null,"extra":{},"labels":[]},{"name":"_com_wixpress_market_aim_api_PaidPlanChanged","displayName":"Paid Plan Changed Object","locations":[],"docs":{"summary":"","links":[],"examples":[{"title":"","body":["{\n \"data\": {\n \"operationTimeStamp\": \"2019-12-08T07:42:04.535Z\",\n \"vendorProductId\": \"e61158e5-e327-4694-ac50-2a3a0db87c84\",\n \"cycle\": \"YEARLY\",\n \"previousVendorProductId\": \"e61158e5-e327-4694-ac50-2a3a0db87c84\",\n \"previousCycle\": \"MONTHLY\"\n },\n \"instanceId\": \"5bc2068d-010b-448c-a62a-d6bb269c2a4c\",\n \"eventType\": \"PaidPlanChanged\"\n} "],"type":"json","extra":{}}]},"members":[{"name":"operationTimeStamp","type":"string","doc":" Date and time of change.\n"},{"name":"vendorProductId","type":"string","doc":" Newly purchased app plan.\n"},{"name":"cycle","type":"All APIs.App Intsance._com_wixpress_market_aim_api_PaymentCycle","doc":" Newly selected payment cycle.\n"},{"name":"previousVendorProductId","type":"string","doc":" Previous app plan.\n"},{"name":"previousCycle","type":"All APIs.App Intsance._com_wixpress_market_aim_api_PaymentCycle","doc":" Previous payment cycle.\n"},{"name":"couponName","type":"string","doc":" Coupon applied to purchase (if relevant).\n"},{"name":"invoiceId","type":"string","doc":" Invoice ID.\n"}],"enum":null,"extra":{},"labels":[]},{"name":"_com_wixpress_market_aim_api_PaidPlanAutoRenewalCancelled","displayName":"Paid Plan Auto Renewal Cancelled Object","locations":[],"docs":{"summary":"","links":[],"examples":[{"title":"","body":["{\n \"data\": {\n \"operationTimeStamp\": \"2019-12-09T07:55:18.356Z\",\n \"vendorProductId\": \"e8f429d4-0a6a-468f-8044-87f519a53202\",\n \"cycle\": \"MONTHLY\",\n \"cancelReason\": \"USER_CANCEL\",\n \"userReason\": \"Cancel reason: No reason chosen\",\n \"subscriptionCancellationType\": \"AT_END_OF_PERIOD\"\n },\n \"instanceId\": \"8e9d6b70-6eb9-4ab3-a62d-e033063e2f05\",\n \"eventType\": \"PaidPlanAutoRenewalCancelled\"\n} "],"type":"json","extra":{}}]},"members":[{"name":"operationTimeStamp","type":"string","doc":" Date and time of auto-renewal cancellation.\n"},{"name":"vendorProductId","type":"string","doc":" Current app plan.\n"},{"name":"cycle","type":"All APIs.App Intsance._com_wixpress_market_aim_api_PaymentCycle","doc":" Current payment cycle.\n"},{"name":"cancelReason","type":"string","doc":" Reason provided by app for cancellation (if relevant).\n"},{"name":"userReason","type":"string","doc":" Reason provided by site owner for cancellation (if relevant).\n"},{"name":"subscriptionCancellationType","type":"string","doc":" Cancellation type.\n"}],"enum":null,"extra":{},"labels":[]},{"name":"_com_wixpress_siteproperties_api_v4_ResolutionMethod","displayName":"Resolution Method Object","locations":[],"docs":{"summary":" \n Possible values are:
  • QUERY_PARAM <\/code><\/li>
  • SUBDOMAIN <\/code><\/li>","links":[],"examples":[]},"members":[],"enum":["QUERY_PARAM","SUBDOMAIN"],"extra":{},"labels":[]},{"name":"_com_wixpress_market_aim_api_PaymentCycle","displayName":"Payment Cycle Object","locations":[],"docs":{"summary":" \n Possible values are:
  • NO_CYCLE <\/code><\/li>
  • MONTHLY <\/code><\/li>
  • YEARLY <\/code><\/li>
  • ONE_TIME <\/code><\/li>","links":[],"examples":[]},"members":[],"enum":["NO_CYCLE","MONTHLY","YEARLY","ONE_TIME"],"extra":{},"labels":[]},{"name":"_com_wixpress_market_aim_api_EventName","displayName":"Event Name Object","locations":[],"docs":{"summary":" \n Possible values are:
  • UNKNOWN <\/code><\/li>
  • APP_DASHBOARD_LOADED <\/code><\/li>
  • APP_FINISHED_CONFIGURATION <\/code><\/li>
  • APP_UPGRADED <\/code><\/li>
  • PRIMARY_ACTION_PERFORMED <\/code><\/li>
  • CUSTOM <\/code><\/li>
  • CHARGE <\/code><\/li>
  • FUNDS_RETURNED <\/code><\/li>","links":[],"examples":[]},"members":[],"enum":["UNKNOWN","APP_DASHBOARD_LOADED","APP_FINISHED_CONFIGURATION","APP_UPGRADED","PRIMARY_ACTION_PERFORMED","CUSTOM","CHARGE","FUNDS_RETURNED"],"extra":{},"labels":[]}],"extra":{"artifactId":"com.wixpress.market.app-instance-manager-webapp"}} \ No newline at end of file From c8d00a086850cd54f8efdb02fb86429bbec93630 Mon Sep 17 00:00:00 2001 From: Wixplorer Date: Sat, 13 Feb 2021 20:29:28 +0200 Subject: [PATCH 2/5] Auto commit from WixDocs server --- all/guides/app-intsance/docs/EmbeddedScripts.md | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 all/guides/app-intsance/docs/EmbeddedScripts.md diff --git a/all/guides/app-intsance/docs/EmbeddedScripts.md b/all/guides/app-intsance/docs/EmbeddedScripts.md new file mode 100644 index 0000000000..0b3fb49da8 --- /dev/null +++ b/all/guides/app-intsance/docs/EmbeddedScripts.md @@ -0,0 +1,4 @@ +SortOrder: 3 +# About the Embedded Script API + +Use this API to inject custom script tags to the head tag of your users' websites. From 0b722597d9893ce6fb010d10ae5c13e94d8f5164 Mon Sep 17 00:00:00 2001 From: Wixplorer Date: Sat, 13 Feb 2021 20:29:29 +0200 Subject: [PATCH 3/5] Auto commit from WixDocs server --- all/guides/app-intsance/docs/README.md | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 all/guides/app-intsance/docs/README.md diff --git a/all/guides/app-intsance/docs/README.md b/all/guides/app-intsance/docs/README.md new file mode 100644 index 0000000000..b8698e09af --- /dev/null +++ b/all/guides/app-intsance/docs/README.md @@ -0,0 +1,6 @@ +SortOrder: 0 +# About This API + +This API exposes basic data about the user's site and the app installed in it, as based on the user's authentication token. +When you provide the authentication token, you will receive identifying information for the user's site and the app instance parameters. +The primary identifier returned is the App Instance ID - the unique identifier of the app within the website. Using the App Instance ID, you can retrieve data about the site that installed the app (e.g., locale) and data about the app installed (e.g., current paid plan). From d0da7af69b9eb6d83d23a5db92a5b936ddd42363 Mon Sep 17 00:00:00 2001 From: Wixplorer Date: Sat, 13 Feb 2021 20:29:30 +0200 Subject: [PATCH 4/5] Auto commit from WixDocs server --- all/guides/app-intsance/docs/Billing.md | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 all/guides/app-intsance/docs/Billing.md diff --git a/all/guides/app-intsance/docs/Billing.md b/all/guides/app-intsance/docs/Billing.md new file mode 100644 index 0000000000..83b54ec5b8 --- /dev/null +++ b/all/guides/app-intsance/docs/Billing.md @@ -0,0 +1,6 @@ +SortOrder: 1 +# About The Wix Billing API + +This API enables your app to lead customers seamlessly into Wix's checkout process from your platform +(e.g., hosting your app's pricing page independently and redirecting to Wix checkout for purchase). +The returned checkout link is valid for 48 hours. Note: Use of this functionality is dependent on setup in the [Wix Developers Center](https://devforum.wix.com/en/article/setting-up-an-external-pricing-page). From 78e4623494c45c4d5b84614bceac6ab0fe9015a8 Mon Sep 17 00:00:00 2001 From: Wixplorer Date: Sat, 13 Feb 2021 20:29:31 +0200 Subject: [PATCH 5/5] Auto commit from WixDocs server --- all/guides/app-intsance/docs/BIEvents.md | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 all/guides/app-intsance/docs/BIEvents.md diff --git a/all/guides/app-intsance/docs/BIEvents.md b/all/guides/app-intsance/docs/BIEvents.md new file mode 100644 index 0000000000..05467c086b --- /dev/null +++ b/all/guides/app-intsance/docs/BIEvents.md @@ -0,0 +1,6 @@ +SortOrder: 2 +# About the BI Events API + +This API allows 3rd party apps connected to Wix, to send BI events to the Wix system. +It includes several out-of-the-box events, like when the app dashboard is loaded, or when a primary action is taken (the most valuable action in an app product flow). +If the list of built-in event does not suit your needs, you can also send a custom event.