lib/avatax/client/subscriptions.rb in avatax-20.1.0 vs lib/avatax/client/subscriptions.rb in avatax-20.5.0
- old
+ new
@@ -3,59 +3,59 @@
module Subscriptions
# Retrieve a single subscription
#
- # Get the subscription object identified by this URL.
- # A 'subscription' indicates a licensed subscription to a named Avalara service.
- # To request or remove subscriptions, please contact Avalara sales or your customer account manager.
- #
- # ### Security Policies
- #
+ # Get the subscription object identified by this URL.
+ # A 'subscription' indicates a licensed subscription to a named Avalara service.
+ # To request or remove subscriptions, please contact Avalara sales or your customer account manager.
+ #
+ # ### Security Policies
+ #
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
- # @param accountId [Integer] The ID of the account that owns this subscription
- # @param id [Integer] The primary key of this subscription
+ # @param accountId [Integer] The ID of the account that owns this subscription
+ # @param id [Integer] The primary key of this subscription
# @return [Object]
def get_subscription(accountId, id) path = "/api/v2/accounts/#{accountId}/subscriptions/#{id}"
get(path) end
# Retrieve subscriptions for this account
#
- # List all subscription objects attached to this account.
- # A 'subscription' indicates a licensed subscription to a named Avalara service.
- # To request or remove subscriptions, please contact Avalara sales or your customer account manager.
- #
- # Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
- # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
- #
- # ### Security Policies
- #
+ # List all subscription objects attached to this account.
+ # A 'subscription' indicates a licensed subscription to a named Avalara service.
+ # To request or remove subscriptions, please contact Avalara sales or your customer account manager.
+ #
+ # Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
+ # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
+ #
+ # ### Security Policies
+ #
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
- # @param accountId [Integer] The ID of the account that owns these subscriptions
- # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* subscriptionDescription
- # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
+ # @param accountId [Integer] The ID of the account that owns these subscriptions
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* subscriptionDescription
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
# @return [FetchResult]
def list_subscriptions_by_account(accountId, options={}) path = "/api/v2/accounts/#{accountId}/subscriptions"
get(path, options) end
# Retrieve all subscriptions
#
- # Get multiple subscription objects across all accounts.
- # A 'subscription' indicates a licensed subscription to a named Avalara service.
- # To request or remove subscriptions, please contact Avalara sales or your customer account manager.
- #
- # Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
- # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
- #
- # ### Security Policies
- #
+ # Get multiple subscription objects across all accounts.
+ # A 'subscription' indicates a licensed subscription to a named Avalara service.
+ # To request or remove subscriptions, please contact Avalara sales or your customer account manager.
+ #
+ # Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
+ # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
+ #
+ # ### Security Policies
+ #
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
- # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* subscriptionDescription
- # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* subscriptionDescription
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
# @return [FetchResult]
def query_subscriptions(options={}) path = "/api/v2/subscriptions"
get(path, options) end
end
end
\ No newline at end of file