subskribe_dev 1.2.0 → 1.3.1
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.
- checksums.yaml +4 -4
- data/README.md +17 -12
- data/docs/AccountsApi.md +2 -2
- data/docs/AutomatedInvoiceRule.md +2 -2
- data/docs/BulkInvoiceRunItem.md +2 -2
- data/docs/BulkPaymentUploadData.md +3 -3
- data/docs/BulkPaymentUploadResult.md +1 -1
- data/docs/ChargeJson.md +2 -2
- data/docs/ERPApi.md +20 -20
- data/docs/EntitiesApi.md +172 -0
- data/docs/OrderLineItemJson.md +1 -0
- data/docs/OrderLineItemRequestJson.md +1 -0
- data/docs/PaginatedAccountsResponse.md +10 -0
- data/docs/PlanMetadataJson.md +8 -0
- data/docs/ProductCatalogApi.md +58 -0
- data/docs/RevenueRecognitionApi.md +20 -20
- data/docs/TaxJarIntegration.md +1 -1
- data/lib/subskribe_dev/api/accounts_api.rb +3 -3
- data/lib/subskribe_dev/api/entities_api.rb +158 -0
- data/lib/subskribe_dev/api/erp_api.rb +20 -20
- data/lib/subskribe_dev/api/product_catalog_api.rb +58 -0
- data/lib/subskribe_dev/api/revenue_recognition_api.rb +22 -22
- data/lib/subskribe_dev/models/automated_invoice_rule.rb +22 -22
- data/lib/subskribe_dev/models/bulk_invoice_run_item.rb +22 -22
- data/lib/subskribe_dev/models/bulk_payment_upload_data.rb +31 -31
- data/lib/subskribe_dev/models/bulk_payment_upload_result.rb +13 -13
- data/lib/subskribe_dev/models/charge_json.rb +19 -19
- data/lib/subskribe_dev/models/order_line_item_json.rb +10 -1
- data/lib/subskribe_dev/models/order_line_item_request_json.rb +10 -1
- data/lib/subskribe_dev/models/paginated_accounts_response.rb +204 -0
- data/lib/subskribe_dev/models/plan_metadata_json.rb +187 -0
- data/lib/subskribe_dev/models/tax_jar_integration.rb +10 -10
- data/lib/subskribe_dev/version.rb +1 -1
- data/lib/subskribe_dev.rb +2 -1
- data/spec/models/paginated_accounts_response_spec.rb +53 -0
- data/spec/models/plan_metadata_json_spec.rb +41 -0
- data/subskribe_dev.gemspec +4 -4
- metadata +195 -187
@@ -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
|
12
|
-
[**get_recognition_rule_by_id1**](RevenueRecognitionApi.md#get_recognition_rule_by_id1) | **GET** /revrec/rules
|
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
|
242
|
+
Get revenue recognition rule
|
243
243
|
|
244
|
-
Get revenue recognition
|
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
|
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
|
-
|
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
|
293
|
+
> get_recognition_rule_by_id1
|
288
294
|
|
289
|
-
Get revenue recognition
|
295
|
+
Get revenue recognition rules
|
290
296
|
|
291
|
-
Get
|
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
|
312
|
-
api_instance.get_recognition_rule_by_id1
|
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/TaxJarIntegration.md
CHANGED
@@ -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
|
|
@@ -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 [
|
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<(
|
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 => '
|
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
|
-
#
|
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
|
-
#
|
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
|
-
#
|
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
|
-
#
|
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
|
-
#
|
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
|
-
#
|
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
|
-
#
|
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
|
-
#
|
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
|
-
#
|
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
|
-
#
|
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
|
@@ -1706,6 +1706,64 @@ module SubskribeDevClient
|
|
1706
1706
|
end
|
1707
1707
|
return data, status_code, headers
|
1708
1708
|
end
|
1709
|
+
# Update plan metadata
|
1710
|
+
# Update plan metadata. For now, this can be used only to change the entities assigned to a plan
|
1711
|
+
# @param plan_id plan id
|
1712
|
+
# @param body plan metadata to be updated
|
1713
|
+
# @param [Hash] opts the optional parameters
|
1714
|
+
# @return [PlanJson]
|
1715
|
+
def update_plan_metadata(plan_id, body, opts = {})
|
1716
|
+
data, _status_code, _headers = update_plan_metadata_with_http_info(plan_id, body, opts)
|
1717
|
+
data
|
1718
|
+
end
|
1719
|
+
|
1720
|
+
# Update plan metadata
|
1721
|
+
# Update plan metadata. For now, this can be used only to change the entities assigned to a plan
|
1722
|
+
# @param plan_id plan id
|
1723
|
+
# @param body plan metadata to be updated
|
1724
|
+
# @param [Hash] opts the optional parameters
|
1725
|
+
# @return [Array<(PlanJson, Fixnum, Hash)>] PlanJson data, response status code and response headers
|
1726
|
+
def update_plan_metadata_with_http_info(plan_id, body, opts = {})
|
1727
|
+
if @api_client.config.debugging
|
1728
|
+
@api_client.config.logger.debug 'Calling API: ProductCatalogApi.update_plan_metadata ...'
|
1729
|
+
end
|
1730
|
+
# verify the required parameter 'plan_id' is set
|
1731
|
+
if @api_client.config.client_side_validation && plan_id.nil?
|
1732
|
+
fail ArgumentError, "Missing the required parameter 'plan_id' when calling ProductCatalogApi.update_plan_metadata"
|
1733
|
+
end
|
1734
|
+
# verify the required parameter 'body' is set
|
1735
|
+
if @api_client.config.client_side_validation && body.nil?
|
1736
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling ProductCatalogApi.update_plan_metadata"
|
1737
|
+
end
|
1738
|
+
# resource path
|
1739
|
+
local_var_path = '/plans/{planId}/metadata'.sub('{' + 'planId' + '}', plan_id.to_s)
|
1740
|
+
|
1741
|
+
# query parameters
|
1742
|
+
query_params = {}
|
1743
|
+
|
1744
|
+
# header parameters
|
1745
|
+
header_params = {}
|
1746
|
+
# HTTP header 'Accept' (if needed)
|
1747
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1748
|
+
|
1749
|
+
# form parameters
|
1750
|
+
form_params = {}
|
1751
|
+
|
1752
|
+
# http body (model)
|
1753
|
+
post_body = @api_client.object_to_http_body(body)
|
1754
|
+
auth_names = ['ApiKeyAuth']
|
1755
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
1756
|
+
:header_params => header_params,
|
1757
|
+
:query_params => query_params,
|
1758
|
+
:form_params => form_params,
|
1759
|
+
:body => post_body,
|
1760
|
+
:auth_names => auth_names,
|
1761
|
+
:return_type => 'PlanJson')
|
1762
|
+
if @api_client.config.debugging
|
1763
|
+
@api_client.config.logger.debug "API called: ProductCatalogApi#update_plan_metadata\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1764
|
+
end
|
1765
|
+
return data, status_code, headers
|
1766
|
+
end
|
1709
1767
|
# Update product details
|
1710
1768
|
# Updates the details of the specified product
|
1711
1769
|
# @param id id of the product
|
@@ -238,25 +238,31 @@ module SubskribeDevClient
|
|
238
238
|
end
|
239
239
|
return data, status_code, headers
|
240
240
|
end
|
241
|
-
# Get revenue recognition
|
242
|
-
# Get revenue recognition
|
241
|
+
# Get revenue recognition rule
|
242
|
+
# Get a revenue recognition rule using id.
|
243
|
+
# @param id id of the recognition rule
|
243
244
|
# @param [Hash] opts the optional parameters
|
244
245
|
# @return [nil]
|
245
|
-
def get_recognition_rule_by_id(opts = {})
|
246
|
-
get_recognition_rule_by_id_with_http_info(opts)
|
246
|
+
def get_recognition_rule_by_id(id, opts = {})
|
247
|
+
get_recognition_rule_by_id_with_http_info(id, opts)
|
247
248
|
nil
|
248
249
|
end
|
249
250
|
|
250
|
-
# Get revenue recognition
|
251
|
-
# Get revenue recognition
|
251
|
+
# Get revenue recognition rule
|
252
|
+
# Get a revenue recognition rule using id.
|
253
|
+
# @param id id of the recognition rule
|
252
254
|
# @param [Hash] opts the optional parameters
|
253
255
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
254
|
-
def get_recognition_rule_by_id_with_http_info(opts = {})
|
256
|
+
def get_recognition_rule_by_id_with_http_info(id, opts = {})
|
255
257
|
if @api_client.config.debugging
|
256
258
|
@api_client.config.logger.debug 'Calling API: RevenueRecognitionApi.get_recognition_rule_by_id ...'
|
257
259
|
end
|
260
|
+
# verify the required parameter 'id' is set
|
261
|
+
if @api_client.config.client_side_validation && id.nil?
|
262
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling RevenueRecognitionApi.get_recognition_rule_by_id"
|
263
|
+
end
|
258
264
|
# resource path
|
259
|
-
local_var_path = '/revrec/rules'
|
265
|
+
local_var_path = '/revrec/rules/{id}'.sub('{' + 'id' + '}', id.to_s)
|
260
266
|
|
261
267
|
# query parameters
|
262
268
|
query_params = {}
|
@@ -283,31 +289,25 @@ module SubskribeDevClient
|
|
283
289
|
end
|
284
290
|
return data, status_code, headers
|
285
291
|
end
|
286
|
-
# Get revenue recognition
|
287
|
-
# Get
|
288
|
-
# @param id id of the recognition rule
|
292
|
+
# Get revenue recognition rules
|
293
|
+
# Get revenue recognition rules.
|
289
294
|
# @param [Hash] opts the optional parameters
|
290
295
|
# @return [nil]
|
291
|
-
def get_recognition_rule_by_id1(
|
292
|
-
get_recognition_rule_by_id1_with_http_info(
|
296
|
+
def get_recognition_rule_by_id1(opts = {})
|
297
|
+
get_recognition_rule_by_id1_with_http_info(opts)
|
293
298
|
nil
|
294
299
|
end
|
295
300
|
|
296
|
-
# Get revenue recognition
|
297
|
-
# Get
|
298
|
-
# @param id id of the recognition rule
|
301
|
+
# Get revenue recognition rules
|
302
|
+
# Get revenue recognition rules.
|
299
303
|
# @param [Hash] opts the optional parameters
|
300
304
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
301
|
-
def get_recognition_rule_by_id1_with_http_info(
|
305
|
+
def get_recognition_rule_by_id1_with_http_info(opts = {})
|
302
306
|
if @api_client.config.debugging
|
303
307
|
@api_client.config.logger.debug 'Calling API: RevenueRecognitionApi.get_recognition_rule_by_id1 ...'
|
304
308
|
end
|
305
|
-
# verify the required parameter 'id' is set
|
306
|
-
if @api_client.config.client_side_validation && id.nil?
|
307
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling RevenueRecognitionApi.get_recognition_rule_by_id1"
|
308
|
-
end
|
309
309
|
# resource path
|
310
|
-
local_var_path = '/revrec/rules
|
310
|
+
local_var_path = '/revrec/rules'
|
311
311
|
|
312
312
|
# query parameters
|
313
313
|
query_params = {}
|
@@ -30,10 +30,6 @@ module SubskribeDevClient
|
|
30
30
|
|
31
31
|
attr_accessor :last_execution_date
|
32
32
|
|
33
|
-
attr_accessor :cron_expression_meaning
|
34
|
-
|
35
|
-
attr_accessor :next_execution_date
|
36
|
-
|
37
33
|
attr_accessor :target_duration
|
38
34
|
|
39
35
|
attr_accessor :invoice_duration
|
@@ -48,6 +44,10 @@ module SubskribeDevClient
|
|
48
44
|
|
49
45
|
attr_accessor :first_execution_date
|
50
46
|
|
47
|
+
attr_accessor :cron_expression_meaning
|
48
|
+
|
49
|
+
attr_accessor :next_execution_date
|
50
|
+
|
51
51
|
# Attribute mapping from ruby-style variable name to JSON key.
|
52
52
|
def self.attribute_map
|
53
53
|
{
|
@@ -59,15 +59,15 @@ module SubskribeDevClient
|
|
59
59
|
:'updated_on' => :'updatedOn',
|
60
60
|
:'created_on' => :'createdOn',
|
61
61
|
:'last_execution_date' => :'lastExecutionDate',
|
62
|
-
:'cron_expression_meaning' => :'cronExpressionMeaning',
|
63
|
-
:'next_execution_date' => :'nextExecutionDate',
|
64
62
|
:'target_duration' => :'targetDuration',
|
65
63
|
:'invoice_duration' => :'invoiceDuration',
|
66
64
|
:'include_usage_charge' => :'includeUsageCharge',
|
67
65
|
:'include_non_usage_charge' => :'includeNonUsageCharge',
|
68
66
|
:'auto_post_invoice' => :'autoPostInvoice',
|
69
67
|
:'auto_email_invoice' => :'autoEmailInvoice',
|
70
|
-
:'first_execution_date' => :'firstExecutionDate'
|
68
|
+
:'first_execution_date' => :'firstExecutionDate',
|
69
|
+
:'cron_expression_meaning' => :'cronExpressionMeaning',
|
70
|
+
:'next_execution_date' => :'nextExecutionDate'
|
71
71
|
}
|
72
72
|
end
|
73
73
|
|
@@ -82,15 +82,15 @@ module SubskribeDevClient
|
|
82
82
|
:'updated_on' => :'Integer',
|
83
83
|
:'created_on' => :'Integer',
|
84
84
|
:'last_execution_date' => :'Integer',
|
85
|
-
:'cron_expression_meaning' => :'String',
|
86
|
-
:'next_execution_date' => :'Integer',
|
87
85
|
:'target_duration' => :'Integer',
|
88
86
|
:'invoice_duration' => :'Integer',
|
89
87
|
:'include_usage_charge' => :'BOOLEAN',
|
90
88
|
:'include_non_usage_charge' => :'BOOLEAN',
|
91
89
|
:'auto_post_invoice' => :'BOOLEAN',
|
92
90
|
:'auto_email_invoice' => :'BOOLEAN',
|
93
|
-
:'first_execution_date' => :'Integer'
|
91
|
+
:'first_execution_date' => :'Integer',
|
92
|
+
:'cron_expression_meaning' => :'String',
|
93
|
+
:'next_execution_date' => :'Integer'
|
94
94
|
}
|
95
95
|
end
|
96
96
|
|
@@ -134,14 +134,6 @@ module SubskribeDevClient
|
|
134
134
|
self.last_execution_date = attributes[:'lastExecutionDate']
|
135
135
|
end
|
136
136
|
|
137
|
-
if attributes.has_key?(:'cronExpressionMeaning')
|
138
|
-
self.cron_expression_meaning = attributes[:'cronExpressionMeaning']
|
139
|
-
end
|
140
|
-
|
141
|
-
if attributes.has_key?(:'nextExecutionDate')
|
142
|
-
self.next_execution_date = attributes[:'nextExecutionDate']
|
143
|
-
end
|
144
|
-
|
145
137
|
if attributes.has_key?(:'targetDuration')
|
146
138
|
self.target_duration = attributes[:'targetDuration']
|
147
139
|
end
|
@@ -169,6 +161,14 @@ module SubskribeDevClient
|
|
169
161
|
if attributes.has_key?(:'firstExecutionDate')
|
170
162
|
self.first_execution_date = attributes[:'firstExecutionDate']
|
171
163
|
end
|
164
|
+
|
165
|
+
if attributes.has_key?(:'cronExpressionMeaning')
|
166
|
+
self.cron_expression_meaning = attributes[:'cronExpressionMeaning']
|
167
|
+
end
|
168
|
+
|
169
|
+
if attributes.has_key?(:'nextExecutionDate')
|
170
|
+
self.next_execution_date = attributes[:'nextExecutionDate']
|
171
|
+
end
|
172
172
|
end
|
173
173
|
|
174
174
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -197,15 +197,15 @@ module SubskribeDevClient
|
|
197
197
|
updated_on == o.updated_on &&
|
198
198
|
created_on == o.created_on &&
|
199
199
|
last_execution_date == o.last_execution_date &&
|
200
|
-
cron_expression_meaning == o.cron_expression_meaning &&
|
201
|
-
next_execution_date == o.next_execution_date &&
|
202
200
|
target_duration == o.target_duration &&
|
203
201
|
invoice_duration == o.invoice_duration &&
|
204
202
|
include_usage_charge == o.include_usage_charge &&
|
205
203
|
include_non_usage_charge == o.include_non_usage_charge &&
|
206
204
|
auto_post_invoice == o.auto_post_invoice &&
|
207
205
|
auto_email_invoice == o.auto_email_invoice &&
|
208
|
-
first_execution_date == o.first_execution_date
|
206
|
+
first_execution_date == o.first_execution_date &&
|
207
|
+
cron_expression_meaning == o.cron_expression_meaning &&
|
208
|
+
next_execution_date == o.next_execution_date
|
209
209
|
end
|
210
210
|
|
211
211
|
# @see the `==` method
|
@@ -217,7 +217,7 @@ module SubskribeDevClient
|
|
217
217
|
# Calculates hash code according to all attributes.
|
218
218
|
# @return [Fixnum] Hash code
|
219
219
|
def hash
|
220
|
-
[name, id, enabled, description, cron_expression, updated_on, created_on, last_execution_date,
|
220
|
+
[name, id, enabled, description, cron_expression, updated_on, created_on, last_execution_date, target_duration, invoice_duration, include_usage_charge, include_non_usage_charge, auto_post_invoice, auto_email_invoice, first_execution_date, cron_expression_meaning, next_execution_date].hash
|
221
221
|
end
|
222
222
|
|
223
223
|
# Builds the object from hash
|