{"_id":"@alwaysonmobile/hullojs","name":"@alwaysonmobile/hullojs","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@alwaysonmobile/hullojs","version":"1.0.0","description":"Welcome to the hullo API.    With this API you can perform operations on your hullo account programmatically that you can call using the hullo console. The operations currently available include:    * Add / Update a member * Get the details of a member * ","license":"Unlicense","main":"dist/index.js","scripts":{"build":"babel src -d dist","prepare":"npm run build","test":"mocha --require @babel/register --recursive"},"browser":{"fs":false},"dependencies":{"@babel/cli":"^7.0.0","superagent":"^5.3.0"},"devDependencies":{"@babel/core":"^7.0.0","@babel/plugin-proposal-class-properties":"^7.0.0","@babel/plugin-proposal-decorators":"^7.0.0","@babel/plugin-proposal-do-expressions":"^7.0.0","@babel/plugin-proposal-export-default-from":"^7.0.0","@babel/plugin-proposal-export-namespace-from":"^7.0.0","@babel/plugin-proposal-function-bind":"^7.0.0","@babel/plugin-proposal-function-sent":"^7.0.0","@babel/plugin-proposal-json-strings":"^7.0.0","@babel/plugin-proposal-logical-assignment-operators":"^7.0.0","@babel/plugin-proposal-nullish-coalescing-operator":"^7.0.0","@babel/plugin-proposal-numeric-separator":"^7.0.0","@babel/plugin-proposal-optional-chaining":"^7.0.0","@babel/plugin-proposal-pipeline-operator":"^7.0.0","@babel/plugin-proposal-throw-expressions":"^7.0.0","@babel/plugin-syntax-dynamic-import":"^7.0.0","@babel/plugin-syntax-import-meta":"^7.0.0","@babel/preset-env":"^7.0.0","@babel/register":"^7.0.0","expect.js":"^0.3.1","mocha":"^8.0.1","sinon":"^7.2.0"},"_id":"@alwaysonmobile/hullojs@1.0.0","gitHead":"d44ea7d5857fbe3a94b902b7b8541c27f1d3f484","_nodeVersion":"20.11.0","_npmVersion":"10.2.4","dist":{"integrity":"sha512-c2vOzW2tlymAW1eJdx3jnINpfcPwBnspBxqv1gvOZt5LX07W30d40uIJSL7X6jAzhD3uz+/O5qUI4WDj6txf0A==","shasum":"382601f25e175ef84b7da2b7137a77744ca52f73","tarball":"https://registry.npmjs.org/@alwaysonmobile/hullojs/-/hullojs-1.0.0.tgz","fileCount":16,"unpackedSize":121025,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDJa1QKAZI7Biu3m7emGTgWl6rVNVUaSTQvffXpJFNlmwIhAJ2Pg6/bUvyZfXnQE8At/wRBpetv/FU0BKnEDYlIRHHE"}]},"_npmUser":{"name":"aomdeveloper","email":"dev@alwaysonmobile.io"},"directories":{},"maintainers":[{"name":"aomdeveloper","email":"dev@alwaysonmobile.io"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/hullojs_1.0.0_1714572951773_0.86548418758515"},"_hasShrinkwrap":false}},"time":{"created":"2024-05-01T14:15:51.666Z","1.0.0":"2024-05-01T14:15:51.923Z","modified":"2024-05-01T14:15:52.232Z"},"maintainers":[{"name":"aomdeveloper","email":"dev@alwaysonmobile.io"}],"description":"Welcome to the hullo API.    With this API you can perform operations on your hullo account programmatically that you can call using the hullo console. The operations currently available include:    * Add / Update a member * Get the details of a member * ","license":"Unlicense","readme":"# @alwaysonmobile/hullojs\n\nhullojs - JavaScript client for @alwaysonmobile/hullojs\nWelcome to the hullo API.  \n\nWith this API you can perform operations on your hullo account programmatically that you can call using the hullo\nconsole. The operations currently available include:  \n\n* Add / Update a member\n* Get the details of a member\n* Get the messages sent / received from a member\n* Send a message to a member\n\nThe hullo API is an easy to use RESTful API that can be called by any modern programming language that \nsupports HTTP calls, and also has out of the box support for several programming languages including:  \n* Java\n* Javascript  \n\nIn order to use the API you will first need to generate an API key using the hullo console application, assigning\nit the the relevant scopes required for the operations you wish to call.\n\nThis SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 1.0.0\n- Package version: 1.0.0\n- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen\n\n## Installation\n\n### For [Node.js](https://nodejs.org/)\n\n#### npm\n\nTo publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in [\"Publishing npm packages\"](https://docs.npmjs.com/getting-started/publishing-npm-packages).\n\nThen install it via:\n\n```shell\nnpm install @alwaysonmobile/hullojs --save\n```\n\nFinally, you need to build the module:\n\n```shell\nnpm run build\n```\n\n##### Local development\n\nTo use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing `package.json` (and this README). Let's call this `JAVASCRIPT_CLIENT_DIR`. Then run:\n\n```shell\nnpm install\n```\n\nNext, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`:\n\n```shell\nnpm link\n```\n\nTo use the link you just defined in your project, switch to the directory you want to use your @alwaysonmobile/hullojs from, and run:\n\n```shell\nnpm link /path/to/<JAVASCRIPT_CLIENT_DIR>\n```\n\nFinally, you need to build the module:\n\n```shell\nnpm run build\n```\n\n#### git\n\nIf the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID\nthen install it via:\n\n```shell\n    npm install GIT_USER_ID/GIT_REPO_ID --save\n```\n\n### For browser\n\nThe library also works in the browser environment via npm and [browserify](http://browserify.org/). After following\nthe above steps with Node.js and installing browserify with `npm install -g browserify`,\nperform the following (assuming *main.js* is your entry file):\n\n```shell\nbrowserify main.js > bundle.js\n```\n\nThen include *bundle.js* in the HTML pages.\n\n### Webpack Configuration\n\nUsing Webpack you may encounter the following error: \"Module not found: Error:\nCannot resolve module\", most certainly you should disable AMD loader. Add/merge\nthe following section to your webpack config:\n\n```javascript\nmodule: {\n  rules: [\n    {\n      parser: {\n        amd: false\n      }\n    }\n  ]\n}\n```\n\n## Getting Started\n\nPlease follow the [installation](#installation) instruction and execute the following JS code:\n\n```javascript\nvar hullojs = require('@alwaysonmobile/hullojs');\n\nvar defaultClient = hullojs.ApiClient.instance;\n// Configure API key authorization: ApiKeyAuth\nvar ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];\nApiKeyAuth.apiKey = \"YOUR API KEY\"\n// Uncomment the following line to set a prefix for the API key, e.g. \"Token\" (defaults to null)\n//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = \"Token\"\n\nvar api = new hullojs.AccountApi()\nvar callback = function(error, data, response) {\n  if (error) {\n    console.error(error);\n  } else {\n    console.log('API called successfully. Returned data: ' + data);\n  }\n};\napi.getAccount(callback);\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://app.hullo.me/api*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*hullojs.AccountApi* | [**getAccount**](docs/AccountApi.md#getAccount) | **GET** /endpoints/account | Get details about the account\n*hullojs.AttributesApi* | [**getAttributes**](docs/AttributesApi.md#getAttributes) | **GET** /endpoints/attributes | Gets the list of attributes\n*hullojs.MembersApi* | [**getMember**](docs/MembersApi.md#getMember) | **GET** /endpoints/members/{phoneNumber} | Gets the details for a member\n*hullojs.MembersApi* | [**optOutMember**](docs/MembersApi.md#optOutMember) | **POST** /endpoints/members/{phoneNumber}/optout | Opts the member out from the hullo member store\n*hullojs.MembersApi* | [**upsertMember**](docs/MembersApi.md#upsertMember) | **POST** /endpoints/members | Adds or updates a member\n*hullojs.MessagesApi* | [**createMessage**](docs/MessagesApi.md#createMessage) | **POST** /endpoints/messages | Send a message\n*hullojs.MessagesApi* | [**getMessages**](docs/MessagesApi.md#getMessages) | **GET** /endpoints/messages/{phoneNumber} | Gets the messages for a specific subscriber\n\n\n## Documentation for Models\n\n - [hullojs.Account](docs/Account.md)\n - [hullojs.Attribute](docs/Attribute.md)\n - [hullojs.AttributeEditType](docs/AttributeEditType.md)\n - [hullojs.AttributeType](docs/AttributeType.md)\n - [hullojs.GenericError](docs/GenericError.md)\n - [hullojs.Member](docs/Member.md)\n - [hullojs.Message](docs/Message.md)\n - [hullojs.MessageStatus](docs/MessageStatus.md)\n\n\n## Documentation for Authorization\n\n\nAuthentication schemes defined for the API:\n### ApiKeyAuth\n\n\n- **Type**: API key\n- **API key parameter name**: X-API-KEY\n- **Location**: HTTP header\n\n","readmeFilename":"README.md"}