Inventory API objective-c client
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
InventoryClient
docs
InventoryClient.podspec
LICENSE
README.md
git_push.sh

README.md

InventoryClient

Orkiv Inventory API client

This ObjC package is automatically generated by the Swagger Codegen project:

  • API version: 1.0.0
  • Package version:
  • Build date: 2016-08-05T15:18:59.361-04:00
  • Build package: class io.swagger.codegen.languages.ObjcClientCodegen

Requirements

The SDK requires ARC (Automatic Reference Counting) to be enabled in the Xcode project.

Installation & Usage

Install from Github using CocoaPods

Add the following to the Podfile:

pod 'InventoryClient', :git => 'https://github.com/Orkiv/Inventory-objc-client.git'

To specify a particular branch, append , :branch => 'branch-name-here'

To specify a particular commit, append , :commit => '11aa22'

Install from local path using CocoaPods

Put the SDK under your project folder (e.g. /path/to/objc_project/Vendor/InventoryClient) and then add the following to the Podfile:

pod 'InventoryClient', :path => 'Vendor/InventoryClient'

Usage

Import the following:

#import <InventoryClient/INVApiClient.h>
#import <InventoryClient/INVConfiguration.h>
// load models
#import <InventoryClient/INVCategory.h>
#import <InventoryClient/INVError.h>
#import <InventoryClient/INVEventRequest.h>
#import <InventoryClient/INVInventoryGroup.h>
#import <InventoryClient/INVItem.h>
#import <InventoryClient/INVItemRequest.h>
#import <InventoryClient/INVOrder.h>
#import <InventoryClient/INVOrderRequest.h>
#import <InventoryClient/INVResponse.h>
#import <InventoryClient/INVService.h>
#import <InventoryClient/INVServiceRequest.h>
#import <InventoryClient/INVVariation.h>
// load API classes for accessing endpoints
#import <InventoryClient/INVDefaultApi.h>

Recommendation

It's recommended to create an instance of ApiClient per thread in a multi-threaded environment to avoid any potential issue.

Getting Started

Please follow the installation procedure and then run the following:

INVConfiguration *apiConfig = [INVConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: APIKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"APIKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"APIKey"];

// Configure API key authorization: (authentication scheme: AccountID)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"accountid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"accountid"];



INVDefaultApi *apiInstance = [[INVDefaultApi alloc] init];

[apiInstance allGetWithCompletionHandler: 
              ^(NSArray<INVInventoryGroup>* output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

Documentation for API Endpoints

All URIs are relative to https://www.orkiv.com/i/api

Class Method HTTP request Description
INVDefaultApi allGet GET /all/
INVDefaultApi categoriesDelete DELETE /categories/
INVDefaultApi categoriesPost POST /categories/
INVDefaultApi categoriesPut PUT /categories/
INVDefaultApi itemAddPost POST /item/add/
INVDefaultApi itemAddbulkPost POST /item/addbulk/
INVDefaultApi itemDelete DELETE /item/
INVDefaultApi itemGet GET /item/
INVDefaultApi itemMediaDelete DELETE /item-media/
INVDefaultApi itemMediaPost POST /item-media/
INVDefaultApi itemPut PUT /item/
INVDefaultApi itemsCountPost POST /items/count/
INVDefaultApi itemsPost POST /items/
INVDefaultApi ordersPost POST /orders/
INVDefaultApi ordersServicesPost POST /orders/services/
INVDefaultApi queryPost POST /query/
INVDefaultApi servicesDelete DELETE /services/
INVDefaultApi servicesGet GET /services/
INVDefaultApi servicesOpenGet GET /services/open/
INVDefaultApi servicesPost POST /services/
INVDefaultApi servicesPut PUT /services/
INVDefaultApi variationDelete DELETE /variation/
INVDefaultApi variationGet GET /variation/
INVDefaultApi variationPost POST /variation/
INVDefaultApi variationPut PUT /variation/
INVDefaultApi writeDelete DELETE /write/
INVDefaultApi writePost POST /write/

Documentation For Models

Documentation For Authorization

APIKey

  • Type: API key
  • API key parameter name: APIKey
  • Location: HTTP header

AccountID

  • Type: API key
  • API key parameter name: accountid
  • Location: HTTP header

Author