subskribe_dev 1.2.0 → 1.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (64) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +18 -13
  3. data/docs/AccountingApi.md +1 -1
  4. data/docs/AccountsApi.md +3 -3
  5. data/docs/ApprovalsApi.md +1 -1
  6. data/docs/AttachmentsApi.md +1 -1
  7. data/docs/AuthenticationApi.md +1 -1
  8. data/docs/AutomatedInvoiceRule.md +2 -2
  9. data/docs/BillingApi.md +1 -1
  10. data/docs/BulkInvoiceRunItem.md +2 -2
  11. data/docs/BulkPaymentUploadData.md +3 -3
  12. data/docs/BulkPaymentUploadResult.md +1 -1
  13. data/docs/ChargeJson.md +2 -2
  14. data/docs/CreditMemoApi.md +1 -1
  15. data/docs/CustomFieldApi.md +1 -1
  16. data/docs/CustomizationApi.md +1 -1
  17. data/docs/DefaultApi.md +1 -1
  18. data/docs/DiscountsApi.md +1 -1
  19. data/docs/ERPApi.md +21 -21
  20. data/docs/EntitiesApi.md +173 -1
  21. data/docs/ImportApi.md +1 -1
  22. data/docs/IntegrationsApi.md +1 -1
  23. data/docs/MetricsReportingApi.md +1 -1
  24. data/docs/NotificationsApi.md +1 -1
  25. data/docs/OpportunityApi.md +1 -1
  26. data/docs/OrderLineItemJson.md +1 -0
  27. data/docs/OrderLineItemRequestJson.md +1 -0
  28. data/docs/OrdersApi.md +1 -1
  29. data/docs/PaginatedAccountsResponse.md +10 -0
  30. data/docs/PaymentsApi.md +1 -1
  31. data/docs/PlanMetadataJson.md +8 -0
  32. data/docs/ProductCatalogApi.md +59 -1
  33. data/docs/RateCardApi.md +1 -1
  34. data/docs/RefundsApi.md +1 -1
  35. data/docs/ReportsApi.md +1 -1
  36. data/docs/RevenueRecognitionApi.md +21 -21
  37. data/docs/SalesRoomApi.md +1 -1
  38. data/docs/SettingsApi.md +1 -1
  39. data/docs/SubscriptionsApi.md +1 -1
  40. data/docs/TaxJarIntegration.md +1 -1
  41. data/docs/UsageApi.md +1 -1
  42. data/docs/UsersApi.md +1 -1
  43. data/lib/subskribe_dev/api/accounts_api.rb +3 -3
  44. data/lib/subskribe_dev/api/entities_api.rb +158 -0
  45. data/lib/subskribe_dev/api/erp_api.rb +20 -20
  46. data/lib/subskribe_dev/api/product_catalog_api.rb +58 -0
  47. data/lib/subskribe_dev/api/revenue_recognition_api.rb +22 -22
  48. data/lib/subskribe_dev/configuration.rb +1 -1
  49. data/lib/subskribe_dev/models/automated_invoice_rule.rb +22 -22
  50. data/lib/subskribe_dev/models/bulk_invoice_run_item.rb +22 -22
  51. data/lib/subskribe_dev/models/bulk_payment_upload_data.rb +31 -31
  52. data/lib/subskribe_dev/models/bulk_payment_upload_result.rb +13 -13
  53. data/lib/subskribe_dev/models/charge_json.rb +19 -19
  54. data/lib/subskribe_dev/models/order_line_item_json.rb +10 -1
  55. data/lib/subskribe_dev/models/order_line_item_request_json.rb +10 -1
  56. data/lib/subskribe_dev/models/paginated_accounts_response.rb +204 -0
  57. data/lib/subskribe_dev/models/plan_metadata_json.rb +187 -0
  58. data/lib/subskribe_dev/models/tax_jar_integration.rb +10 -10
  59. data/lib/subskribe_dev/version.rb +1 -1
  60. data/lib/subskribe_dev.rb +2 -1
  61. data/spec/models/paginated_accounts_response_spec.rb +53 -0
  62. data/spec/models/plan_metadata_json_spec.rb +41 -0
  63. data/subskribe_dev.gemspec +4 -4
  64. metadata +195 -187
@@ -1,6 +1,6 @@
1
1
  # SubskribeDevClient::NotificationsApi
2
2
 
3
- All URIs are relative to *https://api.dev2.subskribe.net*
3
+ All URIs are relative to *https://api.app.subskribe.com*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
@@ -1,6 +1,6 @@
1
1
  # SubskribeDevClient::OpportunityApi
2
2
 
3
- All URIs are relative to *https://api.dev2.subskribe.net*
3
+ All URIs are relative to *https://api.app.subskribe.com*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
@@ -29,6 +29,7 @@ Name | Type | Description | Notes
29
29
  **effective_date** | **Integer** | | [optional]
30
30
  **end_date** | **Integer** | | [optional]
31
31
  **custom_fields** | [**Array<CustomFieldEntry>**](CustomFieldEntry.md) | | [optional]
32
+ **arr_override** | **Float** | | [optional]
32
33
  **dry_run_item** | **BOOLEAN** | | [optional]
33
34
 
34
35
 
@@ -19,6 +19,7 @@ Name | Type | Description | Notes
19
19
  **list_price_override_ratio** | **Float** | | [optional]
20
20
  **attribute_references** | [**Array<AttributeReference>**](AttributeReference.md) | | [optional]
21
21
  **custom_fields** | [**Array<CustomFieldEntry>**](CustomFieldEntry.md) | | [optional]
22
+ **arr_override** | **Float** | | [optional]
22
23
  **dry_run_item** | **BOOLEAN** | | [optional]
23
24
 
24
25
 
data/docs/OrdersApi.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # SubskribeDevClient::OrdersApi
2
2
 
3
- All URIs are relative to *https://api.dev2.subskribe.net*
3
+ All URIs are relative to *https://api.app.subskribe.com*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
@@ -0,0 +1,10 @@
1
+ # SubskribeDevClient::PaginatedAccountsResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **data** | [**Array<AccountJson>**](AccountJson.md) | | [optional]
7
+ **num_elements** | **Integer** | | [optional]
8
+ **next_cursor** | **String** | | [optional]
9
+
10
+
data/docs/PaymentsApi.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # SubskribeDevClient::PaymentsApi
2
2
 
3
- All URIs are relative to *https://api.dev2.subskribe.net*
3
+ All URIs are relative to *https://api.app.subskribe.com*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
@@ -0,0 +1,8 @@
1
+ # SubskribeDevClient::PlanMetadataJson
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **entity_ids** | **Array<String>** | Entity ids to be updated | [optional]
7
+
8
+
@@ -1,6 +1,6 @@
1
1
  # SubskribeDevClient::ProductCatalogApi
2
2
 
3
- All URIs are relative to *https://api.dev2.subskribe.net*
3
+ All URIs are relative to *https://api.app.subskribe.com*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
@@ -35,6 +35,7 @@ Method | HTTP request | Description
35
35
  [**reactivate_plan**](ProductCatalogApi.md#reactivate_plan) | **PUT** /plans/{planId}/reactivate | Reactivate a plan
36
36
  [**update_charge**](ProductCatalogApi.md#update_charge) | **PUT** /plans/{planId}/charges/{chargeId} | Update charge details
37
37
  [**update_plan**](ProductCatalogApi.md#update_plan) | **PUT** /plans/{planId} | Update plan
38
+ [**update_plan_metadata**](ProductCatalogApi.md#update_plan_metadata) | **PUT** /plans/{planId}/metadata | Update plan metadata
38
39
  [**update_product**](ProductCatalogApi.md#update_product) | **PUT** /products/{id} | Update product details
39
40
  [**update_product_category**](ProductCatalogApi.md#update_product_category) | **PUT** /product/categories/{id} | Update product category details
40
41
 
@@ -1752,6 +1753,63 @@ Name | Type | Description | Notes
1752
1753
 
1753
1754
 
1754
1755
 
1756
+ # **update_plan_metadata**
1757
+ > PlanJson update_plan_metadata(plan_id, body)
1758
+
1759
+ Update plan metadata
1760
+
1761
+ Update plan metadata. For now, this can be used only to change the entities assigned to a plan
1762
+
1763
+ ### Example
1764
+ ```ruby
1765
+ # load the gem
1766
+ require 'subskribe_dev'
1767
+ # setup authorization
1768
+ SubskribeDevClient.configure do |config|
1769
+ # Configure API key authorization: ApiKeyAuth
1770
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
1771
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1772
+ #config.api_key_prefix['X-API-Key'] = 'Bearer'
1773
+ end
1774
+
1775
+ api_instance = SubskribeDevClient::ProductCatalogApi.new
1776
+
1777
+ plan_id = 'plan_id_example' # String | plan id
1778
+
1779
+ body = SubskribeDevClient::PlanMetadataJson.new # PlanMetadataJson | plan metadata to be updated
1780
+
1781
+
1782
+ begin
1783
+ #Update plan metadata
1784
+ result = api_instance.update_plan_metadata(plan_id, body)
1785
+ p result
1786
+ rescue SubskribeDevClient::ApiError => e
1787
+ puts "Exception when calling ProductCatalogApi->update_plan_metadata: #{e}"
1788
+ end
1789
+ ```
1790
+
1791
+ ### Parameters
1792
+
1793
+ Name | Type | Description | Notes
1794
+ ------------- | ------------- | ------------- | -------------
1795
+ **plan_id** | **String**| plan id |
1796
+ **body** | [**PlanMetadataJson**](PlanMetadataJson.md)| plan metadata to be updated |
1797
+
1798
+ ### Return type
1799
+
1800
+ [**PlanJson**](PlanJson.md)
1801
+
1802
+ ### Authorization
1803
+
1804
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
1805
+
1806
+ ### HTTP request headers
1807
+
1808
+ - **Content-Type**: Not defined
1809
+ - **Accept**: application/json
1810
+
1811
+
1812
+
1755
1813
  # **update_product**
1756
1814
  > update_product(id, body)
1757
1815
 
data/docs/RateCardApi.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # SubskribeDevClient::RateCardApi
2
2
 
3
- All URIs are relative to *https://api.dev2.subskribe.net*
3
+ All URIs are relative to *https://api.app.subskribe.com*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
data/docs/RefundsApi.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # SubskribeDevClient::RefundsApi
2
2
 
3
- All URIs are relative to *https://api.dev2.subskribe.net*
3
+ All URIs are relative to *https://api.app.subskribe.com*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
data/docs/ReportsApi.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # SubskribeDevClient::ReportsApi
2
2
 
3
- All URIs are relative to *https://api.dev2.subskribe.net*
3
+ All URIs are relative to *https://api.app.subskribe.com*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
@@ -1,6 +1,6 @@
1
1
  # SubskribeDevClient::RevenueRecognitionApi
2
2
 
3
- All URIs are relative to *https://api.dev2.subskribe.net*
3
+ All URIs are relative to *https://api.app.subskribe.com*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
@@ -8,8 +8,8 @@ Method | HTTP request | Description
8
8
  [**create_recognition_event**](RevenueRecognitionApi.md#create_recognition_event) | **POST** /revrec/events | Create a revenue recognition event
9
9
  [**delete_rule**](RevenueRecognitionApi.md#delete_rule) | **DELETE** /revrec/rules/{ruleId} | Delete a recognition rule
10
10
  [**get_recognition_events_by_subscription_id_charge_id**](RevenueRecognitionApi.md#get_recognition_events_by_subscription_id_charge_id) | **GET** /revrec/events | Get revenue recognition events
11
- [**get_recognition_rule_by_id**](RevenueRecognitionApi.md#get_recognition_rule_by_id) | **GET** /revrec/rules | Get revenue recognition rules
12
- [**get_recognition_rule_by_id1**](RevenueRecognitionApi.md#get_recognition_rule_by_id1) | **GET** /revrec/rules/{id} | Get revenue recognition rule
11
+ [**get_recognition_rule_by_id**](RevenueRecognitionApi.md#get_recognition_rule_by_id) | **GET** /revrec/rules/{id} | Get revenue recognition rule
12
+ [**get_recognition_rule_by_id1**](RevenueRecognitionApi.md#get_recognition_rule_by_id1) | **GET** /revrec/rules | Get revenue recognition rules
13
13
  [**get_revenue_waterfall**](RevenueRecognitionApi.md#get_revenue_waterfall) | **GET** /revrec/waterfall | Download waterfall report
14
14
  [**get_revenue_waterfall_report_v2**](RevenueRecognitionApi.md#get_revenue_waterfall_report_v2) | **GET** /revrec/waterfall/v2 | Download waterfall report
15
15
  [**upload_completion_events**](RevenueRecognitionApi.md#upload_completion_events) | **POST** /revrec/events/upload | Upload revenue events
@@ -237,11 +237,11 @@ Name | Type | Description | Notes
237
237
 
238
238
 
239
239
  # **get_recognition_rule_by_id**
240
- > get_recognition_rule_by_id
240
+ > get_recognition_rule_by_id(id)
241
241
 
242
- Get revenue recognition rules
242
+ Get revenue recognition rule
243
243
 
244
- Get revenue recognition rules.
244
+ Get a revenue recognition rule using id.
245
245
 
246
246
  ### Example
247
247
  ```ruby
@@ -257,16 +257,22 @@ end
257
257
 
258
258
  api_instance = SubskribeDevClient::RevenueRecognitionApi.new
259
259
 
260
+ id = 'id_example' # String | id of the recognition rule
261
+
262
+
260
263
  begin
261
- #Get revenue recognition rules
262
- api_instance.get_recognition_rule_by_id
264
+ #Get revenue recognition rule
265
+ api_instance.get_recognition_rule_by_id(id)
263
266
  rescue SubskribeDevClient::ApiError => e
264
267
  puts "Exception when calling RevenueRecognitionApi->get_recognition_rule_by_id: #{e}"
265
268
  end
266
269
  ```
267
270
 
268
271
  ### Parameters
269
- This endpoint does not need any parameter.
272
+
273
+ Name | Type | Description | Notes
274
+ ------------- | ------------- | ------------- | -------------
275
+ **id** | **String**| id of the recognition rule |
270
276
 
271
277
  ### Return type
272
278
 
@@ -284,11 +290,11 @@ nil (empty response body)
284
290
 
285
291
 
286
292
  # **get_recognition_rule_by_id1**
287
- > get_recognition_rule_by_id1(id)
293
+ > get_recognition_rule_by_id1
288
294
 
289
- Get revenue recognition rule
295
+ Get revenue recognition rules
290
296
 
291
- Get a revenue recognition rule using id.
297
+ Get revenue recognition rules.
292
298
 
293
299
  ### Example
294
300
  ```ruby
@@ -304,22 +310,16 @@ end
304
310
 
305
311
  api_instance = SubskribeDevClient::RevenueRecognitionApi.new
306
312
 
307
- id = 'id_example' # String | id of the recognition rule
308
-
309
-
310
313
  begin
311
- #Get revenue recognition rule
312
- api_instance.get_recognition_rule_by_id1(id)
314
+ #Get revenue recognition rules
315
+ api_instance.get_recognition_rule_by_id1
313
316
  rescue SubskribeDevClient::ApiError => e
314
317
  puts "Exception when calling RevenueRecognitionApi->get_recognition_rule_by_id1: #{e}"
315
318
  end
316
319
  ```
317
320
 
318
321
  ### Parameters
319
-
320
- Name | Type | Description | Notes
321
- ------------- | ------------- | ------------- | -------------
322
- **id** | **String**| id of the recognition rule |
322
+ This endpoint does not need any parameter.
323
323
 
324
324
  ### Return type
325
325
 
data/docs/SalesRoomApi.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # SubskribeDevClient::SalesRoomApi
2
2
 
3
- All URIs are relative to *https://api.dev2.subskribe.net*
3
+ All URIs are relative to *https://api.app.subskribe.com*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
data/docs/SettingsApi.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # SubskribeDevClient::SettingsApi
2
2
 
3
- All URIs are relative to *https://api.dev2.subskribe.net*
3
+ All URIs are relative to *https://api.app.subskribe.com*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
@@ -1,6 +1,6 @@
1
1
  # SubskribeDevClient::SubscriptionsApi
2
2
 
3
- All URIs are relative to *https://api.dev2.subskribe.net*
3
+ All URIs are relative to *https://api.app.subskribe.com*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
@@ -6,9 +6,9 @@ Name | Type | Description | Notes
6
6
  **tenant_id** | **String** | | [optional]
7
7
  **updated_on** | **Integer** | | [optional]
8
8
  **created_on** | **Integer** | | [optional]
9
+ **is_deleted** | **BOOLEAN** | | [optional]
9
10
  **integration_id** | **String** | | [optional]
10
11
  **masked_api_key** | **String** | | [optional]
11
- **is_deleted** | **BOOLEAN** | | [optional]
12
12
  **is_sandbox** | **BOOLEAN** | | [optional]
13
13
 
14
14
 
data/docs/UsageApi.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # SubskribeDevClient::UsageApi
2
2
 
3
- All URIs are relative to *https://api.dev2.subskribe.net*
3
+ All URIs are relative to *https://api.app.subskribe.com*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
data/docs/UsersApi.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # SubskribeDevClient::UsersApi
2
2
 
3
- All URIs are relative to *https://api.dev2.subskribe.net*
3
+ All URIs are relative to *https://api.app.subskribe.com*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
@@ -577,7 +577,7 @@ module SubskribeDevClient
577
577
  # @option opts [String] :cursor
578
578
  # @option opts [Integer] :limit
579
579
  # @option opts [String] :type
580
- # @return [Array<AccountJson>]
580
+ # @return [PaginatedAccountsResponse]
581
581
  def get_accounts(opts = {})
582
582
  data, _status_code, _headers = get_accounts_with_http_info(opts)
583
583
  data
@@ -589,7 +589,7 @@ module SubskribeDevClient
589
589
  # @option opts [String] :cursor
590
590
  # @option opts [Integer] :limit
591
591
  # @option opts [String] :type
592
- # @return [Array<(Array<AccountJson>, Fixnum, Hash)>] Array<AccountJson> data, response status code and response headers
592
+ # @return [Array<(PaginatedAccountsResponse, Fixnum, Hash)>] PaginatedAccountsResponse data, response status code and response headers
593
593
  def get_accounts_with_http_info(opts = {})
594
594
  if @api_client.config.debugging
595
595
  @api_client.config.logger.debug 'Calling API: AccountsApi.get_accounts ...'
@@ -620,7 +620,7 @@ module SubskribeDevClient
620
620
  :form_params => form_params,
621
621
  :body => post_body,
622
622
  :auth_names => auth_names,
623
- :return_type => 'Array<AccountJson>')
623
+ :return_type => 'PaginatedAccountsResponse')
624
624
  if @api_client.config.debugging
625
625
  @api_client.config.logger.debug "API called: AccountsApi#get_accounts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
626
626
  end
@@ -19,6 +19,108 @@ module SubskribeDevClient
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
+ # Move account to a target entity
23
+ # Move account along with its subscriptions, orders, invoices and other associated transactions to a target entity
24
+ # @param [Hash] opts the optional parameters
25
+ # @option opts [String] :target_entity_id
26
+ # @option opts [String] :account_id
27
+ # @return [nil]
28
+ def account_entity_migration(opts = {})
29
+ account_entity_migration_with_http_info(opts)
30
+ nil
31
+ end
32
+
33
+ # Move account to a target entity
34
+ # Move account along with its subscriptions, orders, invoices and other associated transactions to a target entity
35
+ # @param [Hash] opts the optional parameters
36
+ # @option opts [String] :target_entity_id
37
+ # @option opts [String] :account_id
38
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
39
+ def account_entity_migration_with_http_info(opts = {})
40
+ if @api_client.config.debugging
41
+ @api_client.config.logger.debug 'Calling API: EntitiesApi.account_entity_migration ...'
42
+ end
43
+ # resource path
44
+ local_var_path = '/entities/migrate/account'
45
+
46
+ # query parameters
47
+ query_params = {}
48
+ query_params[:'targetEntityId'] = opts[:'target_entity_id'] if !opts[:'target_entity_id'].nil?
49
+ query_params[:'accountId'] = opts[:'account_id'] if !opts[:'account_id'].nil?
50
+
51
+ # header parameters
52
+ header_params = {}
53
+ # HTTP header 'Accept' (if needed)
54
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
55
+
56
+ # form parameters
57
+ form_params = {}
58
+
59
+ # http body (model)
60
+ post_body = nil
61
+ auth_names = ['ApiKeyAuth']
62
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
63
+ :header_params => header_params,
64
+ :query_params => query_params,
65
+ :form_params => form_params,
66
+ :body => post_body,
67
+ :auth_names => auth_names)
68
+ if @api_client.config.debugging
69
+ @api_client.config.logger.debug "API called: EntitiesApi#account_entity_migration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
70
+ end
71
+ return data, status_code, headers
72
+ end
73
+ # Move composite order to a target entity
74
+ # Move composite order along with its subscriptions, orders and other associated transactions to a target entity
75
+ # @param [Hash] opts the optional parameters
76
+ # @option opts [String] :target_entity_id
77
+ # @option opts [String] :composite_order_id
78
+ # @return [nil]
79
+ def composite_order_entity_migration(opts = {})
80
+ composite_order_entity_migration_with_http_info(opts)
81
+ nil
82
+ end
83
+
84
+ # Move composite order to a target entity
85
+ # Move composite order along with its subscriptions, orders and other associated transactions to a target entity
86
+ # @param [Hash] opts the optional parameters
87
+ # @option opts [String] :target_entity_id
88
+ # @option opts [String] :composite_order_id
89
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
90
+ def composite_order_entity_migration_with_http_info(opts = {})
91
+ if @api_client.config.debugging
92
+ @api_client.config.logger.debug 'Calling API: EntitiesApi.composite_order_entity_migration ...'
93
+ end
94
+ # resource path
95
+ local_var_path = '/entities/migrate/compositeOrder'
96
+
97
+ # query parameters
98
+ query_params = {}
99
+ query_params[:'targetEntityId'] = opts[:'target_entity_id'] if !opts[:'target_entity_id'].nil?
100
+ query_params[:'compositeOrderId'] = opts[:'composite_order_id'] if !opts[:'composite_order_id'].nil?
101
+
102
+ # header parameters
103
+ header_params = {}
104
+ # HTTP header 'Accept' (if needed)
105
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
106
+
107
+ # form parameters
108
+ form_params = {}
109
+
110
+ # http body (model)
111
+ post_body = nil
112
+ auth_names = ['ApiKeyAuth']
113
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
114
+ :header_params => header_params,
115
+ :query_params => query_params,
116
+ :form_params => form_params,
117
+ :body => post_body,
118
+ :auth_names => auth_names)
119
+ if @api_client.config.debugging
120
+ @api_client.config.logger.debug "API called: EntitiesApi#composite_order_entity_migration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
121
+ end
122
+ return data, status_code, headers
123
+ end
22
124
  # Create an entity
23
125
  # Create an entity. On success return the created entity.
24
126
  # @param [Hash] opts the optional parameters
@@ -370,5 +472,61 @@ module SubskribeDevClient
370
472
  end
371
473
  return data, status_code, headers
372
474
  end
475
+ # Update entity logo
476
+ # Updates the logo used in external facing communication such as order forms and invoices
477
+ # @param entity_id
478
+ # @param [Hash] opts the optional parameters
479
+ # @option opts [File] :file
480
+ # @return [nil]
481
+ def upload_logo(entity_id, opts = {})
482
+ upload_logo_with_http_info(entity_id, opts)
483
+ nil
484
+ end
485
+
486
+ # Update entity logo
487
+ # Updates the logo used in external facing communication such as order forms and invoices
488
+ # @param entity_id
489
+ # @param [Hash] opts the optional parameters
490
+ # @option opts [File] :file
491
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
492
+ def upload_logo_with_http_info(entity_id, opts = {})
493
+ if @api_client.config.debugging
494
+ @api_client.config.logger.debug 'Calling API: EntitiesApi.upload_logo ...'
495
+ end
496
+ # verify the required parameter 'entity_id' is set
497
+ if @api_client.config.client_side_validation && entity_id.nil?
498
+ fail ArgumentError, "Missing the required parameter 'entity_id' when calling EntitiesApi.upload_logo"
499
+ end
500
+ # resource path
501
+ local_var_path = '/entities/logo/{entityId}'.sub('{' + 'entityId' + '}', entity_id.to_s)
502
+
503
+ # query parameters
504
+ query_params = {}
505
+
506
+ # header parameters
507
+ header_params = {}
508
+ # HTTP header 'Accept' (if needed)
509
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
510
+ # HTTP header 'Content-Type'
511
+ header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
512
+
513
+ # form parameters
514
+ form_params = {}
515
+ form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
516
+
517
+ # http body (model)
518
+ post_body = nil
519
+ auth_names = ['ApiKeyAuth']
520
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
521
+ :header_params => header_params,
522
+ :query_params => query_params,
523
+ :form_params => form_params,
524
+ :body => post_body,
525
+ :auth_names => auth_names)
526
+ if @api_client.config.debugging
527
+ @api_client.config.logger.debug "API called: EntitiesApi#upload_logo\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
528
+ end
529
+ return data, status_code, headers
530
+ end
373
531
  end
374
532
  end
@@ -19,8 +19,8 @@ module SubskribeDevClient
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
- # API to trigger ERP journal entry deletion task for accounting period
23
- #
22
+ # Trigger ERP journal entry deletion task
23
+ # Trigger ERP journal entry deletion task for the given accounting period id
24
24
  # @param accounting_period_id
25
25
  # @param [Hash] opts the optional parameters
26
26
  # @return [nil]
@@ -29,8 +29,8 @@ module SubskribeDevClient
29
29
  nil
30
30
  end
31
31
 
32
- # API to trigger ERP journal entry deletion task for accounting period
33
- #
32
+ # Trigger ERP journal entry deletion task
33
+ # Trigger ERP journal entry deletion task for the given accounting period id
34
34
  # @param accounting_period_id
35
35
  # @param [Hash] opts the optional parameters
36
36
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
@@ -70,8 +70,8 @@ module SubskribeDevClient
70
70
  end
71
71
  return data, status_code, headers
72
72
  end
73
- # API to trigger ERP journal entry sync task for accounting period
74
- #
73
+ # Trigger ERP journal entry sync task
74
+ # Trigger ERP journal entry sync task for given accounting period id
75
75
  # @param accounting_period_id
76
76
  # @param [Hash] opts the optional parameters
77
77
  # @return [nil]
@@ -80,8 +80,8 @@ module SubskribeDevClient
80
80
  nil
81
81
  end
82
82
 
83
- # API to trigger ERP journal entry sync task for accounting period
84
- #
83
+ # Trigger ERP journal entry sync task
84
+ # Trigger ERP journal entry sync task for given accounting period id
85
85
  # @param accounting_period_id
86
86
  # @param [Hash] opts the optional parameters
87
87
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
@@ -121,8 +121,8 @@ module SubskribeDevClient
121
121
  end
122
122
  return data, status_code, headers
123
123
  end
124
- # API to trigger ERP journal entry deletion task for accounting period
125
- #
124
+ # Trigger ERP credit memo sync task
125
+ # Trigger ERP credit memo sync task for the given credit memo number
126
126
  # @param credit_memo_number
127
127
  # @param [Hash] opts the optional parameters
128
128
  # @return [nil]
@@ -131,8 +131,8 @@ module SubskribeDevClient
131
131
  nil
132
132
  end
133
133
 
134
- # API to trigger ERP journal entry deletion task for accounting period
135
- #
134
+ # Trigger ERP credit memo sync task
135
+ # Trigger ERP credit memo sync task for the given credit memo number
136
136
  # @param credit_memo_number
137
137
  # @param [Hash] opts the optional parameters
138
138
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
@@ -172,8 +172,8 @@ module SubskribeDevClient
172
172
  end
173
173
  return data, status_code, headers
174
174
  end
175
- # API to trigger ERP journal entry deletion task for accounting period
176
- #
175
+ # Trigger ERP invoice sync task
176
+ # Trigger ERP invoice sync task for the given invoice id
177
177
  # @param invoice_id
178
178
  # @param [Hash] opts the optional parameters
179
179
  # @return [nil]
@@ -182,8 +182,8 @@ module SubskribeDevClient
182
182
  nil
183
183
  end
184
184
 
185
- # API to trigger ERP journal entry deletion task for accounting period
186
- #
185
+ # Trigger ERP invoice sync task
186
+ # Trigger ERP invoice sync task for the given invoice id
187
187
  # @param invoice_id
188
188
  # @param [Hash] opts the optional parameters
189
189
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
@@ -223,8 +223,8 @@ module SubskribeDevClient
223
223
  end
224
224
  return data, status_code, headers
225
225
  end
226
- # API to trigger ERP journal entry deletion task for accounting period
227
- #
226
+ # Trigger ERP void invoice sync task
227
+ # Trigger ERP void invoice sync task for the given invoice number
228
228
  # @param invoice_number
229
229
  # @param [Hash] opts the optional parameters
230
230
  # @return [nil]
@@ -233,8 +233,8 @@ module SubskribeDevClient
233
233
  nil
234
234
  end
235
235
 
236
- # API to trigger ERP journal entry deletion task for accounting period
237
- #
236
+ # Trigger ERP void invoice sync task
237
+ # Trigger ERP void invoice sync task for the given invoice number
238
238
  # @param invoice_number
239
239
  # @param [Hash] opts the optional parameters
240
240
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers