zip_money 1.2.1

data/docs/OrderShippingTracking.md

@@ -0,0 +1,10 @@
+# ZipMoney::OrderShippingTracking
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uri** | **String** |  | [optional] 
+**number** | **String** |  | [optional] 
+**carrier** | **String** |  | [optional] 
+
+

data/docs/Refund.md

@@ -0,0 +1,13 @@
+# ZipMoney::Refund
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The id of the refund | 
+**charge_id** | **String** | The original charge that relates to this refund | [optional] 
+**reason** | **String** | The reason for the refund | 
+**amount** | **Float** | The amount that was refunded | 
+**created** | **DateTime** | The date the refund was created | 
+**metadata** | **Object** | Any additional metadata | [optional] 
+
+

data/docs/RefundsApi.md

@@ -0,0 +1,181 @@
+# ZipMoney::RefundsApi
+
+All URIs are relative to *https://api.sandbox.zipmoney.com.au/merchant/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**refunds_create**](RefundsApi.md#refunds_create) | **POST** /refunds | Create a refund
+[**refunds_list**](RefundsApi.md#refunds_list) | **GET** /refunds | List refunds
+[**refunds_retrieve**](RefundsApi.md#refunds_retrieve) | **GET** /refunds/{id} | Retrieve a refund
+
+
+# **refunds_create**
+> Refund refunds_create(opts)
+
+Create a refund
+
+Creates a refund for a previously authorised or captured charge. See #model:xWJer4QQyRumRi9LD for more information.  This endpoint will return 201 or otherwise 402 if unable to perform the refund.   | Error code | Description | |------------------------------------|--------------------------------------------------------------------------------------------------| | amount_invalid | The refund amount is greater than the remaining captured total | | invalid_state | 1. The charge is already fully refunded |
+
+### Example
+```ruby
+# load the gem
+require 'zip_money'
+# setup authorization
+ZipMoney.configure do |config|
+  # Configure API key authorization: Authorization
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = ZipMoney::RefundsApi.new
+
+opts = { 
+  body: ZipMoney::CreateRefundRequest.new, # CreateRefundRequest | 
+  idempotency_key: "idempotency_key_example" # String | The unique idempotency key.
+}
+
+begin
+  #Create a refund
+  result = api_instance.refunds_create(opts)
+  p result
+rescue ZipMoney::ApiError => e
+  puts "Exception when calling RefundsApi->refunds_create: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**CreateRefundRequest**](CreateRefundRequest.md)|  | [optional] 
+ **idempotency_key** | **String**| The unique idempotency key. | [optional] 
+
+### Return type
+
+[**Refund**](Refund.md)
+
+### Authorization
+
+[Authorization](../README.md#Authorization)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/javascript
+
+
+
+# **refunds_list**
+> Array<InlineResponse200> refunds_list(opts)
+
+List refunds
+
+List all refunds
+
+### Example
+```ruby
+# load the gem
+require 'zip_money'
+# setup authorization
+ZipMoney.configure do |config|
+  # Configure API key authorization: Authorization
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = ZipMoney::RefundsApi.new
+
+opts = { 
+  charge_id: "charge_id_example", # String | 
+  skip: 0, # Integer | Number of items to skip when paging
+  limit: 100 # Integer | Number of items to retrieve when paging
+}
+
+begin
+  #List refunds
+  result = api_instance.refunds_list(opts)
+  p result
+rescue ZipMoney::ApiError => e
+  puts "Exception when calling RefundsApi->refunds_list: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **charge_id** | **String**|  | [optional] 
+ **skip** | **Integer**| Number of items to skip when paging | [optional] [default to 0]
+ **limit** | **Integer**| Number of items to retrieve when paging | [optional] [default to 100]
+
+### Return type
+
+[**Array<InlineResponse200>**](InlineResponse200.md)
+
+### Authorization
+
+[Authorization](../README.md#Authorization)
+
+### HTTP request headers
+
+ - **Content-Type**: application/javascript
+ - **Accept**: application/javascript
+
+
+
+# **refunds_retrieve**
+> Refund refunds_retrieve(id)
+
+Retrieve a refund
+
+Retrieves details of a specific refund
+
+### Example
+```ruby
+# load the gem
+require 'zip_money'
+# setup authorization
+ZipMoney.configure do |config|
+  # Configure API key authorization: Authorization
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = ZipMoney::RefundsApi.new
+
+id = "id_example" # String | The id of the refund
+
+
+begin
+  #Retrieve a refund
+  result = api_instance.refunds_retrieve(id)
+  p result
+rescue ZipMoney::ApiError => e
+  puts "Exception when calling RefundsApi->refunds_retrieve: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| The id of the refund | 
+
+### Return type
+
+[**Refund**](Refund.md)
+
+### Authorization
+
+[Authorization](../README.md#Authorization)
+
+### HTTP request headers
+
+ - **Content-Type**: application/javascript
+ - **Accept**: application/javascript
+
+
+

data/docs/SettlementsApi.md

@@ -0,0 +1,96 @@
+# ZipMoney::SettlementsApi
+
+All URIs are relative to *https://api.sandbox.zipmoney.com.au/merchant/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**settlements_get**](SettlementsApi.md#settlements_get) | **GET** /settlements/{id} | Retrieve a settlement
+[**settlements_list**](SettlementsApi.md#settlements_list) | **GET** /settlements | List settlements
+
+
+# **settlements_get**
+> settlements_get(id)
+
+Retrieve a settlement
+
+Retrieves the full transactional details of a settlement.
+
+### Example
+```ruby
+# load the gem
+require 'zip_money'
+
+api_instance = ZipMoney::SettlementsApi.new
+
+id = "id_example" # String | The settlement id
+
+
+begin
+  #Retrieve a settlement
+  api_instance.settlements_get(id)
+rescue ZipMoney::ApiError => e
+  puts "Exception when calling SettlementsApi->settlements_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| The settlement id | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/javascript
+ - **Accept**: application/javascript
+
+
+
+# **settlements_list**
+> settlements_list
+
+List settlements
+
+This endpoint will allow a merchant to view the settlements which have occured. To view detailed transaction information for a specific settlement you can use the Retrieve a settlement endpoint.
+
+### Example
+```ruby
+# load the gem
+require 'zip_money'
+
+api_instance = ZipMoney::SettlementsApi.new
+
+begin
+  #List settlements
+  api_instance.settlements_list
+rescue ZipMoney::ApiError => e
+  puts "Exception when calling SettlementsApi->settlements_list: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/javascript
+ - **Accept**: application/javascript
+
+
+

data/docs/Shopper.md

@@ -0,0 +1,17 @@
+# ZipMoney::Shopper
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**title** | **String** | The shopper's title | [optional] 
+**first_name** | **String** | The shopper's first name | 
+**last_name** | **String** | The shopper's last name | 
+**middle_name** | **String** | The shopper's middle name | [optional] 
+**phone** | **String** | The shopper's contact phone number | [optional] 
+**email** | **String** | The shopper's email address | 
+**birth_date** | **Date** | The shopper's birth date in the form yyyy-mm-dd | [optional] 
+**gender** | **String** | The shopper's gender | [optional] 
+**statistics** | [**ShopperStatistics**](ShopperStatistics.md) |  | [optional] 
+**billing_address** | [**Address**](Address.md) |  | 
+
+

data/docs/ShopperStatistics.md

@@ -0,0 +1,16 @@
+# ZipMoney::ShopperStatistics
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_created** | **DateTime** | The time at which the shopper's account was created | [optional] 
+**sales_total_count** | **Integer** | The total number of separate purchases the shopper has made through the store | [optional] 
+**sales_total_amount** | **Float** | The total purchase amount of all orders previously captured through the store. | [optional] 
+**sales_avg_amount** | **Float** | The average value of sales made by the shopper through the store | [optional] 
+**sales_max_amount** | **Float** | The maximum purchase amount the shopper has previously purchased from the store. | [optional] 
+**refunds_total_amount** | **Float** | The total amount of all refunds linked to this shopper's account | [optional] 
+**previous_chargeback** | **BOOLEAN** | Has the shopper had a previous chargeback? | [optional] 
+**currency** | **String** | The currency of all all amount values | [optional] 
+**last_login** | **DateTime** | The date at which the shopper last logged in to your store. | [optional] 
+
+

data/docs/Token.md

@@ -0,0 +1,11 @@
+# ZipMoney::Token
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | 
+**value** | **String** |  | 
+**active** | **BOOLEAN** |  | 
+**created_date** | **DateTime** |  | 
+
+

data/docs/TokensApi.md

@@ -0,0 +1,66 @@
+# ZipMoney::TokensApi
+
+All URIs are relative to *https://api.sandbox.zipmoney.com.au/merchant/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**tokens_create**](TokensApi.md#tokens_create) | **POST** /tokens | Create token
+
+
+# **tokens_create**
+> Token tokens_create(opts)
+
+Create token
+
+Tokenises a zip account allowing a charge to be performed at a later date without direct customer involvement.  In order to create a token you will first need to request customer approval by implementing one of the online checkout flows. The checkout id will then be provided as the authority when tokenising.  | Error code | Description | |------------------------------------|--------------------------------------------------------------------------------------------------| | account_inoperative | The account is in arrears or closed and cannot be charged | | account_locked | The account is locked |
+
+### Example
+```ruby
+# load the gem
+require 'zip_money'
+# setup authorization
+ZipMoney.configure do |config|
+  # Configure API key authorization: Authorization
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = ZipMoney::TokensApi.new
+
+opts = { 
+  body: ZipMoney::CreateTokenRequest.new, # CreateTokenRequest | 
+  idempotency_key: "idempotency_key_example" # String | The unique idempotency key.
+}
+
+begin
+  #Create token
+  result = api_instance.tokens_create(opts)
+  p result
+rescue ZipMoney::ApiError => e
+  puts "Exception when calling TokensApi->tokens_create: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**CreateTokenRequest**](CreateTokenRequest.md)|  | [optional] 
+ **idempotency_key** | **String**| The unique idempotency key. | [optional] 
+
+### Return type
+
+[**Token**](Token.md)
+
+### Authorization
+
+[Authorization](../README.md#Authorization)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/javascript
+
+
+

data/lib/zip_money.rb

@@ -0,0 +1,68 @@
+#Merchant API 
+#ZipMoney Merchant API Initial build
+#zipMoney Merchant API version: 2017-03-01
+
+
+# Common files
+require 'zip_money/api_client'
+require 'zip_money/api_error'
+require 'zip_money/version'
+require 'zip_money/configuration'
+
+# Models
+require 'zip_money/models/address'
+require 'zip_money/models/authority'
+require 'zip_money/models/capture_charge_request'
+require 'zip_money/models/charge'
+require 'zip_money/models/charge_collection'
+require 'zip_money/models/charge_order'
+require 'zip_money/models/checkout'
+require 'zip_money/models/checkout_configuration'
+require 'zip_money/models/checkout_features'
+require 'zip_money/models/checkout_features_tokenisation'
+require 'zip_money/models/checkout_order'
+require 'zip_money/models/create_charge_request'
+require 'zip_money/models/create_checkout_request'
+require 'zip_money/models/create_checkout_request_features'
+require 'zip_money/models/create_checkout_request_features_tokenisation'
+require 'zip_money/models/create_refund_request'
+require 'zip_money/models/create_token_request'
+require 'zip_money/models/customer'
+require 'zip_money/models/error_response'
+require 'zip_money/models/error_response_error'
+require 'zip_money/models/error_response_error_details'
+require 'zip_money/models/inline_response_200'
+require 'zip_money/models/metadata'
+require 'zip_money/models/order_item'
+require 'zip_money/models/order_shipping'
+require 'zip_money/models/order_shipping_tracking'
+require 'zip_money/models/refund'
+require 'zip_money/models/shopper'
+require 'zip_money/models/shopper_statistics'
+require 'zip_money/models/token'
+
+# APIs
+require 'zip_money/api/charges_api'
+require 'zip_money/api/checkouts_api'
+require 'zip_money/api/customers_api'
+require 'zip_money/api/refunds_api'
+require 'zip_money/api/settlements_api'
+require 'zip_money/api/tokens_api'
+
+module ZipMoney
+  class << self
+    # Customize default settings for the SDK using block.
+    #   ZipMoney.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end