@sweepbright/api-client 0.26.2 → 0.27.0

package/README.md

@@ -86,7 +86,6 @@ publication change was scheduled successfully
 - **estateId** - required - the id of the estate who's publication is going to be updated
 - **channelAccountId** - required - the id of the channel account of the publication
 - **config** - required - a configuration object, specific for each channel account type, which information about the publication config [link](link missing)
-<<<<<<< HEAD
 
 ### Estates - unpublishPublication
 
@@ -167,39 +166,21 @@ Returns a company. Takes a single `options` parameter and returns a promise with
 
 - **companyId** - required - the id of the company to return
 - **includes** - optional - a list of includes to return
-=======
-
-### Estates - unpublishPublication
-
-Allows to remove an existing property publication, requires to be authorized
-with a user token. Takes a single `options` parameter and returns an empty response if the
-publication change was scheduled successfully
-
-#### Options object
-
-- **estateId** - required - the id of the estate who's publication is going to be updated
-- **channelAccountId** - required - the id of the channel account of the publication
-
-### Contacts - getOne
-
-Takes a single `options` parameter and returns a promise with the contact data
-
-#### Options object
-
-- **contactId** - required - the id of the contact to return
-
-### Contacts - getAll
-
-Takes a single `options` parameter and returns a promise with a paginated list of contacts for a specific company
-
-#### Options object
-
-- **companyId** - required - the id of the company from which to get the contacts
-- **page** - optional - when paginating the request, allows you specify the page you want to get
-- **limit** - optional - when paginating the request, allows you specify the number of items per page (defaults to 10)
->>>>>>> 2c8f69d889eab75b1bb5afcdc3cca6b1d498fd4d
 
 ## Development
 
 This repository was initialized using [TSDX](https://github.com/formium/tsdx).
 Check their docs for information about the different commands available.
+
+## Publication
+
+Publication is configured in Github Actions. The flow is the following: "Version Tag -> Github Release".
+
+In `master` branch:
+ - run `yarn version` and select a new version
+ - yarn will create a commit and a version tag
+ - push the changes together with tag
+ - go to [Releases / Tags](https://github.com/sweepbright/api-client-js/tags)
+ - find your new tag and click "Create Release From Tag" button
+ - save the release
+ - go to [Actions](https://github.com/sweepbright/api-client-js/actions) and make sure the NPM package is being published