diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 464c1e9..ebd4d6c 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -1,8 +1,6 @@ -const { - description -} = require('../../package'); -require("dotenv").config({ - path: ".env.local" +const { description } = require('../../package'); +require('dotenv').config({ + path: '.env.local', }); // require('dotenv').config() const moment = require('moment'); @@ -15,7 +13,6 @@ console.log('Sidebar Guides: ', sidebar.guides()); // console.log('Sidebar: ', sidebar.bar()); module.exports = (ctx) => ({ - chainWebpack: (config) => { config.module .rule('yaml') @@ -26,62 +23,85 @@ module.exports = (ctx) => ({ .use('yaml-loader') .loader('yaml-loader'); }, - head: [ - ['link', { - rel: 'apple-touch-icon', - sizes: '180x180', - href: '/icons/apple-touch-icon.png' - }], - ['link', { - rel: 'icon', - type: 'image/png', - sizes: '32x32', - href: '/icons/favicon-32x32.png' - }], - ['link', { - rel: 'icon', - type: 'image/png', - sizes: '16x16', - href: '/icons/favicon-16x16.png' - }], + [ + 'link', + { + rel: 'apple-touch-icon', + sizes: '180x180', + href: '/icons/apple-touch-icon.png', + }, + ], + [ + 'link', + { + rel: 'icon', + type: 'image/png', + sizes: '32x32', + href: '/icons/favicon-32x32.png', + }, + ], + [ + 'link', + { + rel: 'icon', + type: 'image/png', + sizes: '16x16', + href: '/icons/favicon-16x16.png', + }, + ], // ['link', { // rel: 'manifest', // href: 'icons/site.webmanifest' // }], - ['link', { - rel: 'mask-icon', - href: '/icons/safari-pinned-tab.svg', - color: '#ff4731' - }], - ['link', { - rel: 'shortcut icon', - href: '/icons/favicon.ico' - }], - ['meta', { - name: 'msapplication-TileColor', - content: '#ff4731' - }], - ['meta', { - name: 'msapplication-config', - content: '/icons/browserconfig.xml' - }], - ['meta', { - name: 'theme-color', - content: '#ff4731' - }], - ['meta', { - name: 'viewport', - content: 'width=device-width, initial-scale=1' - }], + [ + 'link', + { + rel: 'mask-icon', + href: '/icons/safari-pinned-tab.svg', + color: '#ff4731', + }, + ], + [ + 'link', + { + rel: 'shortcut icon', + href: '/icons/favicon.ico', + }, + ], + [ + 'meta', + { + name: 'msapplication-TileColor', + content: '#ff4731', + }, + ], + [ + 'meta', + { + name: 'msapplication-config', + content: '/icons/browserconfig.xml', + }, + ], + [ + 'meta', + { + name: 'theme-color', + content: '#ff4731', + }, + ], + [ + 'meta', + { + name: 'viewport', + content: 'width=device-width, initial-scale=1', + }, + ], ], - extend: '@vuepress/theme-default', - // markdown: { // extractHeaders: ['h2', 'h3', 'h4'] // }, - /** * Ref：https://v1.vuepress.vuejs.org/config/#title */ @@ -90,7 +110,6 @@ module.exports = (ctx) => ({ * Ref：https://v1.vuepress.vuejs.org/config/#description */ description: description, - // base: '/docs/', /** * Theme configuration, here is the default theme configuration for VuePress. @@ -114,138 +133,7 @@ module.exports = (ctx) => ({ '/api/guides/': sidebar.guides(), '/': sidebar.support(), }, - // sidebar: { - // '/api/guides/': [{ - // title: 'Guides', // required - // collapsable: false, // optional, defaults to true - // sidebarDepth: 1, // optional, defaults to 1 - // children: [ - // ['/api/guides/', 'Overview'], - // { - // title: 'Quickstarts', // required - // collapsable: false, - // children: [ - // ['/api/guides/quickstarts/node', 'Node.js'], - // ['/api/guides/quickstarts/python', 'Python'], - // ], - // }, - // { - // title: 'Request and Send Payments', // required - // collapsable: false, - // children: [ - // ['/api/guides/payments/request', 'Request Payment'], - // ['/api/guides/payments/send', 'Send Payment'], - // ], - // }, - // ], - // }, ], - // '/api/reference/rest/': [{ - // title: 'REST Reference', // required - // collapsable: false, // optional, defaults to true - // sidebarDepth: 0, // optional, defaults to 1 - // children: [ - // ['/api/reference/rest/v1/', 'Resource Summary'] - // ], - // }, - // { - // title: 'REST Resources', // required - // collapsable: false, // optional, defaults to true - // sidebarDepth: 1, // optional, defaults to 1 - // // children: getApiSidebar(), - // children: [ - // get_sidebar_reference_merchant(), - // get_sidebar_reference_merchant_balance(), - // get_sidebar_reference_merchant_logo(), - // get_sidebar_reference_merchant_payment_request(), - // get_sidebar_reference_merchant_payment_request_outcome(), - // get_sidebar_reference_merchant_payment_send(), - // get_sidebar_reference_merchant_payment_send_outcome(), - // get_sidebar_reference_merchant_pos(), - // get_sidebar_reference_merchant_sales_summary(), - // get_sidebar_reference_merchant_settlement(), - // get_sidebar_reference_merchant_settlement_account(), - // get_sidebar_reference_merchant_settlement_latest(), - // get_sidebar_reference_merchant_settlement_report(), - // get_sidebar_reference_merchant_shortlink(), - // get_sidebar_reference_merchant_ssp_users(), - // get_sidebar_reference_merchant_statusCodes(), - // get_sidebar_reference_merchant_users(), - // get_sidebar_reference_oauth2(), - // get_sidebar_reference_oauth2_auth_code(), - // get_sidebar_reference_oauth2_auth_request(), - // get_sidebar_reference_oauth2_auth_token(), - // get_sidebar_reference_oauth2_error(), - // get_sidebar_reference_oauth2_qrImage(), - // get_sidebar_reference_oauth2_user_info(), - // get_sidebar_reference_users_permissions(), - // get_sidebar_reference_users_permissions_request(), - // get_sidebar_reference_users_permissions_request_outcome(), - // get_sidebar_reference_users_permissions_scope(), - // ], - // }, - // '/api/reference/rest/v1/types', - // // { - // // title: 'Resources', // required - // // collapsable: false, // optional, defaults to true - // // sidebarDepth: 1, // optional, defaults to 1 - // // children: getResourcesSidebar(), - // // }, - // ], - // '/api/support': [{ - // title: 'Support', // required - // collapsable: false, // optional, defaults to true - // sidebarDepth: 0, // optional, defaults to 1 - // children: [ - // // get_sidebar_support(), - // ['/api/support/', 'How to Get Help'], - // [ - // 'https://stackoverflow.com/questions/tagged/settle-api', - // 'Stack Overflow', - // ], - // [ - // 'https://stackoverflow.com/questions/tagged/settle-api', - // 'Issue Tracker', - // ], - // [ - // 'https://stackoverflow.com/questions/tagged/settle-api', - // 'Feature Request', - // ], - // ['/api/release-notes', 'Release Notes'], - // ['/api/terms', 'Terms of Service'], - // ], - // }, ], - // '/discovery': [{ - // title: 'API Discovery Service', // required - // collapsable: false, // optional, defaults to true - // sidebarDepth: 1, // optional, defaults to 1 - // children: [ - // get_sidebar_discovery_home(), - // get_sidebar_discovery_guides(), - // get_sidebar_discovery_reference(), - // ], - // }, ], - // '/': [{ - // title: 'Introduction', // required - // collapsable: false, // optional, defaults to true - // sidebarDepth: 2, // optional, defaults to 1 - // children: getIntroductionSidebar(), - // }, - // { - // title: 'Guides', // required - // collapsable: false, // optional, defaults to true - // sidebarDepth: 2, // optional, defaults to 1 - // children: getGuidesSidebar(), - // }, - // { - // title: 'Tutorials', // required - // collapsable: false, // optional, defaults to true - // sidebarDepth: 0, // optional, defaults to 1 - // children: getImpIntSidebar(), - // }, - // ], - // }, }, - /** * Apply plugins，ref：https://v1.vuepress.vuejs.org/zh/plugin/ */ @@ -324,4 +212,4 @@ module.exports = (ctx) => ({ // Plugins '.vuepress/plugins/getOpenAPI.js', ], -}); \ No newline at end of file +}); diff --git a/docs/.vuepress/nav/left/rest/v1/reference/merchant.js b/docs/.vuepress/nav/left/rest/v1/reference/merchant.js index eebeafe..d0a2e0c 100644 --- a/docs/.vuepress/nav/left/rest/v1/reference/merchant.js +++ b/docs/.vuepress/nav/left/rest/v1/reference/merchant.js @@ -1,250 +1,265 @@ +function merchant_apiKeys() { + return { + title: 'merchant.apiKeys', // required + collapsable: true, + sidebarDepth: 0, + children: [ + ['/api/reference/rest/v1/merchant.apiKeys/', 'Overview'], + ['/api/reference/rest/v1/merchant.apiKeys/create', 'create'], + ['/api/reference/rest/v1/merchant.apiKeys/get', 'get'], + ['/api/reference/rest/v1/merchant.apiKeys/update', 'update'], + ['/api/reference/rest/v1/merchant.apiKeys/delete', 'delete'], + ], + }; +} + function merchant_balance() { - return { - title: 'merchant.balance', // required - collapsable: true, - sidebarDepth: 0, - children: [ - ['/api/reference/rest/v1/merchant.balance/', 'Overview'], - ['/api/reference/rest/v1/merchant.balance/get', 'get'], - ], - }; + return { + title: 'merchant.balance', // required + collapsable: true, + sidebarDepth: 0, + children: [ + ['/api/reference/rest/v1/merchant.balance/', 'Overview'], + ['/api/reference/rest/v1/merchant.balance/get', 'get'], + ], + }; } function merchant_logo() { - return { - title: 'merchant.logo', // required - // path: '/api/reference/rest/v1/merchant.logo.paymentRequest/', - collapsable: true, - sidebarDepth: 0, - children: [ - ['/api/reference/rest/v1/merchant.logo/', 'Overview'], - ['/api/reference/rest/v1/merchant.logo/get', 'get'], - ], - }; + return { + title: 'merchant.logo', // required + // path: '/api/reference/rest/v1/merchant.logo.paymentRequest/', + collapsable: true, + sidebarDepth: 0, + children: [ + ['/api/reference/rest/v1/merchant.logo/', 'Overview'], + ['/api/reference/rest/v1/merchant.logo/get', 'get'], + ], + }; } function merchant_payment_request() { - return { - title: 'merchant.payment.request', // required - // path: '/api/reference/rest/v1/merchant.paymentRequest/', - collapsable: true, - sidebarDepth: 0, - children: [ - ['/api/reference/rest/v1/merchant.payment.request/', 'Overview'], - ['/api/reference/rest/v1/merchant.payment.request/create', 'create'], - ['/api/reference/rest/v1/merchant.payment.request/list', 'list'], - ['/api/reference/rest/v1/merchant.payment.request/update', 'update'], - ['/api/reference/rest/v1/merchant.payment.request/get', 'get'], - // ['/api/reference/rest/v1/merchant.paymentRequest/getOutcome', 'getOutcome'], - ], - }; + return { + title: 'merchant.payment.request', // required + // path: '/api/reference/rest/v1/merchant.paymentRequest/', + collapsable: true, + sidebarDepth: 0, + children: [ + ['/api/reference/rest/v1/merchant.payment.request/', 'Overview'], + ['/api/reference/rest/v1/merchant.payment.request/create', 'create'], + ['/api/reference/rest/v1/merchant.payment.request/list', 'list'], + ['/api/reference/rest/v1/merchant.payment.request/update', 'update'], + ['/api/reference/rest/v1/merchant.payment.request/get', 'get'], + // ['/api/reference/rest/v1/merchant.paymentRequest/getOutcome', 'getOutcome'], + ], + }; } - function merchant_payment_request_outcome() { - return { - title: 'merchant.payment.request.outcome', // required - // path: '/api/reference/rest/v1/merchant.paymentRequest/', - collapsable: true, - sidebarDepth: 0, - children: [ - ['/api/reference/rest/v1/merchant.payment.request.outcome/', 'Overview'], - ['/api/reference/rest/v1/merchant.payment.request.outcome/get', 'get'], - ], - }; + return { + title: 'merchant.payment.request.outcome', // required + // path: '/api/reference/rest/v1/merchant.paymentRequest/', + collapsable: true, + sidebarDepth: 0, + children: [ + ['/api/reference/rest/v1/merchant.payment.request.outcome/', 'Overview'], + ['/api/reference/rest/v1/merchant.payment.request.outcome/get', 'get'], + ], + }; } function merchant_payment_send() { - return { - title: 'merchant.payment.send', // required - // path: '/api/reference/rest/v1/merchant.paymentsend/', - collapsable: true, - sidebarDepth: 0, - children: [ - ['/api/reference/rest/v1/merchant.payment.send/', 'Overview'], - ['/api/reference/rest/v1/merchant.payment.send/create', 'create'], - ], - }; + return { + title: 'merchant.payment.send', // required + // path: '/api/reference/rest/v1/merchant.paymentsend/', + collapsable: true, + sidebarDepth: 0, + children: [ + ['/api/reference/rest/v1/merchant.payment.send/', 'Overview'], + ['/api/reference/rest/v1/merchant.payment.send/create', 'create'], + ], + }; } function merchant_payment_send_outcome() { - return { - title: 'merchant.payment.send.outcome', // required - // path: '/api/reference/rest/v1/merchant.paymentsend/', - collapsable: true, - sidebarDepth: 0, - children: [ - ['/api/reference/rest/v1/merchant.payment.send.outcome/', 'Overview'], - ['/api/reference/rest/v1/merchant.payment.send.outcome/get', 'get'], - ], - }; + return { + title: 'merchant.payment.send.outcome', // required + // path: '/api/reference/rest/v1/merchant.paymentsend/', + collapsable: true, + sidebarDepth: 0, + children: [ + ['/api/reference/rest/v1/merchant.payment.send.outcome/', 'Overview'], + ['/api/reference/rest/v1/merchant.payment.send.outcome/get', 'get'], + ], + }; } function merchant_pos() { - return { - title: 'merchant.pos', // required - collapsable: true, - sidebarDepth: 0, - children: [ - ['/api/reference/rest/v1/merchant.pos/', 'Overview'], - ['/api/reference/rest/v1/merchant.pos/create', 'create'], - ['/api/reference/rest/v1/merchant.pos/list', 'list'], - ['/api/reference/rest/v1/merchant.pos/get', 'get'], - ['/api/reference/rest/v1/merchant.pos/update', 'update'], - ['/api/reference/rest/v1/merchant.pos/delete', 'delete'], - ], - }; + return { + title: 'merchant.pos', // required + collapsable: true, + sidebarDepth: 0, + children: [ + ['/api/reference/rest/v1/merchant.pos/', 'Overview'], + ['/api/reference/rest/v1/merchant.pos/create', 'create'], + ['/api/reference/rest/v1/merchant.pos/list', 'list'], + ['/api/reference/rest/v1/merchant.pos/get', 'get'], + ['/api/reference/rest/v1/merchant.pos/update', 'update'], + ['/api/reference/rest/v1/merchant.pos/delete', 'delete'], + ], + }; } function merchant_profile() { - return { - title: 'merchant.profile', // required - // path: '/api/reference/rest/v1/merchant.paymentRequest/', - collapsable: true, - sidebarDepth: 0, - children: [ - ['/api/reference/rest/v1/merchant.profile/', 'Overview'], - ['/api/reference/rest/v1/merchant.profile/get', 'get'], - ['/api/reference/rest/v1/merchant.profile/lookup', 'lookup'], - ], - } + return { + title: 'merchant.profile', // required + // path: '/api/reference/rest/v1/merchant.paymentRequest/', + collapsable: true, + sidebarDepth: 0, + children: [ + ['/api/reference/rest/v1/merchant.profile/', 'Overview'], + ['/api/reference/rest/v1/merchant.profile/get', 'get'], + ['/api/reference/rest/v1/merchant.profile/lookup', 'lookup'], + ], + }; } function merchant_sales_summary() { - return { - title: 'merchant.sales.summary', // required - collapsable: true, - sidebarDepth: 0, - children: [ - ['/api/reference/rest/v1/merchant.sales.summary/', 'Overview'], - ['/api/reference/rest/v1/merchant.sales.summary/get', 'get'], - ], - }; + return { + title: 'merchant.sales.summary', // required + collapsable: true, + sidebarDepth: 0, + children: [ + ['/api/reference/rest/v1/merchant.sales.summary/', 'Overview'], + ['/api/reference/rest/v1/merchant.sales.summary/get', 'get'], + ], + }; } function merchant_settlement() { - return { - title: 'merchant.settlement', // required - collapsable: true, - sidebarDepth: 0, - children: [ - ['/api/reference/rest/v1/merchant.settlement/', 'Overview'], - ['/api/reference/rest/v1/merchant.settlement/get', 'get'], - ], - }; + return { + title: 'merchant.settlement', // required + collapsable: true, + sidebarDepth: 0, + children: [ + ['/api/reference/rest/v1/merchant.settlement/', 'Overview'], + ['/api/reference/rest/v1/merchant.settlement/get', 'get'], + ], + }; } function merchant_settlement_account() { - return { - title: 'merchant.settlement.account', // required - collapsable: true, - sidebarDepth: 0, - children: [ - ['/api/reference/rest/v1/merchant.settlement.account/', 'Overview'], - ['/api/reference/rest/v1/merchant.settlement.account/get', 'get'], - ['/api/reference/rest/v1/merchant.settlement.account/update', 'update'], - ], - }; + return { + title: 'merchant.settlement.account', // required + collapsable: true, + sidebarDepth: 0, + children: [ + ['/api/reference/rest/v1/merchant.settlement.account/', 'Overview'], + ['/api/reference/rest/v1/merchant.settlement.account/get', 'get'], + ['/api/reference/rest/v1/merchant.settlement.account/update', 'update'], + ], + }; } function merchant_settlement_latest() { - return { - title: 'merchant.settlement.latest', // required - collapsable: true, - sidebarDepth: 0, - children: [ - ['/api/reference/rest/v1/merchant.settlement.latest/', 'Overview'], - ['/api/reference/rest/v1/merchant.settlement.latest/get', 'get'], - ], - }; + return { + title: 'merchant.settlement.latest', // required + collapsable: true, + sidebarDepth: 0, + children: [ + ['/api/reference/rest/v1/merchant.settlement.latest/', 'Overview'], + ['/api/reference/rest/v1/merchant.settlement.latest/get', 'get'], + ], + }; } function merchant_settlement_report() { - return { - title: 'merchant.settlement.report', // required - collapsable: true, - sidebarDepth: 0, - children: [ - ['/api/reference/rest/v1/merchant.settlement.report/', 'Overview'], - ['/api/reference/rest/v1/merchant.settlement.report/get', 'get'], - ], - }; + return { + title: 'merchant.settlement.report', // required + collapsable: true, + sidebarDepth: 0, + children: [ + ['/api/reference/rest/v1/merchant.settlement.report/', 'Overview'], + ['/api/reference/rest/v1/merchant.settlement.report/get', 'get'], + ], + }; } function merchant_shortlink() { - return { - title: 'merchant.shortlink', // required - collapsable: true, - sidebarDepth: 0, - children: [ - ['/api/reference/rest/v1/merchant.shortlink/', 'Overview'], - ['/api/reference/rest/v1/merchant.shortlink/create', 'create'], - ['/api/reference/rest/v1/merchant.shortlink/list', 'list'], - ['/api/reference/rest/v1/merchant.shortlink/get', 'get'], - ['/api/reference/rest/v1/merchant.shortlink/update', 'update'], - ['/api/reference/rest/v1/merchant.shortlink/delete', 'delete'], - ], - }; + return { + title: 'merchant.shortlink', // required + collapsable: true, + sidebarDepth: 0, + children: [ + ['/api/reference/rest/v1/merchant.shortlink/', 'Overview'], + ['/api/reference/rest/v1/merchant.shortlink/create', 'create'], + ['/api/reference/rest/v1/merchant.shortlink/list', 'list'], + ['/api/reference/rest/v1/merchant.shortlink/get', 'get'], + ['/api/reference/rest/v1/merchant.shortlink/update', 'update'], + ['/api/reference/rest/v1/merchant.shortlink/delete', 'delete'], + ], + }; } function merchant_ssp_users() { - return { - title: 'merchant.ssp.users', // required - collapsable: true, - sidebarDepth: 0, - children: [ - ['/api/reference/rest/v1/merchant.ssp.users/', 'Overview'], - ['/api/reference/rest/v1/merchant.ssp.users/create', 'create'], - ['/api/reference/rest/v1/merchant.ssp.users/get', 'get'], - ['/api/reference/rest/v1/merchant.ssp.users/delete', 'delete'], - ], - }; + return { + title: 'merchant.ssp.users', // required + collapsable: true, + sidebarDepth: 0, + children: [ + ['/api/reference/rest/v1/merchant.ssp.users/', 'Overview'], + ['/api/reference/rest/v1/merchant.ssp.users/create', 'create'], + ['/api/reference/rest/v1/merchant.ssp.users/get', 'get'], + ['/api/reference/rest/v1/merchant.ssp.users/delete', 'delete'], + ], + }; } function merchant_statusCodes() { - return { - title: 'merchant.statusCodes', // required - collapsable: true, - sidebarDepth: 0, - children: [ - ['/api/reference/rest/v1/merchant.statusCodes/', 'Overview'], - ['/api/reference/rest/v1/merchant.statusCodes/list', 'list'], - ['/api/reference/rest/v1/merchant.statusCodes/get', 'get'], - ], - }; + return { + title: 'merchant.statusCodes', // required + collapsable: true, + sidebarDepth: 0, + children: [ + ['/api/reference/rest/v1/merchant.statusCodes/', 'Overview'], + ['/api/reference/rest/v1/merchant.statusCodes/list', 'list'], + ['/api/reference/rest/v1/merchant.statusCodes/get', 'get'], + ], + }; } function merchant_users() { - return { - title: 'merchant.users', // required - collapsable: true, - sidebarDepth: 0, - children: [ - ['/api/reference/rest/v1/merchant.users/', 'Overview'], - ['/api/reference/rest/v1/merchant.users/create', 'create'], - ['/api/reference/rest/v1/merchant.users/get', 'get'], - ['/api/reference/rest/v1/merchant.users/update', 'update'], - ['/api/reference/rest/v1/merchant.users/delete', 'delete'], - ], - }; + return { + title: 'merchant.users', // required + collapsable: true, + sidebarDepth: 0, + children: [ + ['/api/reference/rest/v1/merchant.users/', 'Overview'], + ['/api/reference/rest/v1/merchant.users/create', 'create'], + ['/api/reference/rest/v1/merchant.users/get', 'get'], + ['/api/reference/rest/v1/merchant.users/update', 'update'], + ['/api/reference/rest/v1/merchant.users/delete', 'delete'], + ], + }; } module.exports = { - merchant_balance: merchant_balance(), - merchant_logo: merchant_logo(), - merchant_payment_request: merchant_payment_request(), - merchant_payment_request_outcome: merchant_payment_request_outcome(), - merchant_payment_send: merchant_payment_send(), - merchant_payment_send_outcome: merchant_payment_send_outcome(), - merchant_pos: merchant_pos(), - merchant_profile: merchant_profile(), - merchant_sales_summary: merchant_sales_summary(), - merchant_settlement: merchant_settlement(), - merchant_settlement_account: merchant_settlement_account(), - merchant_settlement_latest: merchant_settlement_latest(), - merchant_settlement_report: merchant_settlement_report(), - merchant_shortlink: merchant_shortlink(), - merchant_ssp_users: merchant_ssp_users(), - merchant_statusCodes: merchant_statusCodes(), - merchant_users: merchant_users(), -}; \ No newline at end of file + merchant_apiKeys: merchant_apiKeys(), + merchant_balance: merchant_balance(), + merchant_logo: merchant_logo(), + merchant_payment_request: merchant_payment_request(), + merchant_payment_request_outcome: merchant_payment_request_outcome(), + merchant_payment_send: merchant_payment_send(), + merchant_payment_send_outcome: merchant_payment_send_outcome(), + merchant_pos: merchant_pos(), + merchant_profile: merchant_profile(), + merchant_sales_summary: merchant_sales_summary(), + merchant_settlement: merchant_settlement(), + merchant_settlement_account: merchant_settlement_account(), + merchant_settlement_latest: merchant_settlement_latest(), + merchant_settlement_report: merchant_settlement_report(), + merchant_shortlink: merchant_shortlink(), + merchant_ssp_users: merchant_ssp_users(), + merchant_statusCodes: merchant_statusCodes(), + merchant_users: merchant_users(), +}; diff --git a/docs/.vuepress/nav/left/rest/v1/resources.js b/docs/.vuepress/nav/left/rest/v1/resources.js index 98bcc17..4916b29 100644 --- a/docs/.vuepress/nav/left/rest/v1/resources.js +++ b/docs/.vuepress/nav/left/rest/v1/resources.js @@ -1,122 +1,121 @@ // Import Merchant menus const { - merchant_balance, - merchant_logo, - merchant_payment_request, - merchant_payment_request_outcome, - merchant_payment_send, - merchant_payment_send_outcome, - merchant_pos, - merchant_profile, - merchant_sales_summary, - merchant_settlement, - merchant_settlement_account, - merchant_settlement_latest, - merchant_settlement_report, - merchant_shortlink, - merchant_ssp_users, - merchant_statusCodes, - merchant_users, + merchant_apiKeys, + merchant_balance, + merchant_logo, + merchant_payment_request, + merchant_payment_request_outcome, + merchant_payment_send, + merchant_payment_send_outcome, + merchant_pos, + merchant_profile, + merchant_sales_summary, + merchant_settlement, + merchant_settlement_account, + merchant_settlement_latest, + merchant_settlement_report, + merchant_shortlink, + merchant_ssp_users, + merchant_statusCodes, + // merchant_users, } = require('./reference/merchant.js'); // Import OAuth2 menus const { - // oauth2, - oauth2_auth_code, - oauth2_auth_request, - oauth2_auth_token, - oauth2_error, - oauth2_qrImage, - oauth2_user_info, + // oauth2, + oauth2_auth_code, + oauth2_auth_request, + oauth2_auth_token, + oauth2_error, + oauth2_qrImage, + oauth2_user_info, } = require('./reference/oauth2.js'); // Import Users menus const { - users_permissions, - users_permissions_request, - users_permissions_request_outcome, - users_permissions_scope, + users_permissions, + users_permissions_request, + users_permissions_request_outcome, + users_permissions_scope, } = require('./reference/users.js'); - // Define Merchant Group function merchantGroup() { - return { - title: 'Merchant', // required - collapsable: false, - sidebarDepth: 0, - children: [ - merchant_balance, - merchant_logo, - merchant_payment_request, - merchant_payment_request_outcome, - merchant_payment_send, - merchant_payment_send_outcome, - merchant_pos, - merchant_profile, - merchant_sales_summary, - merchant_settlement, - merchant_settlement_account, - merchant_settlement_latest, - merchant_settlement_report, - merchant_shortlink, - merchant_ssp_users, - merchant_statusCodes, - merchant_users, - ], - initialOpenGroupIndex: -1 - } + return { + title: 'Merchant', // required + collapsable: false, + sidebarDepth: 0, + children: [ + merchant_apiKeys, + merchant_balance, + merchant_logo, + merchant_payment_request, + merchant_payment_request_outcome, + merchant_payment_send, + merchant_payment_send_outcome, + merchant_pos, + merchant_profile, + merchant_sales_summary, + merchant_settlement, + merchant_settlement_account, + merchant_settlement_latest, + merchant_settlement_report, + merchant_shortlink, + // merchant_ssp_users, + merchant_statusCodes, + // merchant_users, + ], + initialOpenGroupIndex: -1, + }; } // Define OAuth2 Group function OAuth2Group() { - return { - title: 'OAuth2', // required - collapsable: false, - sidebarDepth: 0, - children: [ - // oauth2, - oauth2_auth_code, - oauth2_auth_request, - oauth2_auth_token, - oauth2_error, - oauth2_qrImage, - oauth2_user_info, - ], - initialOpenGroupIndex: -1 - } + return { + title: 'OAuth2', // required + collapsable: false, + sidebarDepth: 0, + children: [ + // oauth2, + oauth2_auth_code, + oauth2_auth_request, + oauth2_auth_token, + oauth2_error, + oauth2_qrImage, + oauth2_user_info, + ], + initialOpenGroupIndex: -1, + }; } // Define Permission Request Group function permissionRequestGroup() { - return { - title: 'Permission Requests', // required - collapsable: false, - sidebarDepth: 0, - children: [ - users_permissions, - users_permissions_request, - users_permissions_request_outcome, - users_permissions_scope, - ], - initialOpenGroupIndex: -1 - } + return { + title: 'Permission Requests', // required + collapsable: false, + sidebarDepth: 0, + children: [ + users_permissions, + users_permissions_request, + users_permissions_request_outcome, + users_permissions_scope, + ], + initialOpenGroupIndex: -1, + }; } - // Merge sidebar-groups together const sidebars = [ - // Merchant Group - merchantGroup(), - // OAuth2 Group - OAuth2Group(), - // Users - permissionRequestGroup() -] - + // Merchant Group + merchantGroup(), + // OAuth2 Group + OAuth2Group(), + // Users + permissionRequestGroup(), +]; module.exports = { - title: 'REST Resources', // required - collapsable: false, // optional, defaults to true - children: sidebars, -} \ No newline at end of file + title: 'REST Resources', // required + collapsable: false, // optional, defaults to true + children: sidebars, +}; diff --git a/docs/.vuepress/plugins/getResource.js b/docs/.vuepress/plugins/getResource.js index 5775da9..39677e7 100644 --- a/docs/.vuepress/plugins/getResource.js +++ b/docs/.vuepress/plugins/getResource.js @@ -1,90 +1,84 @@ module.exports = () => ({ - async extendPageData($page) { - const listContent = require('list-github-dir-content'); - const axios = require('axios'); - const _ = require('lodash'); - - const yaml = require('js-yaml'); - - const myToken = process.env.GITHUB_TOKEN; - - let endpoints = []; - let fileNames = []; - let api = { - merchant: null, - oauth2: null, - users: null, - }; - - // let page = $page; - let page = $page; - - const modelDirectoryFiles = await listContent.viaContentsApi({ - user: 'SettleAPI', - repository: 'settle-api-description', - directory: 'reference', - token: myToken, - }); - - _.filter(modelDirectoryFiles, function (r) { - // console.log(r); - - // let fileName = r.split('reference/')[1]; - let fileName = r.split('reference/')[1]; - - fileNames.push(fileName); - }); - - _.filter(fileNames, function (file) { - let apiName = file.split('.')[0]; - // console.log(apiName); - - axios - .get( - 'https://raw.githubusercontent.com/SettleAPI/settle-api-description/main/reference/' + - file - ) - .then(function (bender) { - let bendersBigScore = yaml.load(bender.data, { - encoding: 'utf-8', - }); - - _.filter(bendersBigScore.components.schemas, function (fry) { - - if (fry.properties) { - _.filter(fry.properties, function (props) { - // console.log(props); - if (props.$ref) { - let $ref = props.$ref.split('../models/')[1].split('.')[0]; - props.$ref = $ref; - // console.log($ref); - } - }); - } - - if (fry.required) { - _.filter(fry.required, function (req) { - _.filter(fry.properties, function (prop, amy) { - if (req === amy) { - prop.required = true; - // console.log(amy, prop); - } - }); - }); - } - - }); - - api[apiName] = bendersBigScore; - }) - .catch(function (error) { - // handle error - console.log(error); - }) - .then(function () { - page.reference = api; + async extendPageData($page) { + const listContent = require('list-github-dir-content'); + const axios = require('axios'); + const _ = require('lodash'); + + const yaml = require('js-yaml'); + + const myToken = process.env.GITHUB_TOKEN; + + let endpoints = []; + let fileNames = []; + let api = { + merchant: null, + oauth2: null, + users: null, + }; + + // let page = $page; + let page = $page; + + const modelDirectoryFiles = await listContent.viaContentsApi({ + user: 'SettleAPI', + repository: 'settle-api-description', + directory: 'reference', + token: myToken, + }); + + _.filter(modelDirectoryFiles, function(r) { + // console.log(r); + + // let fileName = r.split('reference/')[1]; + let fileName = r.split('reference/')[1]; + + fileNames.push(fileName); + }); + + _.filter(fileNames, function(file) { + let apiName = file.split('.')[0]; + // console.log(apiName); + + axios + .get('https://raw.githubusercontent.com/SettleAPI/settle-api-description/main/reference/' + file) + .then(function(bender) { + let bendersBigScore = yaml.load(bender.data, { + encoding: 'utf-8', + }); + + _.filter(bendersBigScore.components.schemas, function(fry) { + if (fry.properties) { + _.filter(fry.properties, function(props) { + // console.log(props); + if (props.$ref) { + let $ref = props.$ref.split('../models/')[1].split('.')[0]; + props.$ref = $ref; + // console.log($ref); + } + }); + } + + if (fry.required) { + _.filter(fry.required, function(req) { + _.filter(fry.properties, function(prop, amy) { + if (req === amy) { + prop.required = true; + // console.log(amy, prop); + } }); + }); + } + }); + + api[apiName] = bendersBigScore; + }) + .catch(function(error) { + // handle error + console.log(error); + }) + .then(function() { + page.reference = api; }); - - }, -}); \ No newline at end of file + }); + }, +}); diff --git a/docs/.vuepress/styles/index.styl b/docs/.vuepress/styles/index.styl index d297b7a..40a4c78 100644 --- a/docs/.vuepress/styles/index.styl +++ b/docs/.vuepress/styles/index.styl @@ -178,7 +178,7 @@ table background-color: #E07166; .md-api_reference_request_heading - font-size: 1.65rem; + font-size: 1.55rem; font-weight: 600; line-height: 1.25; // margin-block-start: 3.33em; diff --git a/docs/.vuepress/theme/components/PageReference.vue b/docs/.vuepress/theme/components/PageReference.vue index 17142ee..af5ac9c 100644 --- a/docs/.vuepress/theme/components/PageReference.vue +++ b/docs/.vuepress/theme/components/PageReference.vue @@ -71,7 +71,11 @@
-
+

-

-

+

# Schema

@@ -139,6 +140,23 @@

{{ type.description }}

+
+