zip_money 1.2.1

data/docs/Checkout.md

@@ -0,0 +1,18 @@
+# ZipMoney::Checkout
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The checkout id | 
+**uri** | **String** | The uri to redirect the user to in order to approve this checkout. | 
+**type** | **String** | The type of checkout | [optional] [default to "standard"]
+**shopper** | [**Shopper**](Shopper.md) |  | [optional] 
+**order** | [**CheckoutOrder**](CheckoutOrder.md) |  | [optional] 
+**features** | [**CheckoutFeatures**](CheckoutFeatures.md) |  | [optional] 
+**config** | [**CheckoutConfiguration**](CheckoutConfiguration.md) |  | [optional] 
+**created** | **DateTime** | Date the checkout was created | 
+**state** | **String** | Current state of the checkout | 
+**customer_id** | **String** | The id of the customer who has approved this checkout request. Only present if approved. | [optional] 
+**metadata** | [**Metadata**](Metadata.md) |  | [optional] 
+
+

data/docs/CheckoutConfiguration.md

@@ -0,0 +1,8 @@
+# ZipMoney::CheckoutConfiguration
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**redirect_uri** | **String** | The URI to redirect after the checkout is complete.  This must be provided, even if using in-context checkout.  If using redirection we will automatically redirect to this url with the result and checkoutId.  If using in-context we will not automatically redirect to this URI. | 
+
+

data/docs/CheckoutFeatures.md

@@ -0,0 +1,8 @@
+# ZipMoney::CheckoutFeatures
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tokenisation** | [**CheckoutFeaturesTokenisation**](CheckoutFeaturesTokenisation.md) |  | [optional] 
+
+

data/docs/CheckoutFeaturesTokenisation.md

@@ -0,0 +1,8 @@
+# ZipMoney::CheckoutFeaturesTokenisation
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**required** | **BOOLEAN** | States if the tokenisation is required to proceed with the checkout. | [optional] [default to true]
+
+

data/docs/CheckoutOrder.md

@@ -0,0 +1,13 @@
+# ZipMoney::CheckoutOrder
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**reference** | **String** | The order id in the eCommerce system | [optional] 
+**amount** | **Float** | The total amount of the order | 
+**currency** | **String** | The ISO-4217 currency code. See https://en.wikipedia.org/wiki/ISO_4217 | 
+**shipping** | [**OrderShipping**](OrderShipping.md) |  | 
+**items** | [**Array<OrderItem>**](OrderItem.md) | The order item breakdown | [optional] 
+**cart_reference** | **String** | The shopping cart reference id | [optional] 
+
+

data/docs/CheckoutsApi.md

@@ -0,0 +1,119 @@
+# ZipMoney::CheckoutsApi
+
+All URIs are relative to *https://api.sandbox.zipmoney.com.au/merchant/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**checkouts_create**](CheckoutsApi.md#checkouts_create) | **POST** /checkouts | Create a checkout
+[**checkouts_get**](CheckoutsApi.md#checkouts_get) | **GET** /checkouts/{id} | Retrieve a checkout
+
+
+# **checkouts_create**
+> Checkout checkouts_create(opts)
+
+Create a checkout
+
+Creates a zipMoney checkout.  During the checkout process a customer can apply for credit decisioning in real-time. This means the checkout needs to represent a good picture of known customer details along with order information and the checkout entity represents this as a resource.  For more information on how to checkout with zipMoney see the #model:Z2QcrzRGHACY8wM6G guide.
+
+### 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::CheckoutsApi.new
+
+opts = { 
+  body: ZipMoney::CreateCheckoutRequest.new # CreateCheckoutRequest | 
+}
+
+begin
+  #Create a checkout
+  result = api_instance.checkouts_create(opts)
+  p result
+rescue ZipMoney::ApiError => e
+  puts "Exception when calling CheckoutsApi->checkouts_create: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**CreateCheckoutRequest**](CreateCheckoutRequest.md)|  | [optional] 
+
+### Return type
+
+[**Checkout**](Checkout.md)
+
+### Authorization
+
+[Authorization](../README.md#Authorization)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **checkouts_get**
+> Checkout checkouts_get(id)
+
+Retrieve a checkout
+
+Retrieves a previously created checkout by id.
+
+### 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::CheckoutsApi.new
+
+id = "id_example" # String | 
+
+
+begin
+  #Retrieve a checkout
+  result = api_instance.checkouts_get(id)
+  p result
+rescue ZipMoney::ApiError => e
+  puts "Exception when calling CheckoutsApi->checkouts_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**|  | 
+
+### Return type
+
+[**Checkout**](Checkout.md)
+
+### Authorization
+
+[Authorization](../README.md#Authorization)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/CreateChargeRequest.md

@@ -0,0 +1,14 @@
+# ZipMoney::CreateChargeRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**authority** | [**Authority**](Authority.md) |  | 
+**reference** | **String** | The reference for this charge (unique payment reference in your store) | [optional] 
+**amount** | **Float** | The amount of the charge | 
+**currency** | **String** | The currency | 
+**capture** | **BOOLEAN** | If true this will be a direct capture, pass false to perform an authorisation only | [optional] [default to true]
+**order** | [**ChargeOrder**](ChargeOrder.md) |  | [optional] 
+**metadata** | **Object** |  | [optional] 
+
+

data/docs/CreateCheckoutRequest.md

@@ -0,0 +1,13 @@
+# ZipMoney::CreateCheckoutRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The checkout type. | [optional] [default to "standard"]
+**shopper** | [**Shopper**](Shopper.md) |  | [optional] 
+**order** | [**CheckoutOrder**](CheckoutOrder.md) |  | 
+**features** | [**CreateCheckoutRequestFeatures**](CreateCheckoutRequestFeatures.md) |  | [optional] 
+**metadata** | [**Metadata**](Metadata.md) |  | [optional] 
+**config** | [**CheckoutConfiguration**](CheckoutConfiguration.md) |  | 
+
+

data/docs/CreateCheckoutRequestFeatures.md

@@ -0,0 +1,8 @@
+# ZipMoney::CreateCheckoutRequestFeatures
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tokenisation** | [**CreateCheckoutRequestFeaturesTokenisation**](CreateCheckoutRequestFeaturesTokenisation.md) |  | [optional] 
+
+

data/docs/CreateCheckoutRequestFeaturesTokenisation.md

@@ -0,0 +1,8 @@
+# ZipMoney::CreateCheckoutRequestFeaturesTokenisation
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**required** | **BOOLEAN** | States if tokenisation is required for the checkout to proceed. | [default to false]
+
+

data/docs/CreateRefundRequest.md

@@ -0,0 +1,11 @@
+# ZipMoney::CreateRefundRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**charge_id** | **String** | The id relating to the original charge that is to be refunded | 
+**reason** | **String** | The reason for the refund | 
+**amount** | **Float** | The amount to refund, can be less than or equal to the previously captured amount | 
+**metadata** | **Object** | Additional metadata if required | [optional] 
+
+

data/docs/CreateTokenRequest.md

@@ -0,0 +1,8 @@
+# ZipMoney::CreateTokenRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**authority** | [**Authority**](Authority.md) |  | 
+
+

data/docs/Customer.md

@@ -0,0 +1,15 @@
+# ZipMoney::Customer
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**title** | **String** | Customer's title | [optional] 
+**first_name** | **String** | Customer's first name | 
+**middle_name** | **String** | Customer's middle name | [optional] 
+**last_name** | **String** | Customer's last name | 
+**phone** | **String** | Customer's phone number | 
+**email** | **String** | Customer's email | 
+**birth_date** | **Date** | Customer's date of birth | 
+**gender** | **String** | Customer's gender | [optional] 
+
+

data/docs/CustomersApi.md

@@ -0,0 +1,96 @@
+# ZipMoney::CustomersApi
+
+All URIs are relative to *https://api.sandbox.zipmoney.com.au/merchant/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**customers_get**](CustomersApi.md#customers_get) | **GET** /customers/{id} | Retrieve customer
+[**customers_list**](CustomersApi.md#customers_list) | **GET** /customers | List customers
+
+
+# **customers_get**
+> customers_get(id)
+
+Retrieve customer
+
+Retrieves the details of a customer by id. This will only return customer details for customers who have transacted previously via the zip Merchant API.
+
+### Example
+```ruby
+# load the gem
+require 'zip_money'
+
+api_instance = ZipMoney::CustomersApi.new
+
+id = "id_example" # String | 
+
+
+begin
+  #Retrieve customer
+  api_instance.customers_get(id)
+rescue ZipMoney::ApiError => e
+  puts "Exception when calling CustomersApi->customers_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/javascript
+ - **Accept**: application/javascript
+
+
+
+# **customers_list**
+> customers_list
+
+List customers
+
+Returns a list of all customers who have transacted previously with your merchant account.
+
+### Example
+```ruby
+# load the gem
+require 'zip_money'
+
+api_instance = ZipMoney::CustomersApi.new
+
+begin
+  #List customers
+  api_instance.customers_list
+rescue ZipMoney::ApiError => e
+  puts "Exception when calling CustomersApi->customers_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/ErrorResponse.md

@@ -0,0 +1,8 @@
+# ZipMoney::ErrorResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error** | [**ErrorResponseError**](ErrorResponseError.md) |  | [optional] 
+
+

data/docs/ErrorResponseError.md

@@ -0,0 +1,10 @@
+# ZipMoney::ErrorResponseError
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **String** |  | 
+**message** | **String** |  | 
+**details** | [**Array<ErrorResponseErrorDetails>**](ErrorResponseErrorDetails.md) |  | [optional] 
+
+

data/docs/ErrorResponseErrorDetails.md

@@ -0,0 +1,9 @@
+# ZipMoney::ErrorResponseErrorDetails
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | [optional] 
+**message** | **String** |  | [optional] 
+
+

data/docs/InlineResponse200.md

@@ -0,0 +1,8 @@
+# ZipMoney::InlineResponse200
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**items** | [**Array<Refund>**](Refund.md) |  | 
+
+

data/docs/Metadata.md

@@ -0,0 +1,7 @@
+# ZipMoney::Metadata
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/OrderItem.md

@@ -0,0 +1,16 @@
+# ZipMoney::OrderItem
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | 
+**amount** | **Float** |  | 
+**reference** | **String** |  | [optional] 
+**description** | **String** |  | [optional] 
+**quantity** | **Integer** |  | [optional] 
+**type** | **String** |  | 
+**image_uri** | **String** |  | [optional] 
+**item_uri** | **String** |  | [optional] 
+**product_code** | **String** |  | [optional] 
+
+

data/docs/OrderShipping.md

@@ -0,0 +1,10 @@
+# ZipMoney::OrderShipping
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pickup** | **BOOLEAN** | States if the shipping method is pickup, otherwise the shipping address should be provided | [optional] 
+**tracking** | [**OrderShippingTracking**](OrderShippingTracking.md) |  | [optional] 
+**address** | [**Address**](Address.md) |  | [optional] 
+
+