Socket
Socket
Sign inDemoInstall

@vendasta/account-group-sdk

Package Overview
Dependencies
9
Maintainers
1
Versions
18
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

Comparing version 3.2.0 to 3.3.0

6

account-group.api.service.js

@@ -92,9 +92,9 @@ import { Injectable } from '@angular/core';

case Environment.TEST:
this.host = 'https://account-group-api-test.vendasta-internal.com';
this.host = 'https://account-group-api-test.apigateway.co';
break;
case Environment.DEMO:
this.host = 'https://account-group-api-demo.vendasta-internal.com';
this.host = 'https://account-group-api-demo.apigateway.co';
break;
case Environment.PROD:
this.host = 'https://account-group-api-prod.vendasta-internal.com';
this.host = 'https://account-group-api-prod.apigateway.co';
break;

@@ -101,0 +101,0 @@ }

CHANGE LOG
==========
### 3.3.0
- Calls now go to account group api's subdomain of apigateway.co
### 3.2.0

@@ -4,0 +8,0 @@

{
"_args": [
[
{
"raw": "@vendasta/account-group-sdk@file:./src/sdks/account-group/",
"scope": "@vendasta",
"escapedName": "@vendasta%2faccount-group-sdk",
"name": "@vendasta/account-group-sdk",
"rawSpec": "file:./src/sdks/account-group/",
"spec": "/Users/JRans/Projects/frontend/src/sdks/account-group",
"type": "directory"
},
"/Users/JRans/Projects/frontend"
]
],
"_from": "src/sdks/account-group",
"_id": "@vendasta/account-group-sdk@3.2.0",
"_inCache": true,
"_location": "/@vendasta/account-group-sdk",
"_phantomChildren": {},
"_requested": {
"raw": "@vendasta/account-group-sdk@file:./src/sdks/account-group/",
"scope": "@vendasta",
"escapedName": "@vendasta%2faccount-group-sdk",
"name": "@vendasta/account-group-sdk",
"rawSpec": "file:./src/sdks/account-group/",
"spec": "/Users/JRans/Projects/frontend/src/sdks/account-group",
"type": "directory"
"name": "@vendasta/account-group-sdk",
"version": "3.3.0",
"description": "Account Group Microservice typescript sdk.",
"devDependencies": {
"typescript": "^2.2.2"
},
"_requiredBy": [
"#USER",
"/",
"/@vendasta/business-profile"
],
"_resolved": "file:src/sdks/account-group",
"_shasum": "971f17ee6989dc955c7cabb2a35d37d8023edd61",
"_shrinkwrap": null,
"_spec": "@vendasta/account-group-sdk@file:./src/sdks/account-group/",
"_where": "/Users/JRans/Projects/frontend",
"author": {
"name": "Vendasta R&D"
},
"dependencies": {

@@ -50,18 +15,11 @@ "@angular/compiler": "^4.0.0",

"core-js": "^2.0.0",
"hammerjs": "^2.0.8",
"rxjs": "^5.0.0",
"zone.js": "^0.8.0"
},
"description": "Account Group Microservice typescript sdk.",
"devDependencies": {
"typescript": "^2.2.2"
},
"license": "ISC",
"main": "index.js",
"name": "@vendasta/account-group-sdk",
"optionalDependencies": {},
"readme": "# Account Group SDK\n\nThis provides a typescript implementation of the account group microservice\n\n## Requirements\n\nTo setup the sdk you will need to:\n\nInstall the sdk to your project\n\n```bash\nnpm install @vendasta/account-group-sdk --save\n```\n\nNext, you will need to import and setup your navigation module (generally in `app.module.ts`)\n\n```typescript\nimport { AccountGroupModule } from \"@vendasta/account-group-sdk\";\n…\n@NgModule({\n …\n imports: [\n …, AccountGroupModule, …\n ]\n})\n```\n\n### External Requirements\n\nThe Account Group sdk requires the following vendasta packages to be implemented by the project:\n\n- `EnvironmentService` (https://www.npmjs.com/package/@vendasta/environment-service)\n- `PartnerService` (https://www.npmjs.com/package/@vendasta/partner-service)\n- `SessionService` (https://www.npmjs.com/package/@vendasta/session-service)\n\nPlease follow their instructions on how to set those packages up.\n\n## Usage\n\nInject the AccountGroupService into your component and you will be able to start using it!\n\n```typescript\nimport {AccountGroupService} from '@vendasta/account-group-sdk';\n\n@Component({\n selector: '…',\n template: '…',\n styles: '…'\n})\nexport class …Component {\n constructor(private accountGroupService: AccountGroupService) {\n }\n}\n```\n\n### ProjectionFilters\n\nEvery call to the account group microservice requires a ProjectionFilter. A projection filter tells the microservice what data to return. By default all fields are false.\n\n```typescript\ninterface ProjectionFilterInterface {\n accounts?: boolean;\n listingDistribution?: boolean;\n listingSyncPro?: boolean;\n associations?: boolean;\n accountGroupExternalIdentifiers?: boolean;\n socialUrls?: boolean;\n hoursOfOperation?: boolean;\n contactDetails?: boolean;\n snapshotReports?: boolean;\n legacyProductDetails?: boolean;\n richData?: boolean;\n}\n```\n\nDuring construction, you can pass in all of the properties you want the api call to return:\n```typescript\nimport {ProjectionFilter} from '@vendasta/account-group-sdk'\n\nlet pf = new ProjectionFilter({accounts: true, socialUrls: true, richData: true});\n```\n\nOr you can call `enableAll` to return all data.\n\n```typescript\nimport {ProjectionFilter} from '@vendasta/account-group-sdk'\n\nlet pf = new ProjectionFilter().enableAll();\n```\n\n### Lookup\n\n`lookup(projectionFilter: ProjectionFilter, marketIds: string[] = null, searchTerm: string = null, filters: LookupFilter = null, pageSize: number = 10): Observable<AccountGroup[]>`\n\nLookup returns many account groups matching the criteria specified. To fetch the next set of paged results from a lookup, call `loadMore` passing in the same criteria that was used in the original `lookup`.\n \n`loadMore(projectionFilter: ProjectionFilter, marketIds: string[], searchTerm: string, filters: LookupFilter, pageSize: number = 10): Observable<AccountGroup[]>`\n\nThe list of account groups returned by `loadMore` will include the previous account groups fetched - there is no need to keep track of the list of account groups in your component.\n\nLookup provides some helper observables you can subscribe to:\n\n`get hasMore(): Observable<boolean>` Whether or not there are more account groups to fetch \n\n`get accountGroups(): Observable<AccountGroup[]>` The current list of account groups fetched\n\n`get totalResults(): Observable<number>` How many results are there total to fetch\n\n`get loading(): Observable<boolean>` Whether or not the service is currently talking to the microservice\n\n\n### Get\n\n`get(accountGroupId: string, projectionFilter: ProjectionFilter): Observable<AccountGroup>`\n\nFetch a single account group by its ID\n\n### GetMulti\n\n`getMulti(accountGroupIds: string[], projectionFilter: ProjectionFilter): Observable<AccountGroup[]>`\n\nFetch many account groups by their IDs\n\n### BulkUpdate\n\n`bulkUpdate(accountGroupId: string, updateOperations: UpdateOperations): Observable<Response>`\n\nTo use the bulkUpdate function you will need to construct an UpdateOperations object and add the update operations you want to do to the account group.\n\nThere are 10 operations to choose from:\n- `NapUpdateOperation`\n- `SnapshotsUpdateOperation`\n- `ListingDistributionDetailsUpdateOperation`\n- `ListingSyncProUpdateOperation`\n- `AccountGroupExternalIdentifiersUpdateOperation`\n- `SocialURLsUpdateOperation`\n- `HoursOfOperationUpdateOperation`\n- `ContactDetailsUpdateOperation`\n- `LegacyProductDetailsUpdateOperation`\n- `RichDataUpdateOperation`\n\n```typescript\nimport {UpdateOperations} from '@vendasta/account-group-sdk'\n\nlet operations: UpdateOperations = new UpdateOperations();\n\noperations.addUpdateOperation(new NapUpdateOperation({key: value...}));\noperations.addUpdateOperation(new SnapshotsUpdateOperation({key: value...}));\noperations.addUpdateOperation(new ListingDistributionDetailsUpdateOperation({key: value...}));\noperations.addUpdateOperation(new ListingSyncProUpdateOperation({key: value...}));\noperations.addUpdateOperation(new AccountGroupExternalIdentifiersUpdateOperation({key: value...}));\noperations.addUpdateOperation(new SocialURLsUpdateOperation({key: value...}));\noperations.addUpdateOperation(new HoursOfOperationUpdateOperation({key: value...}));\noperations.addUpdateOperation(new ContactDetailsUpdateOperation({key: value...}));\noperations.addUpdateOperation(new LegacyProductDetailsUpdateOperation({key: value...}));\noperations.addUpdateOperation(new RichDataUpdateOperation({key: value...}));\n```\n\nOnly fields specified will be altered on the account group.\n",
"readmeFilename": "README.md",
"scripts": {},
"author": "Vendasta R&D",
"typings": "index.d.ts",
"version": "3.2.0"
"license": "ISC",
"main": "index.js"
}
SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc