{"_id":"@adobe/aio-lib-magento","_rev":"20-0d950c35e841317f58a4ccb3635a1a01","name":"@adobe/aio-lib-magento","dist-tags":{"latest":"0.0.1"},"versions":{"0.0.1":{"name":"@adobe/aio-lib-magento","version":"0.0.1","license":"Apache-2.0","_id":"@adobe/aio-lib-magento@0.0.1","maintainers":[{"name":"adobehalls","email":"halls@adobe.com"},{"name":"fullcolorcoder","email":"bradjohn@adobe.com"},{"name":"marbec","email":"mabecker@adobe.com"},{"name":"tripod","email":"tripod@bocanegra.ch"},{"name":"garthdb","email":"garthdb@gmail.com"},{"name":"lazd","email":"lazdnet@gmail.com"},{"name":"adobe-admin","email":"grp-opensourceoffice@adobe.com"},{"name":"patrickfulton","email":"patrickfulton@gmail.com"},{"name":"trieloff","email":"lars@trieloff.net"},{"name":"shazron","email":"shazron@gmail.com"},{"name":"krisnye","email":"krisnye@gmail.com"},{"name":"dcpfsdk","email":"dcpfsdk@adobe.com"},{"name":"natebaldwin","email":"natebaldwindesign@gmail.com"},{"name":"devongovett","email":"devongovett@gmail.com"},{"name":"aspro83","email":"danniintheus@gmail.com"},{"name":"symanovi","email":"symanovi@adobe.com"},{"name":"dpfister","email":"dominique.pfister@gmail.com"},{"name":"stefan-guggisberg","email":"sg@adobe.com"},{"name":"korra","email":"npmjs.karo@cupdev.net"},{"name":"rofe","email":"npm@rofe.com"},{"name":"kptdobe","email":"kptdobe@gmail.com"}],"homepage":"https://github.com/@adobe/aio-lib-magento","bugs":{"url":"https://github.com/@adobe/aio-lib-magento/issues"},"dist":{"shasum":"a2714dba3d10b484014e2e3c4f057a663dd78955","tarball":"https://registry.npmjs.org/@adobe/aio-lib-magento/-/aio-lib-magento-0.0.1.tgz","fileCount":38,"integrity":"sha512-c9HIvtJiNRth32sJKTjSu+0qWOKlvfOiybDOIkuFWP4JbslIjapaYo8n/BK7dieJJadXnlC4KS8XvzEGHkip0w==","signatures":[{"sig":"MEQCID/ZhgQ6IOuToU4KEAQRONd0TNWcWi+PZ6Szlro0ojD3AiB039fudQ0YexJnfnheePt1sAkCODv9ZmuD11gAK28W+Q==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":64136},"main":"src/index.js","engines":{"node":"^14.18 || ^16.13 || >=18"},"gitHead":"b6865665f7fcfa43fbacfaabd0e3dd48dc30f41d","scripts":{"e2e":"jest --config e2e/jest.config.js","lint":"eslint src test e2e","test":"npm run unit-tests","jsdoc":"jsdoc2md -t ./docs/readme_template.md src/**/*.js > README.md","pretest":"npm run validate && npm run lint","typings":"jsdoc -t node_modules/tsd-jsdoc/dist -r src/*.js -d .","validate":"node bin/validate_spec.js spec/api.json","unit-tests":"jest --config test/jest.config.js --maxWorkers=2","generate-docs":"npm run typings && npm run jsdoc"},"_npmUser":{"name":"adobe-admin","email":"grp-opensourceoffice@adobe.com"},"deprecated":false,"repository":{"url":"git+https://github.com/@adobe/aio-lib-magento.git","type":"git"},"_npmVersion":"8.19.4","description":"Adobe I/O Lib","directories":{},"_nodeVersion":"16.20.1","dependencies":{"cross-fetch":"^3.0.4","swagger-client":"3.9.6","@adobe/aio-lib-core-errors":"^3.0.0","@adobe/aio-lib-core-logging":"^1.1.2"},"_hasShrinkwrap":false,"devDependencies":{"eol":"^0.9.1","jest":"^25.1.0","jsdoc":"^3.6.3","dotenv":"^8.1.0","eslint":"^8.47.0","tsd-jsdoc":"^2.4.0","jest-junit":"^10.0.0","typescript":"^4.9.5","babel-runtime":"^6.26.0","stdout-stderr":"^0.1.9","jest-plugin-fs":"^2.9.0","eslint-plugin-n":"^16.0.1","jest-fetch-mock":"^3.0.1","@types/node-fetch":"^2.5.4","jsdoc-to-markdown":"^5.0.0","eslint-plugin-jest":"^27.2.3","eslint-plugin-node":"^11.1.0","eslint-plugin-jsdoc":"^42.0.0","eslint-plugin-import":"^2.28.0","eslint-plugin-promise":"^6.1.1","eslint-config-standard":"^17.1.0","eslint-plugin-standard":"^4.0.0","openapi-schema-validator":"^3.0.3","@adobe/eslint-config-aio-lib-config":"^2.0.1"},"bundleDependencies":[],"_npmOperationalInternal":{"tmp":"tmp/aio-lib-magento_0.0.1_1692076745966_0.1251534353477759","host":"s3://npm-registry-packages"}}},"time":{"created":"2023-08-15T05:19:05.815Z","modified":"2026-10-01T01:32:21.257Z","0.0.1":"2023-08-15T05:19:06.219Z"},"bugs":{"url":"https://github.com/@adobe/aio-lib-magento/issues"},"license":"Apache-2.0","homepage":"https://github.com/@adobe/aio-lib-magento","repository":{"url":"git+https://github.com/@adobe/aio-lib-magento.git","type":"git"},"description":"Adobe I/O Lib","maintainers":[{"email":"mabecker@adobe.com","name":"marbec"},{"email":"tripod@bocanegra.ch","name":"tripod"},{"email":"garthdb@gmail.com","name":"garthdb"},{"email":"lazdnet@gmail.com","name":"lazd"},{"email":"grp-opensourceoffice@adobe.com","name":"adobe-admin"},{"email":"patrickfulton@gmail.com","name":"patrickfulton"},{"email":"lars@trieloff.net","name":"trieloff"},{"email":"krisnye@gmail.com","name":"krisnye"},{"email":"dcpfsdk@adobe.com","name":"dcpfsdk"},{"email":"natebaldwindesign@gmail.com","name":"natebaldwin"},{"email":"devongovett@gmail.com","name":"devongovett"},{"email":"danniintheus@gmail.com","name":"aspro83"},{"email":"symanovi@adobe.com","name":"symanovi"},{"email":"dominique.pfister@gmail.com","name":"dpfister"},{"email":"sg@adobe.com","name":"stefan-guggisberg"},{"email":"npm@rofe.com","name":"rofe"},{"email":"kptdobe@gmail.com","name":"kptdobe"},{"email":"halls@adobe.com","name":"adobehalls"},{"email":"bradjohn@adobe.com","name":"fullcolorcoder"},{"email":"djaeggi@adobe.com","name":"djaeggi"},{"email":"dylandepass@gmail.com","name":"dylandepass"},{"email":"mhaack@adobe.com","name":"mhaack"},{"email":"amol@adobe.com","name":"amol-anand"},{"email":"stopp@adobe.com","name":"stopp-adobe"},{"email":"namarora@adobe.com","name":"namarora"},{"email":"doten@adobe.com","name":"doten"},{"email":"schmidt@adobe.com","name":"duh_schmidt"},{"email":"astha.bhargava23@gmail.com","name":"asthabh23"},{"email":"aljoseph@adobe.com","name":"aljoseph"},{"email":"zouhir.dahbi@outlook.com","name":"zdahbi"},{"email":"tuicu@adobe.com","name":"tuicu"},{"email":"fmeschbe@adobe.com","name":"fmeschbe"}],"readme":"\n\n[![Version](https://img.shields.io/npm/v/@adobe/aio-lib-magento.svg)](https://npmjs.org/package/@adobe/aio-lib-magento)\n[![Downloads/week](https://img.shields.io/npm/dw/@adobe/aio-lib-magento.svg)](https://npmjs.org/package/@adobe/aio-lib-magento)\n[![Build Status](https://travis-ci.com/adobe/aio-lib-magento.svg?branch=master)](https://travis-ci.com/adobe/aio-lib-magento)\n[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) \n[![Codecov Coverage](https://img.shields.io/codecov/c/github/adobe/aio-lib-magento/master.svg?style=flat-square)](https://codecov.io/gh/adobe/aio-lib-magento/)\n\n# Adobe Magento Lib\n\n### Installing\n\n```bash\n$ npm install @adobe/aio-lib-magento\n```\n\n### Usage\n1) Initialize the SDK\n\n```javascript\nconst sdk = require('@adobe/aio-lib-magento')\n\nasync function sdkTest() {\n //initialize sdk\n const client = await sdk.init('', 'x-api-key', '')\n}\n```\n\n2) Call methods using the initialized SDK\n\n```javascript\nconst sdk = require('@adobe/aio-lib-magento')\n\nasync function sdkTest() {\n // initialize sdk\n const client = await sdk.init('', 'x-api-key', '')\n\n // call methods\n try {\n // get profiles by custom filters\n const result = await client.getSomething({})\n console.log(result)\n\n } catch (e) {\n console.error(e)\n }\n}\n```\n\n## Classes\n\n
\n
MagentoCoreAPI
\n

This class provides methods to call your MagentoCoreAPI APIs.\nBefore calling any method initialize the instance by calling the init method on it\nwith valid values for tenantId, apiKey and accessToken

\n
\n
\n\n## Functions\n\n
\n
init(tenantId, apiKey, accessToken) ⇒ Promise.<MagentoCoreAPI>
\n

Returns a Promise that resolves with a new MagentoCoreAPI object.

\n
\n
\n\n## Typedefs\n\n
\n
MyParameters : object
\n

An example of a typed object.

\n
\n
AnotherThing : object
\n

Another typed object.

\n
\n
\n\n\n\n## MagentoCoreAPI\nThis class provides methods to call your MagentoCoreAPI APIs.\nBefore calling any method initialize the instance by calling the `init` method on it\nwith valid values for tenantId, apiKey and accessToken\n\n**Kind**: global class \n\n* [MagentoCoreAPI](#MagentoCoreAPI)\n * [.tenantId](#MagentoCoreAPI+tenantId) : string\n * [.apiKey](#MagentoCoreAPI+apiKey) : string\n * [.accessToken](#MagentoCoreAPI+accessToken) : string\n * [.init(tenantId, apiKey, accessToken)](#MagentoCoreAPI+init) ⇒ [Promise.<MagentoCoreAPI>](#MagentoCoreAPI)\n * [.getSomething([parameters])](#MagentoCoreAPI+getSomething) ⇒ Promise.<Response>\n\n\n\n### magentoCoreAPI.tenantId : string\nThe tenant id\n\n**Kind**: instance property of [MagentoCoreAPI](#MagentoCoreAPI) \n\n\n### magentoCoreAPI.apiKey : string\nThe api key from your integration\n\n**Kind**: instance property of [MagentoCoreAPI](#MagentoCoreAPI) \n\n\n### magentoCoreAPI.accessToken : string\nThe access token from your integration\n\n**Kind**: instance property of [MagentoCoreAPI](#MagentoCoreAPI) \n\n\n### magentoCoreAPI.init(tenantId, apiKey, accessToken) ⇒ [Promise.<MagentoCoreAPI>](#MagentoCoreAPI)\nInitializes a MagentoCoreAPI object and returns it.\n\n**Kind**: instance method of [MagentoCoreAPI](#MagentoCoreAPI) \n**Returns**: [Promise.<MagentoCoreAPI>](#MagentoCoreAPI) - a MagentoCoreAPI object \n\n| Param | Type | Description |\n| --- | --- | --- |\n| tenantId | string | the tenant id |\n| apiKey | string | the API key for your integration |\n| accessToken | string | the access token for your integration |\n\n\n\n### magentoCoreAPI.getSomething([parameters]) ⇒ Promise.<Response>\nGet something.\n\n**Kind**: instance method of [MagentoCoreAPI](#MagentoCoreAPI) \n**Returns**: Promise.<Response> - the response \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| [parameters] | [MyParameters](#MyParameters) | {} | parameters to pass |\n\n\n\n## init(tenantId, apiKey, accessToken) ⇒ [Promise.<MagentoCoreAPI>](#MagentoCoreAPI)\nReturns a Promise that resolves with a new MagentoCoreAPI object.\n\n**Kind**: global function \n**Returns**: [Promise.<MagentoCoreAPI>](#MagentoCoreAPI) - a Promise with a MagentoCoreAPI object \n\n| Param | Type | Description |\n| --- | --- | --- |\n| tenantId | string | the tenant id |\n| apiKey | string | the API key for your integration |\n| accessToken | string | the access token for your integration |\n\n\n\n## MyParameters : object\nAn example of a typed object.\n\n**Kind**: global typedef \n**Properties**\n\n| Name | Type | Description |\n| --- | --- | --- |\n| optionA | string | some option |\n| optionB | string | another option |\n\n\n\n## AnotherThing : object\nAnother typed object.\n\n**Kind**: global typedef \n**Properties**\n\n| Name | Type | Description |\n| --- | --- | --- |\n| mayBeSomething | boolean | an option |\n\n### Debug Logs\n\n```bash\nLOG_LEVEL=debug \n```\n\nPrepend the `LOG_LEVEL` environment variable and `debug` value to the call that invokes your function, on the command line. This should output a lot of debug data for your SDK calls.\n\n### Contributing\n\nContributions are welcome! Read the [Contributing Guide](./.github/CONTRIBUTING.md) for more information.\n\n### Licensing\n\nThis project is licensed under the Apache V2 License. See [LICENSE](LICENSE) for more information.\n","readmeFilename":"README.md"}