woosignal 1.0.2

  • Readme
  • Changelog
  • Example
  • Installing
  • 75

WooCommerce API Dart plugin #

Official WooSignal WooCommerce package

Build apps for WooCommerce easier with our new package. Our API provides many requests types e.g. getProducts, getOrders, getCustomers and many more. Free to get started, see the simple examples below

For help getting started with WooSignal, view our online documentation, which offers a more detail guide.

Usage #

To use this plugin, add woosignal as a dependency in your pubspec.yaml file.

Example #

import 'package:woosignal/woosignal.dart';

...

// EXAMPLE GET PRODUCTS
_getProducts() async {

        // CONFIG FOR WOOSIGNAL
        var wsConfig = {
          "appKey":"your app key",
          "debugMode":true
        };

        // CREATING AN INSTANCE
        WooSignal.getInstance(config: wsConfig).then( (wcStore) {

         wcStore.getProducts().then( (products) {
              print(products[0].name);
        });

  });
}

Disclaimer: This plugin is not affiliated with or supported by Automattic, Inc. All logos and trademarks are the property of their respective owners.

[1.0.2] - 2019-10-31

  • Tweaks and bugs resolved

[1.0.1] - 2019-10-29

  • Bugs resolved, added pubspec.yaml to example, new documentation URL

[1.0.0] - 2019-06-15

  • Tweaks and fixes

[0.0.3] - 2019-06-15

  • added example, formatting classes

[0.0.2] - 2019-06-14

  • Changes to pubspec description, formatting classes, example added, homepage URL update

[0.0.1] - 2019-06-13

  • Initial Release

example/README.md

Example - Returns first product name #

A new WooCommerce Flutter project.

Getting Started #

Follow our easy guide online to generate a new app key to start making WooCommerce API requests. documentation.

For help getting started with Flutter, view our online documentation

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  woosignal: ^1.0.2

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter pub get

Alternatively, your editor might support flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:woosignal/woosignal.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
50
Health:
Code health derived from static analysis. [more]
98
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
100
Overall:
Weighted score of the above. [more]
75
Learn more about scoring.

We analyzed this package on Dec 11, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.6.1
  • pana: 0.13.1+4
  • Flutter: 1.12.13+hotfix.2

Health issues and suggestions

Document public APIs. (-0.68 points)

1546 out of 1563 API elements have no dartdoc comment.Providing good documentation for libraries, classes, functions, and other API elements improves code readability and helps developers find and use your API.

Fix lib/models/payload/order_wc.dart. (-1 points)

Analysis of lib/models/payload/order_wc.dart reported 2 hints:

line 319 col 10: Name non-constant identifiers using lowerCamelCase.

line 328 col 12: Name non-constant identifiers using lowerCamelCase.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.1.0 <3.0.0
device_info ^0.4.0+2 0.4.1+4
dio ^3.0.1 3.0.7
flutter 0.0.0
shared_preferences ^0.5.3+4 0.5.5 0.5.6
uuid ^2.0.2 2.0.4
Transitive dependencies
charcode 1.1.2
collection 1.14.11 1.14.12
convert 2.1.1
crypto 2.1.4
http_parser 3.1.3
meta 1.1.8
path 1.6.4
shared_preferences_macos 0.0.1
shared_preferences_platform_interface 1.0.1
sky_engine 0.0.99
source_span 1.5.5
string_scanner 1.0.5
term_glyph 1.1.0
typed_data 1.1.6
vector_math 2.0.8
Dev dependencies
flutter_test