RubyGems - voucherify - Versions diffs - 5.0.1 → 7.0.0 - Mend

voucherify 5.0.1 → 7.0.0

Files changed (2894) hide show

data/docs/CustomersApi.md CHANGED Viewed

@@ -9,13 +9,14 @@ All URIs are relative to *https://api.voucherify.io*
 | [**delete_customer**](CustomersApi.md#delete_customer) | **DELETE** /v1/customers/{customerId} | Delete Customer |
 | [**get_customer**](CustomersApi.md#get_customer) | **GET** /v1/customers/{customerId} | Get Customer |
 | [**import_customers_using_csv**](CustomersApi.md#import_customers_using_csv) | **POST** /v1/customers/importCSV | Import and Update Customers using CSV |
-| [**list_customer_activities**](CustomersApi.md#list_customer_activities) | **GET** /v1/customers/{customerId}/activities | List Customer Activities |
+| [**list_customer_activities**](CustomersApi.md#list_customer_activities) | **GET** /v1/customers/{customerId}/activities | List Customer Activities [Deprecated] |
+| [**list_customer_activity**](CustomersApi.md#list_customer_activity) | **GET** /v1/customers/{customerId}/activity | List Customer Activity |
+| [**list_customer_redeemables**](CustomersApi.md#list_customer_redeemables) | **GET** /v1/customers/{customerId}/redeemables | List Customer&#39;s Redeemables |
 | [**list_customer_segments**](CustomersApi.md#list_customer_segments) | **GET** /v1/customers/{customerId}/segments | List Customer&#39;s Segments |
 | [**list_customers**](CustomersApi.md#list_customers) | **GET** /v1/customers | List Customers |
 | [**update_customer**](CustomersApi.md#update_customer) | **PUT** /v1/customers/{customerId} | Update Customer |
-| [**update_customers_consents**](CustomersApi.md#update_customers_consents) | **PUT** /v1/customers/{customerId}/consents | Update Customer&#39;s consents |
-| [**update_customers_in_bulk**](CustomersApi.md#update_customers_in_bulk) | **POST** /v1/customers/bulk/async | Update Customers in bulk |
-| [**update_customers_metadata_in_bulk**](CustomersApi.md#update_customers_metadata_in_bulk) | **POST** /v1/customers/metadata/async | Update Customers&#39; Metadata in bulk |
+| [**update_customers_in_bulk**](CustomersApi.md#update_customers_in_bulk) | **POST** /v1/customers/bulk/async | Update Customers in Bulk |
+| [**update_customers_metadata_in_bulk**](CustomersApi.md#update_customers_metadata_in_bulk) | **POST** /v1/customers/metadata/async | Update Customers&#39; Metadata in Bulk |
 ## create_customer
@@ -253,7 +254,7 @@ end
 ## import_customers_using_csv
-> <CustomersImportCsvCreateResponseBody> import_customers_using_csv(file)
+> <CustomersImportCsvCreateResponseBody> import_customers_using_csv(opts)
 Import and Update Customers using CSV
@@ -278,11 +279,13 @@ VoucherifySdk.configure do |config|
 end
 api_instance = VoucherifySdk::CustomersApi.new
-file = File.new('/path/to/some/file') # File | File path.
+opts = {
+  file: File.new('/path/to/some/file') # File | File path.
+}
 begin
   # Import and Update Customers using CSV
-  result = api_instance.import_customers_using_csv(file)
+  result = api_instance.import_customers_using_csv(opts)
   p result
 rescue VoucherifySdk::ApiError => e
   puts "Error when calling CustomersApi->import_customers_using_csv: #{e}"
@@ -293,7 +296,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **file** | **File** | File path. |  |
+| **file** | **File** | File path. | [optional] |
 ### Return type
@@ -313,9 +316,9 @@ end
 > <CustomersActivitiesListResponseBody> list_customer_activities(customer_id, opts)
-List Customer Activities
+List Customer Activities [Deprecated]
-Retrieve customer activities.
+> ❗️ Deprecated    This endpoint represents the deprecated version of the API responsible for listing customer activities and we do not recommend using it. Developers are encouraged to migrate to the latest version to take advantage of the latest enhancements and bug fixes. No updates will be provided to the deprecated endpoint. Retrieve customer activities.
 ### Examples
@@ -338,10 +341,10 @@ end
 api_instance = VoucherifySdk::CustomersApi.new
 customer_id = 'customer_id_example' # String | A Voucherify customers id or source ID of the customer who performed the activities.
 opts = {
-  limit: 56, # Integer | A limit on the number of objects to be returned. Limit can range between 1 and 100 items.
+  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.
   order: VoucherifySdk::ParameterOrder::CREATED_AT, # ParameterOrder | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.
-  starting_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | A cursor for use in pagination. starting_after is a date-time value that defines your place in the list based on created_at property from the activity object. For instance, if you make a list request and receive 100 objects, ending with an object created at 2020-05-24T13:43:09.024Z, your subsequent call can include starting_after 2020-05-24T13:43:09.024Z in order to fetch the next page of the list.
-  starting_after_id: 'starting_after_id_example', # String | By applying this filter value, you will get events starting after an event with the given ID.
+  starting_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | A cursor for pagination. starting_after is a date-time value that defines your place in the list based on created_at property from the activity object. For instance, if you make a list request and receive 100 objects, ending with an object created at 2020-05-24T13:43:09.024Z, your subsequent call can include starting_after 2020-05-24T13:43:09.024Z in order to fetch the next page of the list.
+  starting_after_id: 'starting_after_id_example', # String | A cursor for pagination. It retrieves the events starting after an event with the given ID.
   campaign_type: VoucherifySdk::ParameterCampaignType::PROMOTION, # ParameterCampaignType | Through this parameter you can control a type of campaign by which Voucherify will filter related customers activity. API will return only records related to that given type. Allowed values: DISCOUNT_COUPONS, REFERRAL_PROGRAM, GIFT_VOUCHERS, PROMOTION, LOYALTY_PROGRAM
   campaign_id: 'campaign_id_example', # String | By applying this parameter you request only events related to specific campaign identified by its ID.
   product_id: 'product_id_example', # String | By applying this parameter you request only events related to specific product identified by its ID.
@@ -350,7 +353,7 @@ opts = {
 }
 begin
-  # List Customer Activities
+  # List Customer Activities [Deprecated]
   result = api_instance.list_customer_activities(customer_id, opts)
   p result
 rescue VoucherifySdk::ApiError => e
@@ -363,10 +366,10 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **customer_id** | **String** | A Voucherify customers id or source ID of the customer who performed the activities. |  |
-| **limit** | **Integer** | A limit on the number of objects to be returned. Limit can range between 1 and 100 items. | [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] |
 | **order** | [**ParameterOrder**](.md) | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. | [optional] |
-| **starting_after** | **Time** | A cursor for use in pagination. starting_after is a date-time value that defines your place in the list based on created_at property from the activity object. For instance, if you make a list request and receive 100 objects, ending with an object created at 2020-05-24T13:43:09.024Z, your subsequent call can include starting_after 2020-05-24T13:43:09.024Z in order to fetch the next page of the list. | [optional] |
-| **starting_after_id** | **String** | By applying this filter value, you will get events starting after an event with the given ID. | [optional] |
+| **starting_after** | **Time** | A cursor for pagination. starting_after is a date-time value that defines your place in the list based on created_at property from the activity object. For instance, if you make a list request and receive 100 objects, ending with an object created at 2020-05-24T13:43:09.024Z, your subsequent call can include starting_after 2020-05-24T13:43:09.024Z in order to fetch the next page of the list. | [optional] |
+| **starting_after_id** | **String** | A cursor for pagination. It retrieves the events starting after an event with the given ID. | [optional] |
 | **campaign_type** | [**ParameterCampaignType**](.md) | Through this parameter you can control a type of campaign by which Voucherify will filter related customers activity. API will return only records related to that given type. Allowed values: DISCOUNT_COUPONS, REFERRAL_PROGRAM, GIFT_VOUCHERS, PROMOTION, LOYALTY_PROGRAM | [optional] |
 | **campaign_id** | **String** | By applying this parameter you request only events related to specific campaign identified by its ID. | [optional] |
 | **product_id** | **String** | By applying this parameter you request only events related to specific product identified by its ID. | [optional] |
@@ -387,6 +390,152 @@ end
 - **Accept**: application/json
+## list_customer_activity
+> <CustomersActivityListResponseBody> list_customer_activity(customer_id, opts)
+List Customer Activity
+Retrieve customer activities.
+### Examples
+```ruby
+require 'time'
+require 'VoucherifySdk'
+# setup authorization
+VoucherifySdk.configure do |config|
+  # Configure API key authorization: X-App-Id
+  config.api_key['X-App-Id'] = '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['X-App-Id'] = 'Bearer'
+  # Configure API key authorization: X-App-Token
+  config.api_key['X-App-Token'] = '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['X-App-Token'] = 'Bearer'
+end
+api_instance = VoucherifySdk::CustomersApi.new
+customer_id = 'customer_id_example' # String | A Voucherify customers id or source ID of the customer who performed the activities.
+opts = {
+  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.
+  order: VoucherifySdk::ParameterOrderCreatedAt::CREATED_AT, # ParameterOrderCreatedAt | Apply this filter to order the events according the date and time when it was created.
+  starting_after_id: 'starting_after_id_example', # String | A cursor for pagination. It retrieves the events starting after an event with the given ID.
+  start_date: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Timestamp representing the date and time which results must begin on. Represented in ISO 8601 format.
+  end_date: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Timestamp representing the date and time which results must end on. Represented in ISO 8601 format.
+  campaign_id: 'campaign_id_example', # String | Requests only events related to specific campaign identified by its ID.
+  campaign_type: VoucherifySdk::ParameterCampaignType::PROMOTION, # ParameterCampaignType | Filters related customers activity for the selected campaign types. Allowed values:  DISCOUNT_COUPONS, REFERRAL_PROGRAM, GIFT_VOUCHERS, PROMOTION, LOYALTY_PROGRAM.
+  category: VoucherifySdk::ParameterActivityCategory::ACTION, # ParameterActivityCategory | Filters activities for actions or effects. Allowed values:  ACTION, EFFECT.
+  type: 'type_example' # String | Event name of the customer event.
+}
+begin
+  # List Customer Activity
+  result = api_instance.list_customer_activity(customer_id, opts)
+  p result
+rescue VoucherifySdk::ApiError => e
+  puts "Error when calling CustomersApi->list_customer_activity: #{e}"
+end
+```
+### Parameters
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **customer_id** | **String** | A Voucherify customers id or source ID of the customer who performed the activities. |  |
+| **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] |
+| **order** | [**ParameterOrderCreatedAt**](.md) | Apply this filter to order the events according the date and time when it was created.  | [optional] |
+| **starting_after_id** | **String** | A cursor for pagination. It retrieves the events starting after an event with the given ID. | [optional] |
+| **start_date** | **Time** | Timestamp representing the date and time which results must begin on. Represented in ISO 8601 format. | [optional] |
+| **end_date** | **Time** | Timestamp representing the date and time which results must end on. Represented in ISO 8601 format. | [optional] |
+| **campaign_id** | **String** | Requests only events related to specific campaign identified by its ID. | [optional] |
+| **campaign_type** | [**ParameterCampaignType**](.md) | Filters related customers activity for the selected campaign types. Allowed values:  DISCOUNT_COUPONS, REFERRAL_PROGRAM, GIFT_VOUCHERS, PROMOTION, LOYALTY_PROGRAM. | [optional] |
+| **category** | [**ParameterActivityCategory**](.md) | Filters activities for actions or effects. Allowed values:  ACTION, EFFECT. | [optional] |
+| **type** | **String** | Event name of the customer event. | [optional] |
+### Return type
+[**CustomersActivityListResponseBody**](CustomersActivityListResponseBody.md)
+### Authorization
+[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
+### HTTP request headers
+- **Content-Type**: Not defined
+- **Accept**: application/json
+## list_customer_redeemables
+> <CustomersRedeemablesListResponseBody> list_customer_redeemables(customer_id, opts)
+List Customer's Redeemables
+Retrieves all the redeemables that have been assigned to the customer. To use this endpoint, you must have the following permissions: - Read Customers (customers.details.read)
+### Examples
+```ruby
+require 'time'
+require 'VoucherifySdk'
+# setup authorization
+VoucherifySdk.configure do |config|
+  # Configure API key authorization: X-App-Id
+  config.api_key['X-App-Id'] = '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['X-App-Id'] = 'Bearer'
+  # Configure API key authorization: X-App-Token
+  config.api_key['X-App-Token'] = '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['X-App-Token'] = 'Bearer'
+end
+api_instance = VoucherifySdk::CustomersApi.new
+customer_id = 'customer_id_example' # String | Unique identifier of a customer represented by an internal customer ID or customer source ID.
+opts = {
+  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.
+  order: VoucherifySdk::ParameterOrderListRedeemables::ID, # ParameterOrderListRedeemables | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.
+  starting_after_id: 'starting_after_id_example', # String | A cursor for pagination. It retrieves the events starting after an event with the given ID.
+  filters: VoucherifySdk::ParameterFiltersListCustomerRedeemables.new # ParameterFiltersListCustomerRedeemables | Filters for listing customer redeemables.
+}
+begin
+  # List Customer's Redeemables
+  result = api_instance.list_customer_redeemables(customer_id, opts)
+  p result
+rescue VoucherifySdk::ApiError => e
+  puts "Error when calling CustomersApi->list_customer_redeemables: #{e}"
+end
+```
+### Parameters
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **customer_id** | **String** | Unique identifier of a customer represented by an internal customer ID or customer source ID. |  |
+| **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] |
+| **order** | [**ParameterOrderListRedeemables**](.md) | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. | [optional] |
+| **starting_after_id** | **String** | A cursor for pagination. It retrieves the events starting after an event with the given ID. | [optional] |
+| **filters** | [**ParameterFiltersListCustomerRedeemables**](.md) | Filters for listing customer redeemables. | [optional] |
+### Return type
+[**CustomersRedeemablesListResponseBody**](CustomersRedeemablesListResponseBody.md)
+### Authorization
+[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
+### HTTP request headers
+- **Content-Type**: Not defined
+- **Accept**: application/json
 ## list_customer_segments
 > <CustomersSegmentsListResponseBody> list_customer_segments(customer_id)
@@ -473,8 +622,8 @@ end
 api_instance = VoucherifySdk::CustomersApi.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.
   email: 'email_example', # String | Limit the customers to the ones that have this specific email address.
   city: 'city_example', # String | Limit the customers to the ones that are located in the specified city.
   name: 'name_example', # String | Filter customers by the name property.
@@ -484,7 +633,7 @@ opts = {
   updated_at_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filter customers by date customer was updated last time.
   updated_at_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filter customers by date customer was updated last time.
   order: VoucherifySdk::ParameterOrderListCustomers::CREATED_AT, # ParameterOrderListCustomers | This is a property that controls the sorting direction of the results. Sort the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.
-  starting_after: Time.parse('2013-10-20T19:20:30+01:00') # Time | A cursor for use in pagination. This is a date-time value that defines your place in the list based on created_at property from the customer object. For instance, if you make a list request and receive 100 objects, ending with an object created at 2020-05-24T13:43:09.024Z, your subsequent call can include starting_after 2020-05-24T13:43:09.024Z in order to fetch the next page of the list.
+  starting_after: Time.parse('2013-10-20T19:20:30+01:00') # Time | A cursor for pagination. This is a date-time value that defines your place in the list based on created_at property from the customer object. For instance, if you make a list request and receive 100 objects, ending with an object created at 2020-05-24T13:43:09.024Z, your subsequent call can include starting_after 2020-05-24T13:43:09.024Z in order to fetch the next page of the list.
 }
 begin
@@ -500,8 +649,8 @@ end
 | 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] |
 | **email** | **String** | Limit the customers to the ones that have this specific email address. | [optional] |
 | **city** | **String** | Limit the customers to the ones that are located in the specified city. | [optional] |
 | **name** | **String** | Filter customers by the name property. | [optional] |
@@ -511,7 +660,7 @@ end
 | **updated_at_before** | **Time** | Filter customers by date customer was updated last time. | [optional] |
 | **updated_at_after** | **Time** | Filter customers by date customer was updated last time. | [optional] |
 | **order** | [**ParameterOrderListCustomers**](.md) | This is a property that controls the sorting direction of the results. Sort the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. | [optional] |
-| **starting_after** | **Time** | A cursor for use in pagination. This is a date-time value that defines your place in the list based on created_at property from the customer object. For instance, if you make a list request and receive 100 objects, ending with an object created at 2020-05-24T13:43:09.024Z, your subsequent call can include starting_after 2020-05-24T13:43:09.024Z in order to fetch the next page of the list.   | [optional] |
+| **starting_after** | **Time** | A cursor for pagination. This is a date-time value that defines your place in the list based on created_at property from the customer object. For instance, if you make a list request and receive 100 objects, ending with an object created at 2020-05-24T13:43:09.024Z, your subsequent call can include starting_after 2020-05-24T13:43:09.024Z in order to fetch the next page of the list.   | [optional] |
 ### Return type
@@ -589,74 +738,13 @@ end
 - **Accept**: application/json
-## update_customers_consents
-> update_customers_consents(customer_id, opts)
-Update Customer's consents
-Update marketing permissions for the specified customer.
-### Examples
-```ruby
-require 'time'
-require 'VoucherifySdk'
-# setup authorization
-VoucherifySdk.configure do |config|
-  # Configure API key authorization: X-App-Id
-  config.api_key['X-App-Id'] = '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['X-App-Id'] = 'Bearer'
-  # Configure API key authorization: X-App-Token
-  config.api_key['X-App-Token'] = '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['X-App-Token'] = 'Bearer'
-end
-api_instance = VoucherifySdk::CustomersApi.new
-customer_id = 'customer_id_example' # String | A Voucherify unique customer identifier or source ID.
-opts = {
-  body: { ... } # Object | Key-value pairs where the key is the consent identifier and value is a boolean that identifies if a customer has given the consent or not. To deny all consents use unsubscribed as a consent identifier and true as its value.   ## Examples  Opt-out from all communication:
-}
-begin
-  # Update Customer's consents
-  api_instance.update_customers_consents(customer_id, opts)
-rescue VoucherifySdk::ApiError => e
-  puts "Error when calling CustomersApi->update_customers_consents: #{e}"
-end
-```
-### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **customer_id** | **String** | A Voucherify unique customer identifier or source ID. |  |
-| **body** | **Object** | Key-value pairs where the key is the consent identifier and value is a boolean that identifies if a customer has given the consent or not. To deny all consents use unsubscribed as a consent identifier and true as its value.   ## Examples  Opt-out from all communication:  | [optional] |
-### Return type
-nil (empty response body)
-### Authorization
-[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
-### HTTP request headers
-- **Content-Type**: application/json
-- **Accept**: Not defined
 ## update_customers_in_bulk
 > <CustomersUpdateInBulkResponseBody> update_customers_in_bulk(opts)
-Update Customers in bulk
+Update Customers in Bulk
-Update several customers in one asynchronous operation.  In one request, it is possible to update a maximum of **100** records. In the response body, you get a unique async action identifier.   If a requested customer object is not found, then an **upsert** occurs. This is reflected in the Get Async Action endpoint as follows:    This API request starts a process that affects Voucherify data in bulk.  In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window.  The result will return the async ID. You can verify the status of your request via this API request.
+Updates customers in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the GET Async Action endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a customer object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished.
 ### Examples
@@ -678,11 +766,11 @@ end
 api_instance = VoucherifySdk::CustomersApi.new
 opts = {
-  customers_update_in_bulk_request_body: [VoucherifySdk::CustomersUpdateInBulkRequestBody.new({source_id: 'source_id_example'})] # Array<CustomersUpdateInBulkRequestBody> | Specify the customer fields that you would like to update in each customer object.
+  customers_update_in_bulk_request_body: [VoucherifySdk::CustomersUpdateInBulkRequestBody.new] # Array<CustomersUpdateInBulkRequestBody> | List the customer fields to be updated in each customer object.
 }
 begin
-  # Update Customers in bulk
+  # Update Customers in Bulk
   result = api_instance.update_customers_in_bulk(opts)
   p result
 rescue VoucherifySdk::ApiError => e
@@ -694,7 +782,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **customers_update_in_bulk_request_body** | [**Array&lt;CustomersUpdateInBulkRequestBody&gt;**](CustomersUpdateInBulkRequestBody.md) | Specify the customer fields that you would like to update in each customer object. | [optional] |
+| **customers_update_in_bulk_request_body** | [**Array&lt;CustomersUpdateInBulkRequestBody&gt;**](CustomersUpdateInBulkRequestBody.md) | List the customer fields to be updated in each customer object. | [optional] |
 ### Return type
@@ -714,9 +802,9 @@ end
 > <CustomersMetadataUpdateInBulkResponseBody> update_customers_metadata_in_bulk(opts)
-Update Customers' Metadata in bulk
+Update Customers' Metadata in Bulk
-Update several customers metadata properties in one asynchronous operation.  In one request, it is possible to update a maximum of **100** records. In the response body, you get a unique async action identifier.   If a requested customer object is not found, then an **upsert** occurs. This is reflected in the Get Async Action endpoint as follows:    This API request starts a process that affects Voucherify data in bulk.  In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window.  The result will return the async ID. You can verify the status of your request via this API request.
+Updates metadata parameters for a list of customers. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the GET Async Action endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished.
 ### Examples
@@ -738,11 +826,11 @@ end
 api_instance = VoucherifySdk::CustomersApi.new
 opts = {
-  customers_metadata_update_in_bulk_request_body: VoucherifySdk::CustomersMetadataUpdateInBulkRequestBody.new({source_ids: ['source_ids_example'], metadata: 3.56}) # CustomersMetadataUpdateInBulkRequestBody | List the source_ids of the customers you would like to update along with the metadata key value pairs.
+  customers_metadata_update_in_bulk_request_body: VoucherifySdk::CustomersMetadataUpdateInBulkRequestBody.new # CustomersMetadataUpdateInBulkRequestBody | List the source_ids of the customers you would like to update with the metadata key/value pairs.
 }
 begin
-  # Update Customers' Metadata in bulk
+  # Update Customers' Metadata in Bulk
   result = api_instance.update_customers_metadata_in_bulk(opts)
   p result
 rescue VoucherifySdk::ApiError => e
@@ -754,7 +842,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **customers_metadata_update_in_bulk_request_body** | [**CustomersMetadataUpdateInBulkRequestBody**](CustomersMetadataUpdateInBulkRequestBody.md) | List the source_ids of the customers you would like to update along with the metadata key value pairs. | [optional] |
+| **customers_metadata_update_in_bulk_request_body** | [**CustomersMetadataUpdateInBulkRequestBody**](CustomersMetadataUpdateInBulkRequestBody.md) | List the source_ids of the customers you would like to update with the metadata key/value pairs. | [optional] |
 ### Return type

data/docs/CustomersCreateRequestBody.md CHANGED Viewed

@@ -10,8 +10,8 @@
 | **description** | **String** | An arbitrary string that you can attach to a customer object. | [optional] |
 | **email** | **String** | Customer&#39;s email address. | [optional] |
 | **phone** | **String** | Customer&#39;s phone number. This parameter is mandatory when you try to send out codes to customers via an SMS channel. | [optional] |
-| **birthday** | **Date** | *Deprecated* Customer&#39;s birthdate; format YYYY-MM-DD. | [optional] |
+| **birthday** | **Date** | &#x60;Deprecated&#x60;. ~~Customer&#39;s birthdate; format YYYY-MM-DD~~. | [optional] |
 | **birthdate** | **Date** | Customer&#39;s birthdate; format YYYY-MM-DD. | [optional] |
-| **address** | [**CustomerBaseAddress**](CustomerBaseAddress.md) |  | [optional] |
+| **address** | [**CustomersCreateRequestBodyAddress**](CustomersCreateRequestBodyAddress.md) |  | [optional] |
 | **metadata** | **Object** | A set of custom key/value pairs that you can attach to a customer. The metadata object stores all custom attributes assigned to the customer. It can be useful for storing additional information about the customer in a structured format. This metadata can be used for validating whether the customer qualifies for a discount or it can be used in building customer segments. | [optional] |

data/docs/CustomersCreateRequestBodyAddress.md ADDED Viewed

@@ -0,0 +1,13 @@
+# VoucherifySdk::CustomersCreateRequestBodyAddress
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **city** | **String** | City | [optional] |
+| **state** | **String** | State | [optional] |
+| **line_1** | **String** | First line of address. | [optional] |
+| **line_2** | **String** | Second line of address. | [optional] |
+| **country** | **String** | Country. | [optional] |
+| **postal_code** | **String** | Postal code. | [optional] |

data/docs/CustomersCreateResponseBody.md CHANGED Viewed

@@ -6,20 +6,20 @@
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** | The ID of an existing customer that will be linked to redemption in this request. | [optional] |
 | **source_id** | **String** | A unique identifier of the customer who validates a voucher. It can be a customer ID or email from a CRM system, database, or a third-party service. If you also pass a customer ID (unique ID assigned by Voucherify), the source ID will be ignored. | [optional] |
-| **summary** | [**CustomerSummary**](CustomerSummary.md) |  |  |
-| **loyalty** | [**CustomerLoyalty**](CustomerLoyalty.md) |  |  |
-| **referrals** | [**CustomerReferrals**](CustomerReferrals.md) |  |  |
+| **summary** | [**CustomerSummary**](CustomerSummary.md) |  | [optional] |
+| **loyalty** | [**CustomerLoyalty**](CustomerLoyalty.md) |  | [optional] |
+| **referrals** | [**CustomerReferrals**](CustomerReferrals.md) |  | [optional] |
 | **system_metadata** | **Object** | Object used to store system metadata information. | [optional] |
-| **created_at** | **Time** | Timestamp representing the date and time when the customer was created in ISO 8601 format. | [optional] |
-| **updated_at** | **Time** | Timestamp representing the date and time when the customer was updated in ISO 8601 format. | [optional] |
-| **assets** | [**CustomerResponseDataAssets**](CustomerResponseDataAssets.md) |  | [optional] |
-| **object** | **String** | The type of object represented by JSON. | [default to &#39;customer&#39;] |
+| **created_at** | **Time** | Timestamp representing the date and time when the customer was created. The value is shown in the ISO 8601 format. | [optional] |
+| **updated_at** | **Time** | Timestamp representing the date and time when the customer was updated. The value is shown in the ISO 8601 format. | [optional] |
+| **assets** | [**CustomersCreateResponseBodyAssets**](CustomersCreateResponseBodyAssets.md) |  | [optional] |
+| **object** | **String** | The type of the object represented by JSON. | [optional][default to &#39;customer&#39;] |
 | **name** | **String** | Customer&#39;s first and last name. | [optional] |
 | **description** | **String** | An arbitrary string that you can attach to a customer object. | [optional] |
 | **email** | **String** | Customer&#39;s email address. | [optional] |
 | **phone** | **String** | Customer&#39;s phone number. This parameter is mandatory when you try to send out codes to customers via an SMS channel. | [optional] |
-| **birthday** | **Date** | *Deprecated* Customer&#39;s birthdate; format YYYY-MM-DD. | [optional] |
+| **birthday** | **Date** | &#x60;Deprecated&#x60;. ~~Customer&#39;s birthdate; format YYYY-MM-DD~~. | [optional] |
 | **birthdate** | **Date** | Customer&#39;s birthdate; format YYYY-MM-DD. | [optional] |
-| **address** | [**CustomerBaseAddress**](CustomerBaseAddress.md) |  | [optional] |
+| **address** | [**CustomersCreateResponseBodyAddress**](CustomersCreateResponseBodyAddress.md) |  | [optional] |
 | **metadata** | **Object** | A set of custom key/value pairs that you can attach to a customer. The metadata object stores all custom attributes assigned to the customer. It can be useful for storing additional information about the customer in a structured format. This metadata can be used for validating whether the customer qualifies for a discount or it can be used in building customer segments. | [optional] |

data/docs/CustomersCreateResponseBodyAddress.md ADDED Viewed

@@ -0,0 +1,13 @@
+# VoucherifySdk::CustomersCreateResponseBodyAddress
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **city** | **String** | City | [optional] |
+| **state** | **String** | State | [optional] |
+| **line_1** | **String** | First line of address. | [optional] |
+| **line_2** | **String** | Second line of address. | [optional] |
+| **country** | **String** | Country. | [optional] |
+| **postal_code** | **String** | Postal code. | [optional] |

data/docs/CustomersCreateResponseBodyAssets.md ADDED Viewed

@@ -0,0 +1,8 @@
+# VoucherifySdk::CustomersCreateResponseBodyAssets
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cockpit_url** | **String** | Customer&#39;s cockpit URL address. | [optional] |

data/docs/CustomersGetResponseBody.md CHANGED Viewed

@@ -6,20 +6,20 @@
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** | The ID of an existing customer that will be linked to redemption in this request. | [optional] |
 | **source_id** | **String** | A unique identifier of the customer who validates a voucher. It can be a customer ID or email from a CRM system, database, or a third-party service. If you also pass a customer ID (unique ID assigned by Voucherify), the source ID will be ignored. | [optional] |
-| **summary** | [**CustomerSummary**](CustomerSummary.md) |  |  |
-| **loyalty** | [**CustomerLoyalty**](CustomerLoyalty.md) |  |  |
-| **referrals** | [**CustomerReferrals**](CustomerReferrals.md) |  |  |
+| **summary** | [**CustomerSummary**](CustomerSummary.md) |  | [optional] |
+| **loyalty** | [**CustomerLoyalty**](CustomerLoyalty.md) |  | [optional] |
+| **referrals** | [**CustomerReferrals**](CustomerReferrals.md) |  | [optional] |
 | **system_metadata** | **Object** | Object used to store system metadata information. | [optional] |
-| **created_at** | **Time** | Timestamp representing the date and time when the customer was created in ISO 8601 format. | [optional] |
-| **updated_at** | **Time** | Timestamp representing the date and time when the customer was updated in ISO 8601 format. | [optional] |
-| **assets** | [**CustomerResponseDataAssets**](CustomerResponseDataAssets.md) |  | [optional] |
-| **object** | **String** | The type of object represented by JSON. | [default to &#39;customer&#39;] |
+| **created_at** | **Time** | Timestamp representing the date and time when the customer was created. The value is shown in the ISO 8601 format. | [optional] |
+| **updated_at** | **Time** | Timestamp representing the date and time when the customer was updated. The value is shown in the ISO 8601 format. | [optional] |
+| **assets** | [**CustomersGetResponseBodyAssets**](CustomersGetResponseBodyAssets.md) |  | [optional] |
+| **object** | **String** | The type of the object represented by JSON. | [optional][default to &#39;customer&#39;] |
 | **name** | **String** | Customer&#39;s first and last name. | [optional] |
 | **description** | **String** | An arbitrary string that you can attach to a customer object. | [optional] |
 | **email** | **String** | Customer&#39;s email address. | [optional] |
 | **phone** | **String** | Customer&#39;s phone number. This parameter is mandatory when you try to send out codes to customers via an SMS channel. | [optional] |
-| **birthday** | **Date** | *Deprecated* Customer&#39;s birthdate; format YYYY-MM-DD. | [optional] |
+| **birthday** | **Date** | &#x60;Deprecated&#x60;. ~~Customer&#39;s birthdate; format YYYY-MM-DD~~. | [optional] |
 | **birthdate** | **Date** | Customer&#39;s birthdate; format YYYY-MM-DD. | [optional] |
-| **address** | [**CustomerBaseAddress**](CustomerBaseAddress.md) |  | [optional] |
+| **address** | [**CustomersGetResponseBodyAddress**](CustomersGetResponseBodyAddress.md) |  | [optional] |
 | **metadata** | **Object** | A set of custom key/value pairs that you can attach to a customer. The metadata object stores all custom attributes assigned to the customer. It can be useful for storing additional information about the customer in a structured format. This metadata can be used for validating whether the customer qualifies for a discount or it can be used in building customer segments. | [optional] |

data/docs/CustomersGetResponseBodyAddress.md ADDED Viewed

@@ -0,0 +1,13 @@
+# VoucherifySdk::CustomersGetResponseBodyAddress
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **city** | **String** | City | [optional] |
+| **state** | **String** | State | [optional] |
+| **line_1** | **String** | First line of address. | [optional] |
+| **line_2** | **String** | Second line of address. | [optional] |
+| **country** | **String** | Country. | [optional] |
+| **postal_code** | **String** | Postal code. | [optional] |

data/docs/CustomersGetResponseBodyAssets.md ADDED Viewed

@@ -0,0 +1,8 @@
+# VoucherifySdk::CustomersGetResponseBodyAssets
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cockpit_url** | **String** | Customer&#39;s cockpit URL address. | [optional] |

data/docs/CustomersImportCsvCreateResponseBody.md CHANGED Viewed

@@ -4,5 +4,5 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **async_action_id** | **String** | The ID of the scheduled asynchronous action. |  |
+| **async_action_id** | **String** | The ID of the scheduled asynchronous action. | [optional] |

data/docs/CustomersListResponseBody.md CHANGED Viewed

@@ -4,9 +4,9 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **object** | **String** | The type of object represented by JSON. This object stores information about customers in a dictionary. | [default to &#39;list&#39;] |
-| **data_ref** | **String** | Identifies the name of the attribute that contains the array of customer objects. | [default to &#39;customers&#39;] |
-| **customers** | [**Array&lt;CustomerWithSummaryLoyaltyReferrals&gt;**](CustomerWithSummaryLoyaltyReferrals.md) | Contains array of customer objects. |  |
-| **total** | **Integer** | Total number of customers. |  |
-| **has_more** | **Boolean** | As query results are always limited (by the limit parameter), the &#x60;has_more&#x60; flag indicates whether there are more records for given filter parameters. This let&#39;s you know if you are able to run another request (with a different end date filter) to get more records returned in the results. | [optional] |
+| **object** | **String** | The type of the object represented by JSON. This object stores information about customers in a dictionary. | [optional][default to &#39;list&#39;] |
+| **data_ref** | **String** | Identifies the name of the attribute that contains the array of customer objects. | [optional][default to &#39;customers&#39;] |
+| **customers** | [**Array&lt;CustomerWithSummaryLoyaltyReferrals&gt;**](CustomerWithSummaryLoyaltyReferrals.md) | Contains array of customer objects. | [optional] |
+| **total** | **Integer** | Total number of customers. | [optional] |
+| **has_more** | **Boolean** | As query results are always limited (by the limit parameter), the &#x60;has_more&#x60; flag indicates if there are more records for given filter parameters. This lets you know if you can run another request (with a different end date filter) to get more records returned in the results. | [optional] |

data/docs/CustomersMetadataUpdateInBulkRequestBody.md CHANGED Viewed

@@ -4,6 +4,6 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **source_ids** | **Array&lt;String&gt;** | An array of customer &#x60;source_id&#x60;&#39;s. |  |
-| **metadata** | **Object** | Metadata key value pairs to be updated. A set of custom key/value pairs that you can attach to a customer. The metadata object stores all custom attributes assigned to the customer. It can be useful for storing additional information about the customer in a structured format. This metadata can be used for validating whether the customer qualifies for a discount or it can be used in building customer segments. |  |
+| **source_ids** | **Array&lt;String&gt;** | An array of customer &#x60;source_id&#x60;&#39;s. | [optional] |
+| **metadata** | **Object** | Metadata key value pairs to be updated. A set of custom key/value pairs that you can attach to a customer. The metadata object stores all custom attributes assigned to the customer. It can be useful for storing additional information about the customer in a structured format. This metadata can be used for validating whether the customer qualifies for a discount or it can be used in building customer segments. | [optional] |