terminal-shop 3.7.0 → 3.8.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.
Files changed (159) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +42 -0
  3. data/README.md +81 -53
  4. data/SECURITY.md +2 -2
  5. data/lib/terminal_shop/client.rb +4 -4
  6. data/lib/terminal_shop/internal/transport/pooled_net_requester.rb +3 -1
  7. data/lib/terminal_shop/internal/type/array_of.rb +8 -0
  8. data/lib/terminal_shop/internal/type/base_model.rb +15 -0
  9. data/lib/terminal_shop/internal/type/boolean.rb +8 -0
  10. data/lib/terminal_shop/internal/type/enum.rb +12 -0
  11. data/lib/terminal_shop/internal/type/file_input.rb +7 -0
  12. data/lib/terminal_shop/internal/type/hash_of.rb +8 -0
  13. data/lib/terminal_shop/internal/type/union.rb +12 -0
  14. data/lib/terminal_shop/internal/type/unknown.rb +8 -0
  15. data/lib/terminal_shop/internal/util.rb +50 -1
  16. data/lib/terminal_shop/internal.rb +3 -0
  17. data/lib/terminal_shop/models/address.rb +2 -2
  18. data/lib/terminal_shop/models/address_get_response.rb +2 -2
  19. data/lib/terminal_shop/models/address_list_response.rb +2 -2
  20. data/lib/terminal_shop/models/app.rb +2 -2
  21. data/lib/terminal_shop/models/app_get_response.rb +2 -2
  22. data/lib/terminal_shop/models/app_list_response.rb +2 -2
  23. data/lib/terminal_shop/models/card.rb +5 -5
  24. data/lib/terminal_shop/models/card_get_response.rb +2 -2
  25. data/lib/terminal_shop/models/card_list_response.rb +2 -2
  26. data/lib/terminal_shop/models/cart.rb +9 -9
  27. data/lib/terminal_shop/models/cart_convert_response.rb +2 -2
  28. data/lib/terminal_shop/models/cart_get_response.rb +2 -2
  29. data/lib/terminal_shop/models/cart_set_item_response.rb +2 -2
  30. data/lib/terminal_shop/models/order.rb +17 -17
  31. data/lib/terminal_shop/models/order_get_response.rb +2 -2
  32. data/lib/terminal_shop/models/order_list_response.rb +2 -2
  33. data/lib/terminal_shop/models/product.rb +10 -10
  34. data/lib/terminal_shop/models/product_get_response.rb +2 -2
  35. data/lib/terminal_shop/models/product_list_response.rb +2 -2
  36. data/lib/terminal_shop/models/product_variant.rb +4 -4
  37. data/lib/terminal_shop/models/profile.rb +4 -4
  38. data/lib/terminal_shop/models/profile_me_response.rb +2 -2
  39. data/lib/terminal_shop/models/profile_update_response.rb +2 -2
  40. data/lib/terminal_shop/models/subscription.rb +5 -14
  41. data/lib/terminal_shop/models/subscription_get_response.rb +2 -2
  42. data/lib/terminal_shop/models/subscription_list_response.rb +2 -2
  43. data/lib/terminal_shop/models/subscription_update_params.rb +3 -12
  44. data/lib/terminal_shop/models/subscription_update_response.rb +2 -2
  45. data/lib/terminal_shop/models/token.rb +2 -2
  46. data/lib/terminal_shop/models/token_get_response.rb +2 -2
  47. data/lib/terminal_shop/models/token_list_response.rb +2 -2
  48. data/lib/terminal_shop/models/view_init_response.rb +20 -20
  49. data/lib/terminal_shop/models.rb +30 -19
  50. data/lib/terminal_shop/resources/subscription.rb +2 -2
  51. data/lib/terminal_shop/version.rb +1 -1
  52. data/rbi/terminal_shop/internal/transport/pooled_net_requester.rbi +5 -1
  53. data/rbi/terminal_shop/internal/type/array_of.rbi +6 -0
  54. data/rbi/terminal_shop/internal/type/base_model.rbi +5 -0
  55. data/rbi/terminal_shop/internal/type/boolean.rbi +6 -0
  56. data/rbi/terminal_shop/internal/type/enum.rbi +5 -0
  57. data/rbi/terminal_shop/internal/type/file_input.rbi +5 -0
  58. data/rbi/terminal_shop/internal/type/hash_of.rbi +6 -0
  59. data/rbi/terminal_shop/internal/type/union.rbi +5 -0
  60. data/rbi/terminal_shop/internal/type/unknown.rbi +6 -0
  61. data/rbi/terminal_shop/internal/util.rbi +34 -0
  62. data/rbi/terminal_shop/internal.rbi +5 -0
  63. data/rbi/terminal_shop/models/subscription.rbi +2 -13
  64. data/sig/terminal_shop/internal/transport/pooled_net_requester.rbs +2 -0
  65. data/sig/terminal_shop/internal/type/array_of.rbs +3 -0
  66. data/sig/terminal_shop/internal/type/base_model.rbs +2 -0
  67. data/sig/terminal_shop/internal/type/boolean.rbs +3 -0
  68. data/sig/terminal_shop/internal/type/enum.rbs +2 -0
  69. data/sig/terminal_shop/internal/type/file_input.rbs +2 -0
  70. data/sig/terminal_shop/internal/type/hash_of.rbs +3 -0
  71. data/sig/terminal_shop/internal/type/union.rbs +2 -0
  72. data/sig/terminal_shop/internal/type/unknown.rbs +3 -0
  73. data/sig/terminal_shop/internal/util.rbs +12 -0
  74. data/sig/terminal_shop/internal.rbs +2 -0
  75. data/sig/terminal_shop/models/address.rbs +13 -0
  76. data/sig/terminal_shop/models/address_create_params.rbs +12 -0
  77. data/sig/terminal_shop/models/address_create_response.rbs +2 -0
  78. data/sig/terminal_shop/models/address_delete_params.rbs +2 -0
  79. data/sig/terminal_shop/models/address_delete_response.rbs +2 -0
  80. data/sig/terminal_shop/models/address_get_params.rbs +2 -0
  81. data/sig/terminal_shop/models/address_get_response.rbs +2 -0
  82. data/sig/terminal_shop/models/address_list_params.rbs +2 -0
  83. data/sig/terminal_shop/models/address_list_response.rbs +2 -0
  84. data/sig/terminal_shop/models/app.rbs +7 -0
  85. data/sig/terminal_shop/models/app_create_params.rbs +6 -0
  86. data/sig/terminal_shop/models/app_create_response.rbs +4 -0
  87. data/sig/terminal_shop/models/app_delete_params.rbs +2 -0
  88. data/sig/terminal_shop/models/app_delete_response.rbs +2 -0
  89. data/sig/terminal_shop/models/app_get_params.rbs +2 -0
  90. data/sig/terminal_shop/models/app_get_response.rbs +2 -0
  91. data/sig/terminal_shop/models/app_list_params.rbs +2 -0
  92. data/sig/terminal_shop/models/app_list_response.rbs +2 -0
  93. data/sig/terminal_shop/models/card.rbs +10 -0
  94. data/sig/terminal_shop/models/card_collect_params.rbs +2 -0
  95. data/sig/terminal_shop/models/card_collect_response.rbs +4 -0
  96. data/sig/terminal_shop/models/card_create_params.rbs +5 -0
  97. data/sig/terminal_shop/models/card_create_response.rbs +2 -0
  98. data/sig/terminal_shop/models/card_delete_params.rbs +2 -0
  99. data/sig/terminal_shop/models/card_delete_response.rbs +2 -0
  100. data/sig/terminal_shop/models/card_get_params.rbs +2 -0
  101. data/sig/terminal_shop/models/card_get_response.rbs +2 -0
  102. data/sig/terminal_shop/models/card_list_params.rbs +2 -0
  103. data/sig/terminal_shop/models/card_list_response.rbs +2 -0
  104. data/sig/terminal_shop/models/cart.rbs +20 -0
  105. data/sig/terminal_shop/models/cart_clear_params.rbs +2 -0
  106. data/sig/terminal_shop/models/cart_clear_response.rbs +2 -0
  107. data/sig/terminal_shop/models/cart_convert_params.rbs +2 -0
  108. data/sig/terminal_shop/models/cart_convert_response.rbs +2 -0
  109. data/sig/terminal_shop/models/cart_get_params.rbs +2 -0
  110. data/sig/terminal_shop/models/cart_get_response.rbs +2 -0
  111. data/sig/terminal_shop/models/cart_set_address_params.rbs +5 -0
  112. data/sig/terminal_shop/models/cart_set_address_response.rbs +2 -0
  113. data/sig/terminal_shop/models/cart_set_card_params.rbs +5 -0
  114. data/sig/terminal_shop/models/cart_set_card_response.rbs +2 -0
  115. data/sig/terminal_shop/models/cart_set_item_params.rbs +6 -0
  116. data/sig/terminal_shop/models/cart_set_item_response.rbs +2 -0
  117. data/sig/terminal_shop/models/email_create_params.rbs +5 -0
  118. data/sig/terminal_shop/models/email_create_response.rbs +2 -0
  119. data/sig/terminal_shop/models/order.rbs +46 -6
  120. data/sig/terminal_shop/models/order_create_params.rbs +7 -0
  121. data/sig/terminal_shop/models/order_create_response.rbs +2 -0
  122. data/sig/terminal_shop/models/order_get_params.rbs +2 -0
  123. data/sig/terminal_shop/models/order_get_response.rbs +2 -0
  124. data/sig/terminal_shop/models/order_list_params.rbs +2 -0
  125. data/sig/terminal_shop/models/order_list_response.rbs +2 -0
  126. data/sig/terminal_shop/models/product.rbs +25 -6
  127. data/sig/terminal_shop/models/product_get_params.rbs +2 -0
  128. data/sig/terminal_shop/models/product_get_response.rbs +2 -0
  129. data/sig/terminal_shop/models/product_list_params.rbs +2 -0
  130. data/sig/terminal_shop/models/product_list_response.rbs +2 -0
  131. data/sig/terminal_shop/models/product_variant.rbs +15 -0
  132. data/sig/terminal_shop/models/profile.rbs +10 -0
  133. data/sig/terminal_shop/models/profile_me_params.rbs +2 -0
  134. data/sig/terminal_shop/models/profile_me_response.rbs +2 -0
  135. data/sig/terminal_shop/models/profile_update_params.rbs +6 -0
  136. data/sig/terminal_shop/models/profile_update_response.rbs +2 -0
  137. data/sig/terminal_shop/models/subscription.rbs +22 -6
  138. data/sig/terminal_shop/models/subscription_create_params.rbs +2 -0
  139. data/sig/terminal_shop/models/subscription_create_response.rbs +2 -0
  140. data/sig/terminal_shop/models/subscription_delete_params.rbs +2 -0
  141. data/sig/terminal_shop/models/subscription_delete_response.rbs +2 -0
  142. data/sig/terminal_shop/models/subscription_get_params.rbs +2 -0
  143. data/sig/terminal_shop/models/subscription_get_response.rbs +2 -0
  144. data/sig/terminal_shop/models/subscription_list_params.rbs +2 -0
  145. data/sig/terminal_shop/models/subscription_list_response.rbs +2 -0
  146. data/sig/terminal_shop/models/subscription_update_params.rbs +11 -0
  147. data/sig/terminal_shop/models/subscription_update_response.rbs +2 -0
  148. data/sig/terminal_shop/models/token.rbs +2 -0
  149. data/sig/terminal_shop/models/token_create_params.rbs +2 -0
  150. data/sig/terminal_shop/models/token_create_response.rbs +4 -0
  151. data/sig/terminal_shop/models/token_delete_params.rbs +2 -0
  152. data/sig/terminal_shop/models/token_delete_response.rbs +2 -0
  153. data/sig/terminal_shop/models/token_get_params.rbs +2 -0
  154. data/sig/terminal_shop/models/token_get_response.rbs +2 -0
  155. data/sig/terminal_shop/models/token_list_params.rbs +2 -0
  156. data/sig/terminal_shop/models/token_list_response.rbs +2 -0
  157. data/sig/terminal_shop/models/view_init_params.rbs +2 -0
  158. data/sig/terminal_shop/models/view_init_response.rbs +15 -0
  159. metadata +2 -2
@@ -7,11 +7,11 @@ module TerminalShop
7
7
  # @!attribute data
8
8
  # A Terminal App used for configuring an OAuth 2.0 client.
9
9
  #
10
- # @return [TerminalShop::AppAPI]
10
+ # @return [TerminalShop::Models::AppAPI]
11
11
  required :data, -> { TerminalShop::AppAPI }
12
12
 
13
13
  # @!method initialize(data:)
14
- # @param data [TerminalShop::AppAPI] A Terminal App used for configuring an OAuth 2.0 client.
14
+ # @param data [TerminalShop::Models::AppAPI] A Terminal App used for configuring an OAuth 2.0 client.
15
15
  end
16
16
  end
17
17
  end
@@ -7,11 +7,11 @@ module TerminalShop
7
7
  # @!attribute data
8
8
  # List of apps.
9
9
  #
10
- # @return [Array<TerminalShop::AppAPI>]
10
+ # @return [Array<TerminalShop::Models::AppAPI>]
11
11
  required :data, -> { TerminalShop::Internal::Type::ArrayOf[TerminalShop::AppAPI] }
12
12
 
13
13
  # @!method initialize(data:)
14
- # @param data [Array<TerminalShop::AppAPI>] List of apps.
14
+ # @param data [Array<TerminalShop::Models::AppAPI>] List of apps.
15
15
  end
16
16
  end
17
17
  end
@@ -24,7 +24,7 @@ module TerminalShop
24
24
  # @!attribute expiration
25
25
  # Expiration of the card.
26
26
  #
27
- # @return [TerminalShop::CardAPI::Expiration]
27
+ # @return [TerminalShop::Models::CardAPI::Expiration]
28
28
  required :expiration, -> { TerminalShop::CardAPI::Expiration }
29
29
 
30
30
  # @!attribute last4
@@ -34,8 +34,8 @@ module TerminalShop
34
34
  required :last4, String
35
35
 
36
36
  # @!method initialize(id:, brand:, created:, expiration:, last4:)
37
- # Some parameter documentations has been truncated, see {TerminalShop::CardAPI}
38
- # for more details.
37
+ # Some parameter documentations has been truncated, see
38
+ # {TerminalShop::Models::CardAPI} for more details.
39
39
  #
40
40
  # Credit card used for payments in the Terminal shop.
41
41
  #
@@ -45,11 +45,11 @@ module TerminalShop
45
45
  #
46
46
  # @param created [String] Date the card was created.
47
47
  #
48
- # @param expiration [TerminalShop::CardAPI::Expiration] Expiration of the card.
48
+ # @param expiration [TerminalShop::Models::CardAPI::Expiration] Expiration of the card.
49
49
  #
50
50
  # @param last4 [String] Last four digits of the card.
51
51
 
52
- # @see TerminalShop::CardAPI#expiration
52
+ # @see TerminalShop::Models::CardAPI#expiration
53
53
  class Expiration < TerminalShop::Internal::Type::BaseModel
54
54
  # @!attribute month
55
55
  # Expiration month of the card.
@@ -7,11 +7,11 @@ module TerminalShop
7
7
  # @!attribute data
8
8
  # Credit card used for payments in the Terminal shop.
9
9
  #
10
- # @return [TerminalShop::CardAPI]
10
+ # @return [TerminalShop::Models::CardAPI]
11
11
  required :data, -> { TerminalShop::CardAPI }
12
12
 
13
13
  # @!method initialize(data:)
14
- # @param data [TerminalShop::CardAPI] Credit card used for payments in the Terminal shop.
14
+ # @param data [TerminalShop::Models::CardAPI] Credit card used for payments in the Terminal shop.
15
15
  end
16
16
  end
17
17
  end
@@ -7,11 +7,11 @@ module TerminalShop
7
7
  # @!attribute data
8
8
  # List of cards associated with the user.
9
9
  #
10
- # @return [Array<TerminalShop::CardAPI>]
10
+ # @return [Array<TerminalShop::Models::CardAPI>]
11
11
  required :data, -> { TerminalShop::Internal::Type::ArrayOf[TerminalShop::CardAPI] }
12
12
 
13
13
  # @!method initialize(data:)
14
- # @param data [Array<TerminalShop::CardAPI>] List of cards associated with the user.
14
+ # @param data [Array<TerminalShop::Models::CardAPI>] List of cards associated with the user.
15
15
  end
16
16
  end
17
17
  end
@@ -6,13 +6,13 @@ module TerminalShop
6
6
  # @!attribute amount
7
7
  # The subtotal and shipping amounts for the current user's cart.
8
8
  #
9
- # @return [TerminalShop::CartAPI::Amount]
9
+ # @return [TerminalShop::Models::CartAPI::Amount]
10
10
  required :amount, -> { TerminalShop::CartAPI::Amount }
11
11
 
12
12
  # @!attribute items
13
13
  # An array of items in the current user's cart.
14
14
  #
15
- # @return [Array<TerminalShop::CartAPI::Item>]
15
+ # @return [Array<TerminalShop::Models::CartAPI::Item>]
16
16
  required :items, -> { TerminalShop::Internal::Type::ArrayOf[TerminalShop::CartAPI::Item] }
17
17
 
18
18
  # @!attribute subtotal
@@ -36,15 +36,15 @@ module TerminalShop
36
36
  # @!attribute shipping
37
37
  # Shipping information for the current user's cart.
38
38
  #
39
- # @return [TerminalShop::CartAPI::Shipping, nil]
39
+ # @return [TerminalShop::Models::CartAPI::Shipping, nil]
40
40
  optional :shipping, -> { TerminalShop::CartAPI::Shipping }
41
41
 
42
42
  # @!method initialize(amount:, items:, subtotal:, address_id: nil, card_id: nil, shipping: nil)
43
43
  # The current Terminal shop user's cart.
44
44
  #
45
- # @param amount [TerminalShop::CartAPI::Amount] The subtotal and shipping amounts for the current user's cart.
45
+ # @param amount [TerminalShop::Models::CartAPI::Amount] The subtotal and shipping amounts for the current user's cart.
46
46
  #
47
- # @param items [Array<TerminalShop::CartAPI::Item>] An array of items in the current user's cart.
47
+ # @param items [Array<TerminalShop::Models::CartAPI::Item>] An array of items in the current user's cart.
48
48
  #
49
49
  # @param subtotal [Integer] The subtotal of all items in the current user's cart, in cents (USD).
50
50
  #
@@ -52,9 +52,9 @@ module TerminalShop
52
52
  #
53
53
  # @param card_id [String] ID of the card selected on the current user's cart.
54
54
  #
55
- # @param shipping [TerminalShop::CartAPI::Shipping] Shipping information for the current user's cart.
55
+ # @param shipping [TerminalShop::Models::CartAPI::Shipping] Shipping information for the current user's cart.
56
56
 
57
- # @see TerminalShop::CartAPI#amount
57
+ # @see TerminalShop::Models::CartAPI#amount
58
58
  class Amount < TerminalShop::Internal::Type::BaseModel
59
59
  # @!attribute subtotal
60
60
  # Subtotal of the current user's cart, in cents (USD).
@@ -111,7 +111,7 @@ module TerminalShop
111
111
 
112
112
  # @!method initialize(id:, product_variant_id:, quantity:, subtotal:)
113
113
  # Some parameter documentations has been truncated, see
114
- # {TerminalShop::CartAPI::Item} for more details.
114
+ # {TerminalShop::Models::CartAPI::Item} for more details.
115
115
  #
116
116
  # An item in the current Terminal shop user's cart.
117
117
  #
@@ -124,7 +124,7 @@ module TerminalShop
124
124
  # @param subtotal [Integer] Subtotal of the item in the current user's cart, in cents (USD).
125
125
  end
126
126
 
127
- # @see TerminalShop::CartAPI#shipping
127
+ # @see TerminalShop::Models::CartAPI#shipping
128
128
  class Shipping < TerminalShop::Internal::Type::BaseModel
129
129
  # @!attribute service
130
130
  # Shipping service name.
@@ -7,11 +7,11 @@ module TerminalShop
7
7
  # @!attribute data
8
8
  # An order from the Terminal shop.
9
9
  #
10
- # @return [TerminalShop::OrderAPI]
10
+ # @return [TerminalShop::Models::OrderAPI]
11
11
  required :data, -> { TerminalShop::OrderAPI }
12
12
 
13
13
  # @!method initialize(data:)
14
- # @param data [TerminalShop::OrderAPI] An order from the Terminal shop.
14
+ # @param data [TerminalShop::Models::OrderAPI] An order from the Terminal shop.
15
15
  end
16
16
  end
17
17
  end
@@ -7,11 +7,11 @@ module TerminalShop
7
7
  # @!attribute data
8
8
  # The current Terminal shop user's cart.
9
9
  #
10
- # @return [TerminalShop::CartAPI]
10
+ # @return [TerminalShop::Models::CartAPI]
11
11
  required :data, -> { TerminalShop::CartAPI }
12
12
 
13
13
  # @!method initialize(data:)
14
- # @param data [TerminalShop::CartAPI] The current Terminal shop user's cart.
14
+ # @param data [TerminalShop::Models::CartAPI] The current Terminal shop user's cart.
15
15
  end
16
16
  end
17
17
  end
@@ -7,11 +7,11 @@ module TerminalShop
7
7
  # @!attribute data
8
8
  # The current Terminal shop user's cart.
9
9
  #
10
- # @return [TerminalShop::CartAPI]
10
+ # @return [TerminalShop::Models::CartAPI]
11
11
  required :data, -> { TerminalShop::CartAPI }
12
12
 
13
13
  # @!method initialize(data:)
14
- # @param data [TerminalShop::CartAPI] The current Terminal shop user's cart.
14
+ # @param data [TerminalShop::Models::CartAPI] The current Terminal shop user's cart.
15
15
  end
16
16
  end
17
17
  end
@@ -12,7 +12,7 @@ module TerminalShop
12
12
  # @!attribute amount
13
13
  # The subtotal and shipping amounts of the order.
14
14
  #
15
- # @return [TerminalShop::OrderAPI::Amount]
15
+ # @return [TerminalShop::Models::OrderAPI::Amount]
16
16
  required :amount, -> { TerminalShop::OrderAPI::Amount }
17
17
 
18
18
  # @!attribute created
@@ -24,19 +24,19 @@ module TerminalShop
24
24
  # @!attribute items
25
25
  # Items in the order.
26
26
  #
27
- # @return [Array<TerminalShop::OrderAPI::Item>]
27
+ # @return [Array<TerminalShop::Models::OrderAPI::Item>]
28
28
  required :items, -> { TerminalShop::Internal::Type::ArrayOf[TerminalShop::OrderAPI::Item] }
29
29
 
30
30
  # @!attribute shipping
31
31
  # Shipping address of the order.
32
32
  #
33
- # @return [TerminalShop::OrderAPI::Shipping]
33
+ # @return [TerminalShop::Models::OrderAPI::Shipping]
34
34
  required :shipping, -> { TerminalShop::OrderAPI::Shipping }
35
35
 
36
36
  # @!attribute tracking
37
37
  # Tracking information of the order.
38
38
  #
39
- # @return [TerminalShop::OrderAPI::Tracking]
39
+ # @return [TerminalShop::Models::OrderAPI::Tracking]
40
40
  required :tracking, -> { TerminalShop::OrderAPI::Tracking }
41
41
 
42
42
  # @!attribute index
@@ -46,26 +46,26 @@ module TerminalShop
46
46
  optional :index, Integer
47
47
 
48
48
  # @!method initialize(id:, amount:, created:, items:, shipping:, tracking:, index: nil)
49
- # Some parameter documentations has been truncated, see {TerminalShop::OrderAPI}
50
- # for more details.
49
+ # Some parameter documentations has been truncated, see
50
+ # {TerminalShop::Models::OrderAPI} for more details.
51
51
  #
52
52
  # An order from the Terminal shop.
53
53
  #
54
54
  # @param id [String] Unique object identifier.
55
55
  #
56
- # @param amount [TerminalShop::OrderAPI::Amount] The subtotal and shipping amounts of the order.
56
+ # @param amount [TerminalShop::Models::OrderAPI::Amount] The subtotal and shipping amounts of the order.
57
57
  #
58
58
  # @param created [String] Date the order was created.
59
59
  #
60
- # @param items [Array<TerminalShop::OrderAPI::Item>] Items in the order.
60
+ # @param items [Array<TerminalShop::Models::OrderAPI::Item>] Items in the order.
61
61
  #
62
- # @param shipping [TerminalShop::OrderAPI::Shipping] Shipping address of the order.
62
+ # @param shipping [TerminalShop::Models::OrderAPI::Shipping] Shipping address of the order.
63
63
  #
64
- # @param tracking [TerminalShop::OrderAPI::Tracking] Tracking information of the order.
64
+ # @param tracking [TerminalShop::Models::OrderAPI::Tracking] Tracking information of the order.
65
65
  #
66
66
  # @param index [Integer] Zero-based index of the order for this user only.
67
67
 
68
- # @see TerminalShop::OrderAPI#amount
68
+ # @see TerminalShop::Models::OrderAPI#amount
69
69
  class Amount < TerminalShop::Internal::Type::BaseModel
70
70
  # @!attribute shipping
71
71
  # Shipping amount of the order, in cents (USD).
@@ -120,7 +120,7 @@ module TerminalShop
120
120
 
121
121
  # @!method initialize(id:, amount:, quantity:, description: nil, product_variant_id: nil)
122
122
  # Some parameter documentations has been truncated, see
123
- # {TerminalShop::OrderAPI::Item} for more details.
123
+ # {TerminalShop::Models::OrderAPI::Item} for more details.
124
124
  #
125
125
  # @param id [String] Unique object identifier.
126
126
  #
@@ -133,7 +133,7 @@ module TerminalShop
133
133
  # @param product_variant_id [String] ID of the product variant of the item in the order.
134
134
  end
135
135
 
136
- # @see TerminalShop::OrderAPI#shipping
136
+ # @see TerminalShop::Models::OrderAPI#shipping
137
137
  class Shipping < TerminalShop::Internal::Type::BaseModel
138
138
  # @!attribute city
139
139
  # City of the address.
@@ -203,7 +203,7 @@ module TerminalShop
203
203
  # @param street2 [String] Apartment, suite, etc. of the address.
204
204
  end
205
205
 
206
- # @see TerminalShop::OrderAPI#tracking
206
+ # @see TerminalShop::Models::OrderAPI#tracking
207
207
  class Tracking < TerminalShop::Internal::Type::BaseModel
208
208
  # @!attribute number
209
209
  # Tracking number of the order.
@@ -220,7 +220,7 @@ module TerminalShop
220
220
  # @!attribute status
221
221
  # Current tracking status of the shipment.
222
222
  #
223
- # @return [Symbol, TerminalShop::OrderAPI::Tracking::Status, nil]
223
+ # @return [Symbol, TerminalShop::Models::OrderAPI::Tracking::Status, nil]
224
224
  optional :status, enum: -> { TerminalShop::OrderAPI::Tracking::Status }
225
225
 
226
226
  # @!attribute status_details
@@ -248,7 +248,7 @@ module TerminalShop
248
248
  #
249
249
  # @param service [String] Shipping service of the order.
250
250
  #
251
- # @param status [Symbol, TerminalShop::OrderAPI::Tracking::Status] Current tracking status of the shipment.
251
+ # @param status [Symbol, TerminalShop::Models::OrderAPI::Tracking::Status] Current tracking status of the shipment.
252
252
  #
253
253
  # @param status_details [String] Additional details about the tracking status.
254
254
  #
@@ -258,7 +258,7 @@ module TerminalShop
258
258
 
259
259
  # Current tracking status of the shipment.
260
260
  #
261
- # @see TerminalShop::OrderAPI::Tracking#status
261
+ # @see TerminalShop::Models::OrderAPI::Tracking#status
262
262
  module Status
263
263
  extend TerminalShop::Internal::Type::Enum
264
264
 
@@ -7,11 +7,11 @@ module TerminalShop
7
7
  # @!attribute data
8
8
  # An order from the Terminal shop.
9
9
  #
10
- # @return [TerminalShop::OrderAPI]
10
+ # @return [TerminalShop::Models::OrderAPI]
11
11
  required :data, -> { TerminalShop::OrderAPI }
12
12
 
13
13
  # @!method initialize(data:)
14
- # @param data [TerminalShop::OrderAPI] An order from the Terminal shop.
14
+ # @param data [TerminalShop::Models::OrderAPI] An order from the Terminal shop.
15
15
  end
16
16
  end
17
17
  end
@@ -7,11 +7,11 @@ module TerminalShop
7
7
  # @!attribute data
8
8
  # List of orders.
9
9
  #
10
- # @return [Array<TerminalShop::OrderAPI>]
10
+ # @return [Array<TerminalShop::Models::OrderAPI>]
11
11
  required :data, -> { TerminalShop::Internal::Type::ArrayOf[TerminalShop::OrderAPI] }
12
12
 
13
13
  # @!method initialize(data:)
14
- # @param data [Array<TerminalShop::OrderAPI>] List of orders.
14
+ # @param data [Array<TerminalShop::Models::OrderAPI>] List of orders.
15
15
  end
16
16
  end
17
17
  end
@@ -24,7 +24,7 @@ module TerminalShop
24
24
  # @!attribute variants
25
25
  # List of variants of the product.
26
26
  #
27
- # @return [Array<TerminalShop::ProductVariant>]
27
+ # @return [Array<TerminalShop::Models::ProductVariant>]
28
28
  required :variants, -> { TerminalShop::Internal::Type::ArrayOf[TerminalShop::ProductVariant] }
29
29
 
30
30
  # @!attribute order
@@ -36,18 +36,18 @@ module TerminalShop
36
36
  # @!attribute subscription
37
37
  # Whether the product must be or can be subscribed to.
38
38
  #
39
- # @return [Symbol, TerminalShop::ProductAPI::Subscription, nil]
39
+ # @return [Symbol, TerminalShop::Models::ProductAPI::Subscription, nil]
40
40
  optional :subscription, enum: -> { TerminalShop::ProductAPI::Subscription }
41
41
 
42
42
  # @!attribute tags
43
43
  # Tags for the product.
44
44
  #
45
- # @return [TerminalShop::ProductAPI::Tags, nil]
45
+ # @return [TerminalShop::Models::ProductAPI::Tags, nil]
46
46
  optional :tags, -> { TerminalShop::ProductAPI::Tags }
47
47
 
48
48
  # @!method initialize(id:, description:, name:, variants:, order: nil, subscription: nil, tags: nil)
49
- # Some parameter documentations has been truncated, see {TerminalShop::ProductAPI}
50
- # for more details.
49
+ # Some parameter documentations has been truncated, see
50
+ # {TerminalShop::Models::ProductAPI} for more details.
51
51
  #
52
52
  # Product sold in the Terminal shop.
53
53
  #
@@ -57,17 +57,17 @@ module TerminalShop
57
57
  #
58
58
  # @param name [String] Name of the product.
59
59
  #
60
- # @param variants [Array<TerminalShop::ProductVariant>] List of variants of the product.
60
+ # @param variants [Array<TerminalShop::Models::ProductVariant>] List of variants of the product.
61
61
  #
62
62
  # @param order [Integer] Order of the product used when displaying a sorted list of products.
63
63
  #
64
- # @param subscription [Symbol, TerminalShop::ProductAPI::Subscription] Whether the product must be or can be subscribed to.
64
+ # @param subscription [Symbol, TerminalShop::Models::ProductAPI::Subscription] Whether the product must be or can be subscribed to.
65
65
  #
66
- # @param tags [TerminalShop::ProductAPI::Tags] Tags for the product.
66
+ # @param tags [TerminalShop::Models::ProductAPI::Tags] Tags for the product.
67
67
 
68
68
  # Whether the product must be or can be subscribed to.
69
69
  #
70
- # @see TerminalShop::ProductAPI#subscription
70
+ # @see TerminalShop::Models::ProductAPI#subscription
71
71
  module Subscription
72
72
  extend TerminalShop::Internal::Type::Enum
73
73
 
@@ -78,7 +78,7 @@ module TerminalShop
78
78
  # @return [Array<Symbol>]
79
79
  end
80
80
 
81
- # @see TerminalShop::ProductAPI#tags
81
+ # @see TerminalShop::Models::ProductAPI#tags
82
82
  class Tags < TerminalShop::Internal::Type::BaseModel
83
83
  # @!attribute app
84
84
  #
@@ -7,11 +7,11 @@ module TerminalShop
7
7
  # @!attribute data
8
8
  # Product sold in the Terminal shop.
9
9
  #
10
- # @return [TerminalShop::ProductAPI]
10
+ # @return [TerminalShop::Models::ProductAPI]
11
11
  required :data, -> { TerminalShop::ProductAPI }
12
12
 
13
13
  # @!method initialize(data:)
14
- # @param data [TerminalShop::ProductAPI] Product sold in the Terminal shop.
14
+ # @param data [TerminalShop::Models::ProductAPI] Product sold in the Terminal shop.
15
15
  end
16
16
  end
17
17
  end
@@ -7,11 +7,11 @@ module TerminalShop
7
7
  # @!attribute data
8
8
  # A list of products.
9
9
  #
10
- # @return [Array<TerminalShop::ProductAPI>]
10
+ # @return [Array<TerminalShop::Models::ProductAPI>]
11
11
  required :data, -> { TerminalShop::Internal::Type::ArrayOf[TerminalShop::ProductAPI] }
12
12
 
13
13
  # @!method initialize(data:)
14
- # @param data [Array<TerminalShop::ProductAPI>] A list of products.
14
+ # @param data [Array<TerminalShop::Models::ProductAPI>] A list of products.
15
15
  end
16
16
  end
17
17
  end
@@ -30,12 +30,12 @@ module TerminalShop
30
30
  # @!attribute tags
31
31
  # Tags for the product variant.
32
32
  #
33
- # @return [TerminalShop::ProductVariant::Tags, nil]
33
+ # @return [TerminalShop::Models::ProductVariant::Tags, nil]
34
34
  optional :tags, -> { TerminalShop::ProductVariant::Tags }
35
35
 
36
36
  # @!method initialize(id:, name:, price:, description: nil, tags: nil)
37
37
  # Some parameter documentations has been truncated, see
38
- # {TerminalShop::ProductVariant} for more details.
38
+ # {TerminalShop::Models::ProductVariant} for more details.
39
39
  #
40
40
  # Variant of a product in the Terminal shop.
41
41
  #
@@ -47,9 +47,9 @@ module TerminalShop
47
47
  #
48
48
  # @param description [String] Description of the product variant.
49
49
  #
50
- # @param tags [TerminalShop::ProductVariant::Tags] Tags for the product variant.
50
+ # @param tags [TerminalShop::Models::ProductVariant::Tags] Tags for the product variant.
51
51
 
52
- # @see TerminalShop::ProductVariant#tags
52
+ # @see TerminalShop::Models::ProductVariant#tags
53
53
  class Tags < TerminalShop::Internal::Type::BaseModel
54
54
  # @!attribute app
55
55
  #
@@ -6,15 +6,15 @@ module TerminalShop
6
6
  # @!attribute user
7
7
  # A Terminal shop user. (We have users, btw.)
8
8
  #
9
- # @return [TerminalShop::ProfileAPI::User]
9
+ # @return [TerminalShop::Models::ProfileAPI::User]
10
10
  required :user, -> { TerminalShop::ProfileAPI::User }
11
11
 
12
12
  # @!method initialize(user:)
13
13
  # A Terminal shop user's profile. (We have users, btw.)
14
14
  #
15
- # @param user [TerminalShop::ProfileAPI::User] A Terminal shop user. (We have users, btw.)
15
+ # @param user [TerminalShop::Models::ProfileAPI::User] A Terminal shop user. (We have users, btw.)
16
16
 
17
- # @see TerminalShop::ProfileAPI#user
17
+ # @see TerminalShop::Models::ProfileAPI#user
18
18
  class User < TerminalShop::Internal::Type::BaseModel
19
19
  # @!attribute id
20
20
  # Unique object identifier. The format and length of IDs may change over time.
@@ -48,7 +48,7 @@ module TerminalShop
48
48
 
49
49
  # @!method initialize(id:, email:, fingerprint:, name:, stripe_customer_id:)
50
50
  # Some parameter documentations has been truncated, see
51
- # {TerminalShop::ProfileAPI::User} for more details.
51
+ # {TerminalShop::Models::ProfileAPI::User} for more details.
52
52
  #
53
53
  # A Terminal shop user. (We have users, btw.)
54
54
  #
@@ -7,11 +7,11 @@ module TerminalShop
7
7
  # @!attribute data
8
8
  # A Terminal shop user's profile. (We have users, btw.)
9
9
  #
10
- # @return [TerminalShop::ProfileAPI]
10
+ # @return [TerminalShop::Models::ProfileAPI]
11
11
  required :data, -> { TerminalShop::ProfileAPI }
12
12
 
13
13
  # @!method initialize(data:)
14
- # @param data [TerminalShop::ProfileAPI] A Terminal shop user's profile. (We have users, btw.)
14
+ # @param data [TerminalShop::Models::ProfileAPI] A Terminal shop user's profile. (We have users, btw.)
15
15
  end
16
16
  end
17
17
  end
@@ -7,11 +7,11 @@ module TerminalShop
7
7
  # @!attribute data
8
8
  # A Terminal shop user's profile. (We have users, btw.)
9
9
  #
10
- # @return [TerminalShop::ProfileAPI]
10
+ # @return [TerminalShop::Models::ProfileAPI]
11
11
  required :data, -> { TerminalShop::ProfileAPI }
12
12
 
13
13
  # @!method initialize(data:)
14
- # @param data [TerminalShop::ProfileAPI] A Terminal shop user's profile. (We have users, btw.)
14
+ # @param data [TerminalShop::Models::ProfileAPI] A Terminal shop user's profile. (We have users, btw.)
15
15
  end
16
16
  end
17
17
  end
@@ -54,12 +54,12 @@ module TerminalShop
54
54
  # @!attribute schedule
55
55
  # Schedule of the subscription.
56
56
  #
57
- # @return [TerminalShop::SubscriptionAPI::Schedule::Fixed, TerminalShop::SubscriptionAPI::Schedule::Weekly, nil]
57
+ # @return [TerminalShop::Models::SubscriptionAPI::Schedule::Fixed, TerminalShop::Models::SubscriptionAPI::Schedule::Weekly, nil]
58
58
  optional :schedule, union: -> { TerminalShop::SubscriptionAPI::Schedule }
59
59
 
60
60
  # @!method initialize(id:, address_id:, card_id:, created:, price:, product_variant_id:, quantity:, next_: nil, schedule: nil)
61
61
  # Some parameter documentations has been truncated, see
62
- # {TerminalShop::SubscriptionAPI} for more details.
62
+ # {TerminalShop::Models::SubscriptionAPI} for more details.
63
63
  #
64
64
  # Subscription to a Terminal shop product.
65
65
  #
@@ -79,11 +79,11 @@ module TerminalShop
79
79
  #
80
80
  # @param next_ [String] Next shipment and billing date for the subscription.
81
81
  #
82
- # @param schedule [TerminalShop::SubscriptionAPI::Schedule::Fixed, TerminalShop::SubscriptionAPI::Schedule::Weekly] Schedule of the subscription.
82
+ # @param schedule [TerminalShop::Models::SubscriptionAPI::Schedule::Fixed, TerminalShop::Models::SubscriptionAPI::Schedule::Weekly] Schedule of the subscription.
83
83
 
84
84
  # Schedule of the subscription.
85
85
  #
86
- # @see TerminalShop::SubscriptionAPI#schedule
86
+ # @see TerminalShop::Models::SubscriptionAPI#schedule
87
87
  module Schedule
88
88
  extend TerminalShop::Internal::Type::Union
89
89
 
@@ -118,16 +118,7 @@ module TerminalShop
118
118
  end
119
119
 
120
120
  # @!method self.variants
121
- # @return [Array(TerminalShop::SubscriptionAPI::Schedule::Fixed, TerminalShop::SubscriptionAPI::Schedule::Weekly)]
122
-
123
- define_sorbet_constant!(:Variants) do
124
- T.type_alias do
125
- T.any(
126
- TerminalShop::SubscriptionAPI::Schedule::Fixed,
127
- TerminalShop::SubscriptionAPI::Schedule::Weekly
128
- )
129
- end
130
- end
121
+ # @return [Array(TerminalShop::Models::SubscriptionAPI::Schedule::Fixed, TerminalShop::Models::SubscriptionAPI::Schedule::Weekly)]
131
122
  end
132
123
  end
133
124
  end
@@ -7,11 +7,11 @@ module TerminalShop
7
7
  # @!attribute data
8
8
  # Subscription to a Terminal shop product.
9
9
  #
10
- # @return [TerminalShop::SubscriptionAPI]
10
+ # @return [TerminalShop::Models::SubscriptionAPI]
11
11
  required :data, -> { TerminalShop::SubscriptionAPI }
12
12
 
13
13
  # @!method initialize(data:)
14
- # @param data [TerminalShop::SubscriptionAPI] Subscription to a Terminal shop product.
14
+ # @param data [TerminalShop::Models::SubscriptionAPI] Subscription to a Terminal shop product.
15
15
  end
16
16
  end
17
17
  end
@@ -7,11 +7,11 @@ module TerminalShop
7
7
  # @!attribute data
8
8
  # List of subscriptions.
9
9
  #
10
- # @return [Array<TerminalShop::SubscriptionAPI>]
10
+ # @return [Array<TerminalShop::Models::SubscriptionAPI>]
11
11
  required :data, -> { TerminalShop::Internal::Type::ArrayOf[TerminalShop::SubscriptionAPI] }
12
12
 
13
13
  # @!method initialize(data:)
14
- # @param data [Array<TerminalShop::SubscriptionAPI>] List of subscriptions.
14
+ # @param data [Array<TerminalShop::Models::SubscriptionAPI>] List of subscriptions.
15
15
  end
16
16
  end
17
17
  end
@@ -22,7 +22,7 @@ module TerminalShop
22
22
  # @!attribute schedule
23
23
  # New schedule for the subscription.
24
24
  #
25
- # @return [TerminalShop::SubscriptionUpdateParams::Schedule::Fixed, TerminalShop::SubscriptionUpdateParams::Schedule::Weekly, nil]
25
+ # @return [TerminalShop::Models::SubscriptionUpdateParams::Schedule::Fixed, TerminalShop::Models::SubscriptionUpdateParams::Schedule::Weekly, nil]
26
26
  optional :schedule, union: -> { TerminalShop::SubscriptionUpdateParams::Schedule }
27
27
 
28
28
  # @!method initialize(address_id: nil, card_id: nil, schedule: nil, request_options: {})
@@ -30,7 +30,7 @@ module TerminalShop
30
30
  #
31
31
  # @param card_id [String] New payment method ID for the subscription.
32
32
  #
33
- # @param schedule [TerminalShop::SubscriptionUpdateParams::Schedule::Fixed, TerminalShop::SubscriptionUpdateParams::Schedule::Weekly] New schedule for the subscription.
33
+ # @param schedule [TerminalShop::Models::SubscriptionUpdateParams::Schedule::Fixed, TerminalShop::Models::SubscriptionUpdateParams::Schedule::Weekly] New schedule for the subscription.
34
34
  #
35
35
  # @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}]
36
36
 
@@ -69,16 +69,7 @@ module TerminalShop
69
69
  end
70
70
 
71
71
  # @!method self.variants
72
- # @return [Array(TerminalShop::SubscriptionUpdateParams::Schedule::Fixed, TerminalShop::SubscriptionUpdateParams::Schedule::Weekly)]
73
-
74
- define_sorbet_constant!(:Variants) do
75
- T.type_alias do
76
- T.any(
77
- TerminalShop::SubscriptionUpdateParams::Schedule::Fixed,
78
- TerminalShop::SubscriptionUpdateParams::Schedule::Weekly
79
- )
80
- end
81
- end
72
+ # @return [Array(TerminalShop::Models::SubscriptionUpdateParams::Schedule::Fixed, TerminalShop::Models::SubscriptionUpdateParams::Schedule::Weekly)]
82
73
  end
83
74
  end
84
75
  end