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
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 1cc853140c3992c46017883ee3a5de1e6d49c07fe23c16592ddb9f8024ea2bac
|
4
|
+
data.tar.gz: cee7639ec7dfb62a46011dc5dff358bf5b380029bda44803617b316788530b0c
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: b41eeb6683a2d51d41bcae0dacfb985579dc233d0a2704cfed760ce084314b3cea9a4aa898fb2b2f602370b02d493336db739365e823442ec1ef936454719bdf
|
7
|
+
data.tar.gz: 73f9fc72237a6367e49c1c5078973c18bee6f2dfd694e971fffd9986069af5bbe0b964112be23bf70565ddd21d432f74daa8d12e342739cd2463991cacf4d2d9
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ No description provided (generated by Swagger Codegen https://github.com/swagger
|
|
7
7
|
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
8
8
|
|
9
9
|
- API version: 1.0.0
|
10
|
-
- Package version: 1.
|
10
|
+
- Package version: 1.3.1
|
11
11
|
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
12
12
|
|
13
13
|
## Installation
|
@@ -23,15 +23,15 @@ gem build subskribe_dev.gemspec
|
|
23
23
|
Then either install the gem locally:
|
24
24
|
|
25
25
|
```shell
|
26
|
-
gem install ./subskribe_dev-1.
|
26
|
+
gem install ./subskribe_dev-1.3.1.gem
|
27
27
|
```
|
28
|
-
(for development, run `gem install --dev ./subskribe_dev-1.
|
28
|
+
(for development, run `gem install --dev ./subskribe_dev-1.3.1.gem` to install the development dependencies)
|
29
29
|
|
30
30
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
31
31
|
|
32
32
|
Finally add this to the Gemfile:
|
33
33
|
|
34
|
-
gem 'subskribe_dev', '~> 1.
|
34
|
+
gem 'subskribe_dev', '~> 1.3.1'
|
35
35
|
|
36
36
|
### Install from Git
|
37
37
|
|
@@ -209,11 +209,13 @@ Class | Method | HTTP request | Description
|
|
209
209
|
*SubskribeDevClient::DiscountsApi* | [**get_discounts**](docs/DiscountsApi.md#get_discounts) | **GET** /discounts | Get discounts
|
210
210
|
*SubskribeDevClient::DiscountsApi* | [**update_discount**](docs/DiscountsApi.md#update_discount) | **PUT** /discounts/{id} | Update discount details
|
211
211
|
*SubskribeDevClient::DiscountsApi* | [**update_discount_status**](docs/DiscountsApi.md#update_discount_status) | **PUT** /discounts/{id}/status/{status} | Update discount status
|
212
|
-
*SubskribeDevClient::ERPApi* | [**process_delete_tasks**](docs/ERPApi.md#process_delete_tasks) | **POST** /erp/processDeleteTasks/{accountingPeriodId} |
|
213
|
-
*SubskribeDevClient::ERPApi* | [**process_sync_tasks**](docs/ERPApi.md#process_sync_tasks) | **POST** /erp/processSyncTasks/{accountingPeriodId} |
|
214
|
-
*SubskribeDevClient::ERPApi* | [**sync_credit_memo_to_erp**](docs/ERPApi.md#sync_credit_memo_to_erp) | **POST** /erp/syncCreditMemo/{creditMemoNumber} |
|
215
|
-
*SubskribeDevClient::ERPApi* | [**sync_invoice_to_erp**](docs/ERPApi.md#sync_invoice_to_erp) | **POST** /erp/syncInvoice/{invoiceId} |
|
216
|
-
*SubskribeDevClient::ERPApi* | [**sync_void_invoice_to_erp**](docs/ERPApi.md#sync_void_invoice_to_erp) | **POST** /erp/syncVoidInvoice/{invoiceNumber} |
|
212
|
+
*SubskribeDevClient::ERPApi* | [**process_delete_tasks**](docs/ERPApi.md#process_delete_tasks) | **POST** /erp/processDeleteTasks/{accountingPeriodId} | Trigger ERP journal entry deletion task
|
213
|
+
*SubskribeDevClient::ERPApi* | [**process_sync_tasks**](docs/ERPApi.md#process_sync_tasks) | **POST** /erp/processSyncTasks/{accountingPeriodId} | Trigger ERP journal entry sync task
|
214
|
+
*SubskribeDevClient::ERPApi* | [**sync_credit_memo_to_erp**](docs/ERPApi.md#sync_credit_memo_to_erp) | **POST** /erp/syncCreditMemo/{creditMemoNumber} | Trigger ERP credit memo sync task
|
215
|
+
*SubskribeDevClient::ERPApi* | [**sync_invoice_to_erp**](docs/ERPApi.md#sync_invoice_to_erp) | **POST** /erp/syncInvoice/{invoiceId} | Trigger ERP invoice sync task
|
216
|
+
*SubskribeDevClient::ERPApi* | [**sync_void_invoice_to_erp**](docs/ERPApi.md#sync_void_invoice_to_erp) | **POST** /erp/syncVoidInvoice/{invoiceNumber} | Trigger ERP void invoice sync task
|
217
|
+
*SubskribeDevClient::EntitiesApi* | [**account_entity_migration**](docs/EntitiesApi.md#account_entity_migration) | **POST** /entities/migrate/account | Move account to a target entity
|
218
|
+
*SubskribeDevClient::EntitiesApi* | [**composite_order_entity_migration**](docs/EntitiesApi.md#composite_order_entity_migration) | **POST** /entities/migrate/compositeOrder | Move composite order to a target entity
|
217
219
|
*SubskribeDevClient::EntitiesApi* | [**create**](docs/EntitiesApi.md#create) | **POST** /entities | Create an entity
|
218
220
|
*SubskribeDevClient::EntitiesApi* | [**delete_entity**](docs/EntitiesApi.md#delete_entity) | **DELETE** /entities/{id} | Delete entity
|
219
221
|
*SubskribeDevClient::EntitiesApi* | [**get_entities**](docs/EntitiesApi.md#get_entities) | **GET** /entities | Gets entities
|
@@ -221,7 +223,7 @@ Class | Method | HTTP request | Description
|
|
221
223
|
*SubskribeDevClient::EntitiesApi* | [**get_logo**](docs/EntitiesApi.md#get_logo) | **GET** /entities/logo/{entityId} | Get entity logo
|
222
224
|
*SubskribeDevClient::EntitiesApi* | [**order_entity_migration**](docs/EntitiesApi.md#order_entity_migration) | **POST** /entities/migrate/order | Update order entity
|
223
225
|
*SubskribeDevClient::EntitiesApi* | [**subscription_entity_migration**](docs/EntitiesApi.md#subscription_entity_migration) | **POST** /entities/migrate/subscription | Move subscription to a target entity
|
224
|
-
*SubskribeDevClient::
|
226
|
+
*SubskribeDevClient::EntitiesApi* | [**upload_logo**](docs/EntitiesApi.md#upload_logo) | **PUT** /entities/logo/{entityId} | Update entity logo
|
225
227
|
*SubskribeDevClient::ImportApi* | [**create_flatfile_workbook**](docs/ImportApi.md#create_flatfile_workbook) | **POST** /import/flatfile/{domain} | Create a Flatfile workbook
|
226
228
|
*SubskribeDevClient::ImportApi* | [**get_account_contacts_in_import_format**](docs/ImportApi.md#get_account_contacts_in_import_format) | **GET** /import/export/accountContact | Get account contacts for export
|
227
229
|
*SubskribeDevClient::ImportApi* | [**get_amendment_order_export_in_import_format**](docs/ImportApi.md#get_amendment_order_export_in_import_format) | **GET** /import/export/amendmentOrders | Get amendment orders in import CSV format
|
@@ -340,6 +342,7 @@ Class | Method | HTTP request | Description
|
|
340
342
|
*SubskribeDevClient::ProductCatalogApi* | [**reactivate_plan**](docs/ProductCatalogApi.md#reactivate_plan) | **PUT** /plans/{planId}/reactivate | Reactivate a plan
|
341
343
|
*SubskribeDevClient::ProductCatalogApi* | [**update_charge**](docs/ProductCatalogApi.md#update_charge) | **PUT** /plans/{planId}/charges/{chargeId} | Update charge details
|
342
344
|
*SubskribeDevClient::ProductCatalogApi* | [**update_plan**](docs/ProductCatalogApi.md#update_plan) | **PUT** /plans/{planId} | Update plan
|
345
|
+
*SubskribeDevClient::ProductCatalogApi* | [**update_plan_metadata**](docs/ProductCatalogApi.md#update_plan_metadata) | **PUT** /plans/{planId}/metadata | Update plan metadata
|
343
346
|
*SubskribeDevClient::ProductCatalogApi* | [**update_product**](docs/ProductCatalogApi.md#update_product) | **PUT** /products/{id} | Update product details
|
344
347
|
*SubskribeDevClient::ProductCatalogApi* | [**update_product_category**](docs/ProductCatalogApi.md#update_product_category) | **PUT** /product/categories/{id} | Update product category details
|
345
348
|
*SubskribeDevClient::RateCardApi* | [**get_price_attributes_csv**](docs/RateCardApi.md#get_price_attributes_csv) | **GET** /ratecards/attributes/csv | Fetch the price attributes defined in the system in CSV format
|
@@ -354,8 +357,8 @@ Class | Method | HTTP request | Description
|
|
354
357
|
*SubskribeDevClient::RevenueRecognitionApi* | [**create_recognition_event**](docs/RevenueRecognitionApi.md#create_recognition_event) | **POST** /revrec/events | Create a revenue recognition event
|
355
358
|
*SubskribeDevClient::RevenueRecognitionApi* | [**delete_rule**](docs/RevenueRecognitionApi.md#delete_rule) | **DELETE** /revrec/rules/{ruleId} | Delete a recognition rule
|
356
359
|
*SubskribeDevClient::RevenueRecognitionApi* | [**get_recognition_events_by_subscription_id_charge_id**](docs/RevenueRecognitionApi.md#get_recognition_events_by_subscription_id_charge_id) | **GET** /revrec/events | Get revenue recognition events
|
357
|
-
*SubskribeDevClient::RevenueRecognitionApi* | [**get_recognition_rule_by_id**](docs/RevenueRecognitionApi.md#get_recognition_rule_by_id) | **GET** /revrec/rules | Get revenue recognition
|
358
|
-
*SubskribeDevClient::RevenueRecognitionApi* | [**get_recognition_rule_by_id1**](docs/RevenueRecognitionApi.md#get_recognition_rule_by_id1) | **GET** /revrec/rules
|
360
|
+
*SubskribeDevClient::RevenueRecognitionApi* | [**get_recognition_rule_by_id**](docs/RevenueRecognitionApi.md#get_recognition_rule_by_id) | **GET** /revrec/rules/{id} | Get revenue recognition rule
|
361
|
+
*SubskribeDevClient::RevenueRecognitionApi* | [**get_recognition_rule_by_id1**](docs/RevenueRecognitionApi.md#get_recognition_rule_by_id1) | **GET** /revrec/rules | Get revenue recognition rules
|
359
362
|
*SubskribeDevClient::RevenueRecognitionApi* | [**get_revenue_waterfall**](docs/RevenueRecognitionApi.md#get_revenue_waterfall) | **GET** /revrec/waterfall | Download waterfall report
|
360
363
|
*SubskribeDevClient::RevenueRecognitionApi* | [**get_revenue_waterfall_report_v2**](docs/RevenueRecognitionApi.md#get_revenue_waterfall_report_v2) | **GET** /revrec/waterfall/v2 | Download waterfall report
|
361
364
|
*SubskribeDevClient::RevenueRecognitionApi* | [**upload_completion_events**](docs/RevenueRecognitionApi.md#upload_completion_events) | **POST** /revrec/events/upload | Upload revenue events
|
@@ -519,6 +522,7 @@ Class | Method | HTTP request | Description
|
|
519
522
|
- [SubskribeDevClient::OrderLineItemRequestJson](docs/OrderLineItemRequestJson.md)
|
520
523
|
- [SubskribeDevClient::OrderRequestJson](docs/OrderRequestJson.md)
|
521
524
|
- [SubskribeDevClient::OrderTerms](docs/OrderTerms.md)
|
525
|
+
- [SubskribeDevClient::PaginatedAccountsResponse](docs/PaginatedAccountsResponse.md)
|
522
526
|
- [SubskribeDevClient::PaginatedResponse](docs/PaginatedResponse.md)
|
523
527
|
- [SubskribeDevClient::PaymentBalanceJson](docs/PaymentBalanceJson.md)
|
524
528
|
- [SubskribeDevClient::PaymentConfiguration](docs/PaymentConfiguration.md)
|
@@ -527,6 +531,7 @@ Class | Method | HTTP request | Description
|
|
527
531
|
- [SubskribeDevClient::PaymentTermSettingsJson](docs/PaymentTermSettingsJson.md)
|
528
532
|
- [SubskribeDevClient::PlanJson](docs/PlanJson.md)
|
529
533
|
- [SubskribeDevClient::PlanJsonPaginationResponse](docs/PlanJsonPaginationResponse.md)
|
534
|
+
- [SubskribeDevClient::PlanMetadataJson](docs/PlanMetadataJson.md)
|
530
535
|
- [SubskribeDevClient::PredefinedReportDefChartJson](docs/PredefinedReportDefChartJson.md)
|
531
536
|
- [SubskribeDevClient::PredefinedReportDefJson](docs/PredefinedReportDefJson.md)
|
532
537
|
- [SubskribeDevClient::PredefinedReportDefsJson](docs/PredefinedReportDefsJson.md)
|
data/docs/AccountsApi.md
CHANGED
@@ -591,7 +591,7 @@ Name | Type | Description | Notes
|
|
591
591
|
|
592
592
|
|
593
593
|
# **get_accounts**
|
594
|
-
>
|
594
|
+
> PaginatedAccountsResponse get_accounts(opts)
|
595
595
|
|
596
596
|
Get all accounts
|
597
597
|
|
@@ -636,7 +636,7 @@ Name | Type | Description | Notes
|
|
636
636
|
|
637
637
|
### Return type
|
638
638
|
|
639
|
-
[**
|
639
|
+
[**PaginatedAccountsResponse**](PaginatedAccountsResponse.md)
|
640
640
|
|
641
641
|
### Authorization
|
642
642
|
|
@@ -11,8 +11,6 @@ Name | Type | Description | Notes
|
|
11
11
|
**updated_on** | **Integer** | | [optional]
|
12
12
|
**created_on** | **Integer** | | [optional]
|
13
13
|
**last_execution_date** | **Integer** | | [optional]
|
14
|
-
**cron_expression_meaning** | **String** | | [optional]
|
15
|
-
**next_execution_date** | **Integer** | | [optional]
|
16
14
|
**target_duration** | **Integer** | | [optional]
|
17
15
|
**invoice_duration** | **Integer** | | [optional]
|
18
16
|
**include_usage_charge** | **BOOLEAN** | | [optional]
|
@@ -20,5 +18,7 @@ Name | Type | Description | Notes
|
|
20
18
|
**auto_post_invoice** | **BOOLEAN** | | [optional]
|
21
19
|
**auto_email_invoice** | **BOOLEAN** | | [optional]
|
22
20
|
**first_execution_date** | **Integer** | | [optional]
|
21
|
+
**cron_expression_meaning** | **String** | | [optional]
|
22
|
+
**next_execution_date** | **Integer** | | [optional]
|
23
23
|
|
24
24
|
|
data/docs/BulkInvoiceRunItem.md
CHANGED
@@ -18,11 +18,11 @@ Name | Type | Description | Notes
|
|
18
18
|
**email_sent** | **BOOLEAN** | | [optional]
|
19
19
|
**created_on** | **Integer** | | [optional]
|
20
20
|
**updated_on** | **Integer** | | [optional]
|
21
|
-
**included_for_emailing** | **BOOLEAN** | | [optional]
|
22
|
-
**invoice_posted** | **BOOLEAN** | | [optional]
|
23
21
|
**draft_invoice_generated** | **BOOLEAN** | | [optional]
|
24
22
|
**included_for_posting** | **BOOLEAN** | | [optional]
|
25
23
|
**invoice_not_posted** | **BOOLEAN** | | [optional]
|
26
24
|
**draft_invoice_not_generated** | **BOOLEAN** | | [optional]
|
25
|
+
**included_for_emailing** | **BOOLEAN** | | [optional]
|
26
|
+
**invoice_posted** | **BOOLEAN** | | [optional]
|
27
27
|
|
28
28
|
|
@@ -6,13 +6,13 @@ Name | Type | Description | Notes
|
|
6
6
|
**currency_code** | **String** | | [optional]
|
7
7
|
**failed** | **BOOLEAN** | | [optional]
|
8
8
|
**amount** | **Float** | | [optional]
|
9
|
-
**invoice_number** | **String** | | [optional]
|
10
9
|
**note** | **String** | | [optional]
|
11
|
-
**payment_method** | **String** | | [optional]
|
12
10
|
**payment_date** | **Integer** | | [optional]
|
13
11
|
**payment_method_id** | **String** | | [optional]
|
12
|
+
**payment_method** | **String** | | [optional]
|
13
|
+
**invoice_number** | **String** | | [optional]
|
14
14
|
**original_invoice_balance** | **Float** | | [optional]
|
15
|
-
**failure_reason** | **String** | | [optional]
|
16
15
|
**new_invoice_balance** | **Float** | | [optional]
|
16
|
+
**failure_reason** | **String** | | [optional]
|
17
17
|
|
18
18
|
|
@@ -3,8 +3,8 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
+
**payments_request_count** | **Integer** | | [optional]
|
6
7
|
**failed_payments_count** | **Integer** | | [optional]
|
7
8
|
**bulk_payment_upload_data** | [**Array<BulkPaymentUploadData>**](BulkPaymentUploadData.md) | | [optional]
|
8
|
-
**payments_request_count** | **Integer** | | [optional]
|
9
9
|
|
10
10
|
|
data/docs/ChargeJson.md
CHANGED
@@ -39,9 +39,9 @@ Name | Type | Description | Notes
|
|
39
39
|
**billing_term** | **String** | | [optional]
|
40
40
|
**billing_cycle** | **String** | | [optional]
|
41
41
|
**should_track_arr** | **BOOLEAN** | | [optional]
|
42
|
-
**custom** | **BOOLEAN** | | [optional]
|
43
42
|
**drawdown** | **BOOLEAN** | | [optional]
|
44
|
-
**
|
43
|
+
**custom** | **BOOLEAN** | | [optional]
|
45
44
|
**list_price_editable** | **BOOLEAN** | | [optional]
|
45
|
+
**event_based** | **BOOLEAN** | | [optional]
|
46
46
|
|
47
47
|
|
data/docs/ERPApi.md
CHANGED
@@ -4,19 +4,19 @@ All URIs are relative to *https://api.dev2.subskribe.net*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**process_delete_tasks**](ERPApi.md#process_delete_tasks) | **POST** /erp/processDeleteTasks/{accountingPeriodId} |
|
8
|
-
[**process_sync_tasks**](ERPApi.md#process_sync_tasks) | **POST** /erp/processSyncTasks/{accountingPeriodId} |
|
9
|
-
[**sync_credit_memo_to_erp**](ERPApi.md#sync_credit_memo_to_erp) | **POST** /erp/syncCreditMemo/{creditMemoNumber} |
|
10
|
-
[**sync_invoice_to_erp**](ERPApi.md#sync_invoice_to_erp) | **POST** /erp/syncInvoice/{invoiceId} |
|
11
|
-
[**sync_void_invoice_to_erp**](ERPApi.md#sync_void_invoice_to_erp) | **POST** /erp/syncVoidInvoice/{invoiceNumber} |
|
7
|
+
[**process_delete_tasks**](ERPApi.md#process_delete_tasks) | **POST** /erp/processDeleteTasks/{accountingPeriodId} | Trigger ERP journal entry deletion task
|
8
|
+
[**process_sync_tasks**](ERPApi.md#process_sync_tasks) | **POST** /erp/processSyncTasks/{accountingPeriodId} | Trigger ERP journal entry sync task
|
9
|
+
[**sync_credit_memo_to_erp**](ERPApi.md#sync_credit_memo_to_erp) | **POST** /erp/syncCreditMemo/{creditMemoNumber} | Trigger ERP credit memo sync task
|
10
|
+
[**sync_invoice_to_erp**](ERPApi.md#sync_invoice_to_erp) | **POST** /erp/syncInvoice/{invoiceId} | Trigger ERP invoice sync task
|
11
|
+
[**sync_void_invoice_to_erp**](ERPApi.md#sync_void_invoice_to_erp) | **POST** /erp/syncVoidInvoice/{invoiceNumber} | Trigger ERP void invoice sync task
|
12
12
|
|
13
13
|
|
14
14
|
# **process_delete_tasks**
|
15
15
|
> process_delete_tasks(accounting_period_id)
|
16
16
|
|
17
|
-
|
18
|
-
|
17
|
+
Trigger ERP journal entry deletion task
|
19
18
|
|
19
|
+
Trigger ERP journal entry deletion task for the given accounting period id
|
20
20
|
|
21
21
|
### Example
|
22
22
|
```ruby
|
@@ -36,7 +36,7 @@ accounting_period_id = 'accounting_period_id_example' # String |
|
|
36
36
|
|
37
37
|
|
38
38
|
begin
|
39
|
-
#
|
39
|
+
#Trigger ERP journal entry deletion task
|
40
40
|
api_instance.process_delete_tasks(accounting_period_id)
|
41
41
|
rescue SubskribeDevClient::ApiError => e
|
42
42
|
puts "Exception when calling ERPApi->process_delete_tasks: #{e}"
|
@@ -67,9 +67,9 @@ nil (empty response body)
|
|
67
67
|
# **process_sync_tasks**
|
68
68
|
> process_sync_tasks(accounting_period_id)
|
69
69
|
|
70
|
-
|
71
|
-
|
70
|
+
Trigger ERP journal entry sync task
|
72
71
|
|
72
|
+
Trigger ERP journal entry sync task for given accounting period id
|
73
73
|
|
74
74
|
### Example
|
75
75
|
```ruby
|
@@ -89,7 +89,7 @@ accounting_period_id = 'accounting_period_id_example' # String |
|
|
89
89
|
|
90
90
|
|
91
91
|
begin
|
92
|
-
#
|
92
|
+
#Trigger ERP journal entry sync task
|
93
93
|
api_instance.process_sync_tasks(accounting_period_id)
|
94
94
|
rescue SubskribeDevClient::ApiError => e
|
95
95
|
puts "Exception when calling ERPApi->process_sync_tasks: #{e}"
|
@@ -120,9 +120,9 @@ nil (empty response body)
|
|
120
120
|
# **sync_credit_memo_to_erp**
|
121
121
|
> sync_credit_memo_to_erp(credit_memo_number)
|
122
122
|
|
123
|
-
|
124
|
-
|
123
|
+
Trigger ERP credit memo sync task
|
125
124
|
|
125
|
+
Trigger ERP credit memo sync task for the given credit memo number
|
126
126
|
|
127
127
|
### Example
|
128
128
|
```ruby
|
@@ -142,7 +142,7 @@ credit_memo_number = 'credit_memo_number_example' # String |
|
|
142
142
|
|
143
143
|
|
144
144
|
begin
|
145
|
-
#
|
145
|
+
#Trigger ERP credit memo sync task
|
146
146
|
api_instance.sync_credit_memo_to_erp(credit_memo_number)
|
147
147
|
rescue SubskribeDevClient::ApiError => e
|
148
148
|
puts "Exception when calling ERPApi->sync_credit_memo_to_erp: #{e}"
|
@@ -173,9 +173,9 @@ nil (empty response body)
|
|
173
173
|
# **sync_invoice_to_erp**
|
174
174
|
> sync_invoice_to_erp(invoice_id)
|
175
175
|
|
176
|
-
|
177
|
-
|
176
|
+
Trigger ERP invoice sync task
|
178
177
|
|
178
|
+
Trigger ERP invoice sync task for the given invoice id
|
179
179
|
|
180
180
|
### Example
|
181
181
|
```ruby
|
@@ -195,7 +195,7 @@ invoice_id = 'invoice_id_example' # String |
|
|
195
195
|
|
196
196
|
|
197
197
|
begin
|
198
|
-
#
|
198
|
+
#Trigger ERP invoice sync task
|
199
199
|
api_instance.sync_invoice_to_erp(invoice_id)
|
200
200
|
rescue SubskribeDevClient::ApiError => e
|
201
201
|
puts "Exception when calling ERPApi->sync_invoice_to_erp: #{e}"
|
@@ -226,9 +226,9 @@ nil (empty response body)
|
|
226
226
|
# **sync_void_invoice_to_erp**
|
227
227
|
> sync_void_invoice_to_erp(invoice_number)
|
228
228
|
|
229
|
-
|
230
|
-
|
229
|
+
Trigger ERP void invoice sync task
|
231
230
|
|
231
|
+
Trigger ERP void invoice sync task for the given invoice number
|
232
232
|
|
233
233
|
### Example
|
234
234
|
```ruby
|
@@ -248,7 +248,7 @@ invoice_number = 'invoice_number_example' # String |
|
|
248
248
|
|
249
249
|
|
250
250
|
begin
|
251
|
-
#
|
251
|
+
#Trigger ERP void invoice sync task
|
252
252
|
api_instance.sync_void_invoice_to_erp(invoice_number)
|
253
253
|
rescue SubskribeDevClient::ApiError => e
|
254
254
|
puts "Exception when calling ERPApi->sync_void_invoice_to_erp: #{e}"
|
data/docs/EntitiesApi.md
CHANGED
@@ -4,6 +4,8 @@ All URIs are relative to *https://api.dev2.subskribe.net*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
+
[**account_entity_migration**](EntitiesApi.md#account_entity_migration) | **POST** /entities/migrate/account | Move account to a target entity
|
8
|
+
[**composite_order_entity_migration**](EntitiesApi.md#composite_order_entity_migration) | **POST** /entities/migrate/compositeOrder | Move composite order to a target entity
|
7
9
|
[**create**](EntitiesApi.md#create) | **POST** /entities | Create an entity
|
8
10
|
[**delete_entity**](EntitiesApi.md#delete_entity) | **DELETE** /entities/{id} | Delete entity
|
9
11
|
[**get_entities**](EntitiesApi.md#get_entities) | **GET** /entities | Gets entities
|
@@ -11,6 +13,119 @@ Method | HTTP request | Description
|
|
11
13
|
[**get_logo**](EntitiesApi.md#get_logo) | **GET** /entities/logo/{entityId} | Get entity logo
|
12
14
|
[**order_entity_migration**](EntitiesApi.md#order_entity_migration) | **POST** /entities/migrate/order | Update order entity
|
13
15
|
[**subscription_entity_migration**](EntitiesApi.md#subscription_entity_migration) | **POST** /entities/migrate/subscription | Move subscription to a target entity
|
16
|
+
[**upload_logo**](EntitiesApi.md#upload_logo) | **PUT** /entities/logo/{entityId} | Update entity logo
|
17
|
+
|
18
|
+
|
19
|
+
# **account_entity_migration**
|
20
|
+
> account_entity_migration(opts)
|
21
|
+
|
22
|
+
Move account to a target entity
|
23
|
+
|
24
|
+
Move account along with its subscriptions, orders, invoices and other associated transactions to a target entity
|
25
|
+
|
26
|
+
### Example
|
27
|
+
```ruby
|
28
|
+
# load the gem
|
29
|
+
require 'subskribe_dev'
|
30
|
+
# setup authorization
|
31
|
+
SubskribeDevClient.configure do |config|
|
32
|
+
# Configure API key authorization: ApiKeyAuth
|
33
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
34
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
35
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
36
|
+
end
|
37
|
+
|
38
|
+
api_instance = SubskribeDevClient::EntitiesApi.new
|
39
|
+
|
40
|
+
opts = {
|
41
|
+
target_entity_id: 'target_entity_id_example', # String |
|
42
|
+
account_id: 'account_id_example' # String |
|
43
|
+
}
|
44
|
+
|
45
|
+
begin
|
46
|
+
#Move account to a target entity
|
47
|
+
api_instance.account_entity_migration(opts)
|
48
|
+
rescue SubskribeDevClient::ApiError => e
|
49
|
+
puts "Exception when calling EntitiesApi->account_entity_migration: #{e}"
|
50
|
+
end
|
51
|
+
```
|
52
|
+
|
53
|
+
### Parameters
|
54
|
+
|
55
|
+
Name | Type | Description | Notes
|
56
|
+
------------- | ------------- | ------------- | -------------
|
57
|
+
**target_entity_id** | **String**| | [optional]
|
58
|
+
**account_id** | **String**| | [optional]
|
59
|
+
|
60
|
+
### Return type
|
61
|
+
|
62
|
+
nil (empty response body)
|
63
|
+
|
64
|
+
### Authorization
|
65
|
+
|
66
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
67
|
+
|
68
|
+
### HTTP request headers
|
69
|
+
|
70
|
+
- **Content-Type**: Not defined
|
71
|
+
- **Accept**: application/json
|
72
|
+
|
73
|
+
|
74
|
+
|
75
|
+
# **composite_order_entity_migration**
|
76
|
+
> composite_order_entity_migration(opts)
|
77
|
+
|
78
|
+
Move composite order to a target entity
|
79
|
+
|
80
|
+
Move composite order along with its subscriptions, orders and other associated transactions to a target entity
|
81
|
+
|
82
|
+
### Example
|
83
|
+
```ruby
|
84
|
+
# load the gem
|
85
|
+
require 'subskribe_dev'
|
86
|
+
# setup authorization
|
87
|
+
SubskribeDevClient.configure do |config|
|
88
|
+
# Configure API key authorization: ApiKeyAuth
|
89
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
90
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
91
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
92
|
+
end
|
93
|
+
|
94
|
+
api_instance = SubskribeDevClient::EntitiesApi.new
|
95
|
+
|
96
|
+
opts = {
|
97
|
+
target_entity_id: 'target_entity_id_example', # String |
|
98
|
+
composite_order_id: 'composite_order_id_example' # String |
|
99
|
+
}
|
100
|
+
|
101
|
+
begin
|
102
|
+
#Move composite order to a target entity
|
103
|
+
api_instance.composite_order_entity_migration(opts)
|
104
|
+
rescue SubskribeDevClient::ApiError => e
|
105
|
+
puts "Exception when calling EntitiesApi->composite_order_entity_migration: #{e}"
|
106
|
+
end
|
107
|
+
```
|
108
|
+
|
109
|
+
### Parameters
|
110
|
+
|
111
|
+
Name | Type | Description | Notes
|
112
|
+
------------- | ------------- | ------------- | -------------
|
113
|
+
**target_entity_id** | **String**| | [optional]
|
114
|
+
**composite_order_id** | **String**| | [optional]
|
115
|
+
|
116
|
+
### Return type
|
117
|
+
|
118
|
+
nil (empty response body)
|
119
|
+
|
120
|
+
### Authorization
|
121
|
+
|
122
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
123
|
+
|
124
|
+
### HTTP request headers
|
125
|
+
|
126
|
+
- **Content-Type**: Not defined
|
127
|
+
- **Accept**: application/json
|
128
|
+
|
14
129
|
|
15
130
|
|
16
131
|
# **create**
|
@@ -387,3 +502,60 @@ nil (empty response body)
|
|
387
502
|
|
388
503
|
|
389
504
|
|
505
|
+
# **upload_logo**
|
506
|
+
> upload_logo(entity_id, opts)
|
507
|
+
|
508
|
+
Update entity logo
|
509
|
+
|
510
|
+
Updates the logo used in external facing communication such as order forms and invoices
|
511
|
+
|
512
|
+
### Example
|
513
|
+
```ruby
|
514
|
+
# load the gem
|
515
|
+
require 'subskribe_dev'
|
516
|
+
# setup authorization
|
517
|
+
SubskribeDevClient.configure do |config|
|
518
|
+
# Configure API key authorization: ApiKeyAuth
|
519
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
520
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
521
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
522
|
+
end
|
523
|
+
|
524
|
+
api_instance = SubskribeDevClient::EntitiesApi.new
|
525
|
+
|
526
|
+
entity_id = 'entity_id_example' # String |
|
527
|
+
|
528
|
+
opts = {
|
529
|
+
file: File.new('/path/to/file.txt') # File |
|
530
|
+
}
|
531
|
+
|
532
|
+
begin
|
533
|
+
#Update entity logo
|
534
|
+
api_instance.upload_logo(entity_id, opts)
|
535
|
+
rescue SubskribeDevClient::ApiError => e
|
536
|
+
puts "Exception when calling EntitiesApi->upload_logo: #{e}"
|
537
|
+
end
|
538
|
+
```
|
539
|
+
|
540
|
+
### Parameters
|
541
|
+
|
542
|
+
Name | Type | Description | Notes
|
543
|
+
------------- | ------------- | ------------- | -------------
|
544
|
+
**entity_id** | **String**| |
|
545
|
+
**file** | **File**| | [optional]
|
546
|
+
|
547
|
+
### Return type
|
548
|
+
|
549
|
+
nil (empty response body)
|
550
|
+
|
551
|
+
### Authorization
|
552
|
+
|
553
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
554
|
+
|
555
|
+
### HTTP request headers
|
556
|
+
|
557
|
+
- **Content-Type**: multipart/form-data
|
558
|
+
- **Accept**: application/json
|
559
|
+
|
560
|
+
|
561
|
+
|
data/docs/OrderLineItemJson.md
CHANGED
@@ -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
|
|
@@ -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/ProductCatalogApi.md
CHANGED
@@ -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
|
|