recurly 4.51.0 → 4.53.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -14,14 +14,26 @@ module Recurly
14
14
  # @return [DateTime] Created at
15
15
  define_attribute :created_at, DateTime
16
16
 
17
+ # @!attribute default_liability_gl_account_id
18
+ # @return [String] The ID of a general ledger account. General ledger accounts are only accessible as a part of the Recurly RevRec Standard and Recurly RevRec Advanced features.
19
+ define_attribute :default_liability_gl_account_id, String
20
+
17
21
  # @!attribute default_registration_number
18
22
  # @return [String] Registration number for the customer used on the invoice.
19
23
  define_attribute :default_registration_number, String
20
24
 
25
+ # @!attribute default_revenue_gl_account_id
26
+ # @return [String] The ID of a general ledger account. General ledger accounts are only accessible as a part of the Recurly RevRec Standard and Recurly RevRec Advanced features.
27
+ define_attribute :default_revenue_gl_account_id, String
28
+
21
29
  # @!attribute default_vat_number
22
30
  # @return [String] VAT number for the customer used on the invoice.
23
31
  define_attribute :default_vat_number, String
24
32
 
33
+ # @!attribute destination_tax_address_source
34
+ # @return [String] The source of the address that will be used as the destinaion in determining taxes. Available only when the site is on an Elite plan. A value of "destination" refers to the "Customer tax address". A value of "origin" refers to the "Business entity tax address".
35
+ define_attribute :destination_tax_address_source, String
36
+
25
37
  # @!attribute id
26
38
  # @return [String] Business entity ID
27
39
  define_attribute :id, String
@@ -38,6 +50,10 @@ module Recurly
38
50
  # @return [String] Object type
39
51
  define_attribute :object, String
40
52
 
53
+ # @!attribute origin_tax_address_source
54
+ # @return [String] The source of the address that will be used as the origin in determining taxes. Available only when the site is on an Elite plan. A value of "origin" refers to the "Business entity tax address". A value of "destination" refers to the "Customer tax address".
55
+ define_attribute :origin_tax_address_source, String
56
+
41
57
  # @!attribute subscriber_location_countries
42
58
  # @return [Array[String]] List of countries for which the business entity will be used.
43
59
  define_attribute :subscriber_location_countries, Array, { :item_type => String }
@@ -26,10 +26,6 @@ module Recurly
26
26
  # @return [DateTime] Ends At
27
27
  define_attribute :ends_at, DateTime
28
28
 
29
- # @!attribute external_subscription
30
- # @return [ExternalSubscription] Subscription from an external resource such as Apple App Store or Google Play Store.
31
- define_attribute :external_subscription, :ExternalSubscription
32
-
33
29
  # @!attribute id
34
30
  # @return [String] System-generated unique identifier for an external payment phase ID, e.g. `e28zov4fw0v2`.
35
31
  define_attribute :id, String
@@ -38,6 +38,10 @@ module Recurly
38
38
  # @return [String] The id of the subscription in the external systems., I.e. Apple App Store or Google Play Store.
39
39
  define_attribute :external_id, String
40
40
 
41
+ # @!attribute external_payment_phases
42
+ # @return [Array[ExternalPaymentPhase]] The phases of the external subscription payment lifecycle.
43
+ define_attribute :external_payment_phases, Array, { :item_type => :ExternalPaymentPhase }
44
+
41
45
  # @!attribute external_product_reference
42
46
  # @return [ExternalProductReferenceMini] External Product Reference details
43
47
  define_attribute :external_product_reference, :ExternalProductReferenceMini
@@ -46,6 +50,10 @@ module Recurly
46
50
  # @return [String] System-generated unique identifier for an external subscription ID, e.g. `e28zov4fw0v2`.
47
51
  define_attribute :id, String
48
52
 
53
+ # @!attribute imported
54
+ # @return [Boolean] An indication of whether or not the external subscription was created by a historical data import.
55
+ define_attribute :imported, :Boolean
56
+
49
57
  # @!attribute in_grace_period
50
58
  # @return [Boolean] An indication of whether or not the external subscription is in a grace period.
51
59
  define_attribute :in_grace_period, :Boolean
@@ -63,7 +71,7 @@ module Recurly
63
71
  define_attribute :quantity, Integer
64
72
 
65
73
  # @!attribute state
66
- # @return [String] External subscriptions can be active, canceled, expired, or past_due.
74
+ # @return [String] External subscriptions can be active, canceled, expired, past_due, voided, revoked, or paused.
67
75
  define_attribute :state, String
68
76
 
69
77
  # @!attribute test
@@ -0,0 +1,38 @@
1
+ # This file is automatically created by Recurly's OpenAPI generation process
2
+ # and thus any edits you make by hand will be lost. If you wish to make a
3
+ # change to this file, please create a Github issue explaining the changes you
4
+ # need and we will usher them to the appropriate places.
5
+ module Recurly
6
+ module Resources
7
+ class GeneralLedgerAccount < Resource
8
+
9
+ # @!attribute account_type
10
+ # @return [String]
11
+ define_attribute :account_type, String
12
+
13
+ # @!attribute code
14
+ # @return [String] Unique code to identify the ledger account. Each code must start with a letter or number. The following special characters are allowed: `-_.,:`
15
+ define_attribute :code, String
16
+
17
+ # @!attribute created_at
18
+ # @return [DateTime] Created at
19
+ define_attribute :created_at, DateTime
20
+
21
+ # @!attribute description
22
+ # @return [String] Optional description.
23
+ define_attribute :description, String
24
+
25
+ # @!attribute id
26
+ # @return [String] The ID of a general ledger account. General ledger accounts are only accessible as a part of the Recurly RevRec Standard and Recurly RevRec Advanced features.
27
+ define_attribute :id, String
28
+
29
+ # @!attribute object
30
+ # @return [String] Object type
31
+ define_attribute :object, String
32
+
33
+ # @!attribute updated_at
34
+ # @return [DateTime] Last updated at
35
+ define_attribute :updated_at, DateTime
36
+ end
37
+ end
38
+ end
@@ -38,10 +38,18 @@ module Recurly
38
38
  # @return [String] Gift card ID
39
39
  define_attribute :id, String
40
40
 
41
+ # @!attribute liability_gl_account_id
42
+ # @return [String] The ID of a general ledger account. General ledger accounts are only accessible as a part of the Recurly RevRec Standard and Recurly RevRec Advanced features.
43
+ define_attribute :liability_gl_account_id, String
44
+
41
45
  # @!attribute object
42
46
  # @return [String] Object type
43
47
  define_attribute :object, String
44
48
 
49
+ # @!attribute performance_obligation_id
50
+ # @return [String] The ID of a performance obligation. Performance obligations are only accessible as a part of the Recurly RevRec Standard and Recurly RevRec Advanced features.
51
+ define_attribute :performance_obligation_id, String
52
+
45
53
  # @!attribute product_code
46
54
  # @return [String] The product code or SKU of the gift card product.
47
55
  define_attribute :product_code, String
@@ -66,6 +74,10 @@ module Recurly
66
74
  # @return [String] The ID of the invoice for the gift card redemption made by the recipient. Does not have a value until gift card is redeemed.
67
75
  define_attribute :redemption_invoice_id, String
68
76
 
77
+ # @!attribute revenue_gl_account_id
78
+ # @return [String] The ID of a general ledger account. General ledger accounts are only accessible as a part of the Recurly RevRec Standard and Recurly RevRec Advanced features.
79
+ define_attribute :revenue_gl_account_id, String
80
+
69
81
  # @!attribute unit_amount
70
82
  # @return [Float] The amount of the gift card, which is the amount of the charge to the gifter account and the amount of credit that is applied to the recipient account upon successful redemption.
71
83
  define_attribute :unit_amount, Float
@@ -50,6 +50,10 @@ module Recurly
50
50
  # @return [String] Item ID
51
51
  define_attribute :id, String
52
52
 
53
+ # @!attribute liability_gl_account_id
54
+ # @return [String] The ID of a general ledger account. General ledger accounts are only accessible as a part of the Recurly RevRec Standard and Recurly RevRec Advanced features.
55
+ define_attribute :liability_gl_account_id, String
56
+
53
57
  # @!attribute name
54
58
  # @return [String] This name describes your item and will appear on the invoice when it's purchased on a one time basis.
55
59
  define_attribute :name, String
@@ -58,6 +62,14 @@ module Recurly
58
62
  # @return [String] Object type
59
63
  define_attribute :object, String
60
64
 
65
+ # @!attribute performance_obligation_id
66
+ # @return [String] The ID of a performance obligation. Performance obligations are only accessible as a part of the Recurly RevRec Standard and Recurly RevRec Advanced features.
67
+ define_attribute :performance_obligation_id, String
68
+
69
+ # @!attribute revenue_gl_account_id
70
+ # @return [String] The ID of a general ledger account. General ledger accounts are only accessible as a part of the Recurly RevRec Standard and Recurly RevRec Advanced features.
71
+ define_attribute :revenue_gl_account_id, String
72
+
61
73
  # @!attribute revenue_schedule_type
62
74
  # @return [String] Revenue schedule type
63
75
  define_attribute :revenue_schedule_type, String
@@ -62,6 +62,10 @@ module Recurly
62
62
  # @return [String] Description that appears on the invoice. For subscription related items this will be filled in automatically.
63
63
  define_attribute :description, String
64
64
 
65
+ # @!attribute destination_tax_address_source
66
+ # @return [String] The source of the address that will be used as the destinaion in determining taxes. Available only when the site is on an Elite plan. A value of "destination" refers to the "Customer tax address". A value of "origin" refers to the "Business entity tax address".
67
+ define_attribute :destination_tax_address_source, String
68
+
65
69
  # @!attribute discount
66
70
  # @return [Float] The discount applied to the line item.
67
71
  define_attribute :discount, Float
@@ -98,6 +102,10 @@ module Recurly
98
102
  # @return [String] Category to describe the role of a line item on a legacy invoice: - "charges" refers to charges being billed for on this invoice. - "credits" refers to refund or proration credits. This portion of the invoice can be considered a credit memo. - "applied_credits" refers to previous credits applied to this invoice. See their original_line_item_id to determine where the credit first originated. - "carryforwards" can be ignored. They exist to consume any remaining credit balance. A new credit with the same amount will be created and placed back on the account.
99
103
  define_attribute :legacy_category, String
100
104
 
105
+ # @!attribute liability_gl_account_code
106
+ # @return [String] Unique code to identify the ledger account. Each code must start with a letter or number. The following special characters are allowed: `-_.,:`
107
+ define_attribute :liability_gl_account_code, String
108
+
101
109
  # @!attribute object
102
110
  # @return [String] Object type
103
111
  define_attribute :object, String
@@ -106,10 +114,18 @@ module Recurly
106
114
  # @return [String] A credit created from an original charge will have the value of the charge's origin.
107
115
  define_attribute :origin, String
108
116
 
117
+ # @!attribute origin_tax_address_source
118
+ # @return [String] The source of the address that will be used as the origin in determining taxes. Available only when the site is on an Elite plan. A value of "origin" refers to the "Business entity tax address". A value of "destination" refers to the "Customer tax address".
119
+ define_attribute :origin_tax_address_source, String
120
+
109
121
  # @!attribute original_line_item_invoice_id
110
122
  # @return [String] The invoice where the credit originated. Will only have a value if the line item is a credit created from a previous credit, or if the credit was created from a charge refund.
111
123
  define_attribute :original_line_item_invoice_id, String
112
124
 
125
+ # @!attribute performance_obligation_id
126
+ # @return [String] The ID of a performance obligation. Performance obligations are only accessible as a part of the Recurly RevRec Standard and Recurly RevRec Advanced features.
127
+ define_attribute :performance_obligation_id, String
128
+
113
129
  # @!attribute plan_code
114
130
  # @return [String] If the line item is a charge or credit for a plan or add-on, this is the plan's code.
115
131
  define_attribute :plan_code, String
@@ -150,6 +166,10 @@ module Recurly
150
166
  # @return [String] A floating-point alternative to Refunded Quantity. For refund charges, the quantity being refunded. For non-refund charges, the total quantity refunded (possibly over multiple refunds). The Decimal Quantity feature must be enabled to utilize this field.
151
167
  define_attribute :refunded_quantity_decimal, String
152
168
 
169
+ # @!attribute revenue_gl_account_code
170
+ # @return [String] Unique code to identify the ledger account. Each code must start with a letter or number. The following special characters are allowed: `-_.,:`
171
+ define_attribute :revenue_gl_account_code, String
172
+
153
173
  # @!attribute revenue_schedule_type
154
174
  # @return [String] Revenue schedule type
155
175
  define_attribute :revenue_schedule_type, String
@@ -0,0 +1,26 @@
1
+ # This file is automatically created by Recurly's OpenAPI generation process
2
+ # and thus any edits you make by hand will be lost. If you wish to make a
3
+ # change to this file, please create a Github issue explaining the changes you
4
+ # need and we will usher them to the appropriate places.
5
+ module Recurly
6
+ module Resources
7
+ class PerformanceObligation < Resource
8
+
9
+ # @!attribute created_at
10
+ # @return [DateTime] Created At
11
+ define_attribute :created_at, DateTime
12
+
13
+ # @!attribute id
14
+ # @return [String] The ID of a performance obligation. Performance obligations are only accessible as a part of the Recurly RevRec Standard and Recurly RevRec Advanced features.
15
+ define_attribute :id, String
16
+
17
+ # @!attribute name
18
+ # @return [String] Performance Obligation Name
19
+ define_attribute :name, String
20
+
21
+ # @!attribute updated_at
22
+ # @return [DateTime] Last updated at
23
+ define_attribute :updated_at, DateTime
24
+ end
25
+ end
26
+ end
@@ -26,6 +26,10 @@ module Recurly
26
26
  # @return [String] Shipping Method ID
27
27
  define_attribute :id, String
28
28
 
29
+ # @!attribute liability_gl_account_id
30
+ # @return [String] The ID of a general ledger account. General ledger accounts are only accessible as a part of the Recurly RevRec Standard and Recurly RevRec Advanced features.
31
+ define_attribute :liability_gl_account_id, String
32
+
29
33
  # @!attribute name
30
34
  # @return [String] The name of the shipping method displayed to customers.
31
35
  define_attribute :name, String
@@ -34,6 +38,14 @@ module Recurly
34
38
  # @return [String] Object type
35
39
  define_attribute :object, String
36
40
 
41
+ # @!attribute performance_obligation_id
42
+ # @return [String] The ID of a performance obligation. Performance obligations are only accessible as a part of the Recurly RevRec Standard and Recurly RevRec Advanced features.
43
+ define_attribute :performance_obligation_id, String
44
+
45
+ # @!attribute revenue_gl_account_id
46
+ # @return [String] The ID of a general ledger account. General ledger accounts are only accessible as a part of the Recurly RevRec Standard and Recurly RevRec Advanced features.
47
+ define_attribute :revenue_gl_account_id, String
48
+
37
49
  # @!attribute tax_code
38
50
  # @return [String] Used by Avalara, Vertex, and Recurly’s built-in tax feature. The tax code values are specific to each tax system. If you are using Recurly’s built-in taxes the values are: - `FR` – Common Carrier FOB Destination - `FR022000` – Common Carrier FOB Origin - `FR020400` – Non Common Carrier FOB Destination - `FR020500` – Non Common Carrier FOB Origin - `FR010100` – Delivery by Company Vehicle Before Passage of Title - `FR010200` – Delivery by Company Vehicle After Passage of Title - `NT` – Non-Taxable
39
51
  define_attribute :tax_code, String
@@ -1,3 +1,3 @@
1
1
  module Recurly
2
- VERSION = "4.51.0"
2
+ VERSION = "4.53.0"
3
3
  end