https://github.com/darimm/striven

Striven API library implementation
https://github.com/darimm/striven

library striven

Last synced: 4 months ago
JSON representation

Striven API library implementation

• Host: GitHub
• URL: https://github.com/darimm/striven
• Owner: darimm
• License: gpl-3.0
• Created: 2020-10-09T11:24:23.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2021-02-09T12:54:48.000Z (over 5 years ago)
• Last Synced: 2024-06-20T00:35:05.289Z (about 2 years ago)
• Topics: library, striven
• Language: Go
• Homepage: https://api.striven.com
• Size: 84 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
Golang implementation of the Striven API ( https://api.striven.com ) 

This project is in no way officially affiliated with Striven.

Example Code (Note - this is very bad form. Do not put your API IDs and Secret in your code): 

```

package main

import (

  "fmt"

  

  "github.com/darimm/striven"

)

func main() {

  s := striven.New("MYCLIENTID", "MYCLIENTSECRET")

  fmt.println(s.Token.AccessToken)

 

  resp, err := s.Employees.GetAll()

  

  if err != nil {

    fmt.Println(err)

  }

  fmt.Println(resp)

 }

 ```

Current Status: Incomplete.

APIs Implemented (Checkmark means Completely implemented)

- [X] Access Tokens  

`New(CustomerID,CustomerSecret)` implements https://api.striven.com/v1/apitoken  

- [ ] BillCredits  

`BillCredits.GetByID(billCreditID int)` implements https://api.striven.com/v1/bill-credits/{billCreditID}  

`BillCredits.Notes.GetByID(params ...int)` implements https://api.striven.com/Help/Api/GET-v1-bill-credits-id-notes_PageIndex_PageSize  

`BillCredits.Attachments.GetByID()` implements https://api.striven.com/Help/Api/GET-v1-bill-credits-id-attachments partially. 

- [X] Classes  

`Classes.GetAll()` implements https://api.striven.com/v1/classes  

- [ ] Contacts  

`Contacts.GetByID(contactID int)` implements https://api.striven.com/Help/Api/GET-v1-contacts-id  

- [X] CustomerAssets  

`CustomerAssets.Create(asset CustomerAsset)` implements https://api.striven.com/Help/Api/POST-v1-customer-assets for creating  

`CustomerAssets.Update(asset CustomerAsset)` implements https://api.striven.com/Help/Api/POST-v1-customer-assets for updating  

`CustomerAssets.GetByID(assetID int)` implements https://api.striven.com/Help/Api/GET-v1-customer-assets-id  

`CustomerAssets.Search(param CustomerAssetSearchParam)` implements https://api.striven.com/Help/Api/POST-v1-customer-assets-search  

`CustomerAssets.Types.GetAll()` implements https://api.striven.com/Help/Api/GET-v1-customer-assets-types  

`CustomerAssets.CustomFields` implements https://api.striven.com/Help/Api/GET-v1-customer-assets-id-custom-fields  

`CustomerAssets.Status` implements https://api.striven.com/Help/Api/POST-v1-customer-assets-id-update-status  

`CustomerAssets.MaintenanceSchedule` implements https://api.striven.com/Help/Api/POST-v1-customer-assets-id-maintenance-schedule

- [ ] Customers  

`Customers.GetByID(customerID int)` implements https://api.striven.com/v1/customers/{customerID}

`Customers.Contacts.GetByCustomerID(customerID int)` implements https://api.striven.com/v1/customers/{customerID}/contacts

`Customers.ContentGroups.GetByID(customerID int)` implements https://api.striven.com/v1/customers/{customerID}/hub/content-groups  

`Customers.ContentGroups.Document.Upload(localFilePath string, opts ...CustomersHubDocOption)` implements https://api.striven.com/Help/Api/POST-v1-customers-id-hub-content-groups-groupId-documents available options are `striven.SetClientID(ClientID int)`, `striven.SetGroupID(GroupID int)`, `striven.SetContentGroupName(GroupName string)`, `striven.IsOverwriteEnabled()`, and `striven.IsVisibleOnPortal()` this function is suitable for single file uploads, if your application needs concurrent uploads, create variables of the type CustomersHubDoc and call the Upload method as above.  

- [X] CustomList  

`CustomLists.GetAll()` implements https://api.striven.com/v1/custom-lists  

`CustomLists.ListItems.Get(ListID int)` implements https://api.striven.com/v1/custom-lists/{ListID}/list-items  

- [X] Employees  

`Employees.GetAll()` implements https://api.striven.com/v1/employees  

- [X] Formats  

`InvoiceFormats.GetAll()` implements https://api.striven.com/Help/Api/GET-v1-invoice-formats  

- [X] GLCategories  

`GLCategories.GetAll()` implements https://api.striven.com/Help/Api/GET-v1-glcategories  

- [X] Industries  

`Industries.GetAll()` implements https://api.striven.com/Help/Api/GET-v1-industries  

- [X] InventoryLocations  

`InventoryLocations.GetAll()` implements https://api.striven.com/Help/Api/GET-v1-inventory-locations  

- [X] ItemTypes  

`ItemTypes.GetAll()` implements https://api.striven.com/Help/Api/GET-v1-item-types  

- [X] PaymentTerms  

`PaymentTerms.GetAll(excludeDiscounts bool)` implements https://api.striven.com/Help/Api/GET-v1-payment-terms_excludeDiscounts  

- [X] Pools  

`Pools.GetAll()` implements https://api.striven.com/Help/Api/GET-v1-pools  

- [X] ReferralSources  

`ReferralSources.GetAll()` implements https://api.striven.com/Help/Api/GET-v1-referral-sources  

- [X] SalesOrderTypes 

`SalesOrderTypes.GetAll(excludeContractManagedTypes bool)` implements https://api.striven.com/Help/Api/GET-v1-sales-order-types_excludeContractManagedTypes  

- [X] ShippingMethods  

`ShippingMethods.GetAll()` implements https://api.striven.com/Help/Api/GET-v1-shipping-methods  

APIs Not Implemented

- [ ] Bills  

- [ ] Categories  

- [ ] CreditMemos   

- [ ] GLAcconuts  

- [ ] Invoices  

- [ ] Items  

- [ ] JournalEntries  

- [ ] Opportunities  

- [ ] Payments  

- [ ] Purchase Orders  

- [ ] SalesOrders  

- [ ] Tasks  

- [ ] UserInfo  

- [ ] Vendors