docs/ExportsApi.md in voucherify-5.0.0 vs docs/ExportsApi.md in voucherify-6.0.0

- old
+ new

@@ -15,11 +15,11 @@ > <ExportsCreateResponseBody> create_export(opts) Create Export -Create export object. The export can be any of the following types: voucher, redemption, publication, customer, order, points_expiration, or voucher_transactions. # Defaults If you only specify the object type in the request body without specifying the fields, the API will return the following fields per export object: # Fetching particular data sets Using the parameters body parameter, you can narrow down which fields to export and how to filter the results. The fields are an array of strings containing the data that you would like to export. These fields define the headers in the CSV file. The array can be a combintation of any of the following available fields: # Orders # Vouchers # Publications # Redemptions # Customers # Points Expirations # Gift Card Transactions # Loyalty Card Transactions +Create export object. The export can be any of the following types: voucher, redemption, publication, customer, order, points_expiration, or voucher_transactions. # Defaults If you only specify the object type in the request body without specifying the fields, the API will return the following fields per export object: # Fetching particular data sets Using the parameters body parameter, you can narrow down which fields to export and how to filter the results. The fields are an array of strings containing the data that you would like to export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: # Orders # Vouchers # Publications # Redemptions # Customers # Points Expirations # Gift Card Transactions # Loyalty Card Transactions ### Examples ```ruby require 'time' @@ -37,11 +37,11 @@ # config.api_key_prefix['X-App-Token'] = 'Bearer' end api_instance = VoucherifySdk::ExportsApi.new opts = { - exports_create_request_body: VoucherifySdk::ExportCustomerBase.new({exported_object: 'customer'}) # ExportsCreateRequestBody | Specify the details of the export that you would like to create. + exports_create_request_body: VoucherifySdk::ExportsCreateRequestBody.new # ExportsCreateRequestBody | Specify the details of the export that you would like to create. } begin # Create Export result = api_instance.create_export(opts) @@ -262,12 +262,12 @@ # config.api_key_prefix['X-App-Token'] = 'Bearer' end api_instance = VoucherifySdk::ExportsApi.new opts = { - limit: 56, # Integer | A limit on the number of objects to be returned. Limit can range between 1 and 100 items. - page: 56, # Integer | Which page of results to return. + limit: 56, # Integer | Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. + page: 56, # Integer | Which page of results to return. The lowest value is 1. order: VoucherifySdk::ParameterOrderListExports::CREATED_AT # ParameterOrderListExports | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. } begin # List Exports @@ -280,11 +280,11 @@ ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| **limit** | **Integer** | A limit on the number of objects to be returned. Limit can range between 1 and 100 items. | [optional] | -| **page** | **Integer** | Which page of results to return. | [optional] | +| **limit** | **Integer** | Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. | [optional] | +| **page** | **Integer** | Which page of results to return. The lowest value is 1. | [optional] | | **order** | [**ParameterOrderListExports**](.md) | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. | [optional] | ### Return type [**ExportsListResponseBody**](ExportsListResponseBody.md)