recurly 3.0.0.beta.4 → 3.0.0.beta.5

data/lib/recurly/errors.rb

@@ -12,7 +12,7 @@ module Recurly
       # @param error_key [String]
       # @return [Errors::APIError,Errors::NetworkError]
       def self.error_class(error_key)
-        class_name = error_key.split('_').map(&:capitalize).join
+        class_name = error_key.split("_").map(&:capitalize).join
         class_name += "Error" unless class_name.end_with?("Error")
         Errors.const_get(class_name)
       end

data/lib/recurly/pager.rb

@@ -72,11 +72,11 @@ module Recurly
     private
 
     def from_json(data)
-      @data = data['data'].map do |resource_data|
+      @data = data["data"].map do |resource_data|
         JSONParser.from_json(resource_data)
       end
-      @next = data['next']
-      @has_more = data['has_more']
+      @next = data["next"]
+      @has_more = data["has_more"]
     end
 
     def item_enumerator

data/lib/recurly/requests/account_acquisition_updatable.rb

@@ -12,7 +12,7 @@ module Recurly
 
       # @!attribute channel
       #   @return [String] The channel through which the account was acquired.
-      define_attribute :channel, String, { :enum => ["referral", "social_media", "email", "paid_search", "organic_search", "direct_traffic", "marketing_content", "blog", "events", "outbound_sales", "advertising", "public_relations", "other"] }
+      define_attribute :channel, String
 
       # @!attribute cost
       #   @return [Hash] Account balance

data/lib/recurly/requests/account_create.rb

@@ -16,7 +16,7 @@ module Recurly
 
       # @!attribute bill_to
       #   @return [String] An enumerable describing the billing behavior of the account, specifically whether the account is self-paying or will rely on the parent account to pay.
-      define_attribute :bill_to, String, { :enum => ["self", "parent"] }
+      define_attribute :bill_to, String
 
       # @!attribute billing_info
       #   @return [BillingInfoCreate]
@@ -64,7 +64,7 @@ module Recurly
 
       # @!attribute preferred_locale
       #   @return [String] Used to determine the language and locale of emails sent on behalf of the merchant to the customer. The list of locales is restricted to those the merchant has enabled on the site.
-      define_attribute :preferred_locale, String, { :enum => ["da-DK", "de-CH", "de-DE", "en-AU", "en-CA", "en-GB", "en-NZ", "en-US", "es-ES", "es-MX", "es-US", "fr-CA", "fr-FR", "hi-IN", "ja-JP", "nl-BE", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "tr-TR", "zh-CN"] }
+      define_attribute :preferred_locale, String
 
       # @!attribute shipping_addresses
       #   @return [Array[ShippingAddressCreate]]

data/lib/recurly/requests/account_purchase.rb

@@ -0,0 +1,86 @@
+# This file is automatically created by Recurly's OpenAPI generation process
+# and thus any edits you make by hand will be lost. If you wish to make a
+# change to this file, please create a Github issue explaining the changes you
+# need and we will usher them to the appropriate places.
+module Recurly
+  module Requests
+    class AccountPurchase < Request
+
+      # @!attribute acquisition
+      #   @return [AccountAcquisitionUpdatable]
+      define_attribute :acquisition, :AccountAcquisitionUpdatable
+
+      # @!attribute address
+      #   @return [Address]
+      define_attribute :address, :Address
+
+      # @!attribute bill_to
+      #   @return [String] An enumerable describing the billing behavior of the account, specifically whether the account is self-paying or will rely on the parent account to pay.
+      define_attribute :bill_to, String
+
+      # @!attribute billing_info
+      #   @return [BillingInfoCreate]
+      define_attribute :billing_info, :BillingInfoCreate
+
+      # @!attribute cc_emails
+      #   @return [String] Additional email address that should receive account correspondence. These should be separated only by commas. These CC emails will receive all emails that the `email` field also receives.
+      define_attribute :cc_emails, String
+
+      # @!attribute code
+      #   @return [String] The unique identifier of the account. This cannot be changed once the account is created.
+      define_attribute :code, String
+
+      # @!attribute company
+      #   @return [String]
+      define_attribute :company, String
+
+      # @!attribute custom_fields
+      #   @return [Array[CustomField]]
+      define_attribute :custom_fields, Array, { :item_type => :CustomField }
+
+      # @!attribute email
+      #   @return [String] The email address used for communicating with this customer. The customer will also use this email address to log into your hosted account management pages. This value does not need to be unique.
+      define_attribute :email, String
+
+      # @!attribute exemption_certificate
+      #   @return [String] The tax exemption certificate number for the account. If the merchant has an integration for the Vertex tax provider, this optional value will be sent in any tax calculation requests for the account.
+      define_attribute :exemption_certificate, String
+
+      # @!attribute first_name
+      #   @return [String]
+      define_attribute :first_name, String
+
+      # @!attribute id
+      #   @return [String] Optional, but if present allows an existing account to be used and updated as part of the purchase.
+      define_attribute :id, String
+
+      # @!attribute last_name
+      #   @return [String]
+      define_attribute :last_name, String
+
+      # @!attribute parent_account_code
+      #   @return [String] The account code of the parent account to be associated with this account. Passing an empty value removes any existing parent association from this account. If both `parent_account_code` and `parent_account_id` are passed, the non-blank value in `parent_account_id` will be used. Only one level of parent child relationship is allowed. You cannot assign a parent account that itself has a parent account.
+      define_attribute :parent_account_code, String
+
+      # @!attribute parent_account_id
+      #   @return [String] The UUID of the parent account to be associated with this account. Passing an empty value removes any existing parent association from this account. If both `parent_account_code` and `parent_account_id` are passed, the non-blank value in `parent_account_id` will be used. Only one level of parent child relationship is allowed. You cannot assign a parent account that itself has a parent account.
+      define_attribute :parent_account_id, String
+
+      # @!attribute preferred_locale
+      #   @return [String] Used to determine the language and locale of emails sent on behalf of the merchant to the customer. The list of locales is restricted to those the merchant has enabled on the site.
+      define_attribute :preferred_locale, String
+
+      # @!attribute tax_exempt
+      #   @return [Boolean] The tax status of the account. `true` exempts tax on the account, `false` applies tax on the account.
+      define_attribute :tax_exempt, :Boolean
+
+      # @!attribute username
+      #   @return [String] A secondary value for the account.
+      define_attribute :username, String
+
+      # @!attribute vat_number
+      #   @return [String] The VAT number of the account (to avoid having the VAT applied). This is only used for manually collected invoices.
+      define_attribute :vat_number, String
+    end
+  end
+end

data/lib/recurly/requests/account_update.rb

@@ -12,7 +12,7 @@ module Recurly
 
       # @!attribute bill_to
       #   @return [String] An enumerable describing the billing behavior of the account, specifically whether the account is self-paying or will rely on the parent account to pay.
-      define_attribute :bill_to, String, { :enum => ["self", "parent"] }
+      define_attribute :bill_to, String
 
       # @!attribute billing_info
       #   @return [BillingInfoCreate]
@@ -56,7 +56,7 @@ module Recurly
 
       # @!attribute preferred_locale
       #   @return [String] Used to determine the language and locale of emails sent on behalf of the merchant to the customer. The list of locales is restricted to those the merchant has enabled on the site.
-      define_attribute :preferred_locale, String, { :enum => ["da-DK", "de-CH", "de-DE", "en-AU", "en-CA", "en-GB", "en-NZ", "en-US", "es-ES", "es-MX", "es-US", "fr-CA", "fr-FR", "hi-IN", "ja-JP", "nl-BE", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "tr-TR", "zh-CN"] }
+      define_attribute :preferred_locale, String
 
       # @!attribute tax_exempt
       #   @return [Boolean] The tax status of the account. `true` exempts tax on the account, `false` applies tax on the account.

data/lib/recurly/requests/add_on_create.rb

@@ -30,12 +30,12 @@ module Recurly
       #   @return [String] Describes your add-on and will appear in subscribers' invoices.
       define_attribute :name, String
 
-      # @!attribute [r] plan_id
+      # @!attribute plan_id
       #   @return [String] Plan ID
-      define_attribute :plan_id, String, { :read_only => true }
+      define_attribute :plan_id, String
 
       # @!attribute tax_code
-      #   @return [String] Optional field for EU VAT merchants and Avalara AvaTax Pro merchants. If you are using Recurly's EU VAT feature, you can use values of 'unknown', 'physical', or 'digital'. If you have your own AvaTax account configured, you can use Avalara tax codes to assign custom tax rules.
+      #   @return [String] Optional field used by Avalara, Vertex, and Recurly's EU VAT tax feature to determine taxation rules. If you have your own AvaTax or Vertex account configured, use their tax codes to assign specific tax rules. If you are using Recurly's EU VAT feature, you can use values of `unknown`, `physical`, or `digital`.
       define_attribute :tax_code, String
     end
   end

data/lib/recurly/requests/add_on_update.rb

@@ -26,16 +26,16 @@ module Recurly
       #   @return [Boolean] Determines if the quantity field is displayed on the hosted pages for the add-on.
       define_attribute :display_quantity, :Boolean
 
-      # @!attribute [r] id
+      # @!attribute id
       #   @return [String] Add-on ID
-      define_attribute :id, String, { :read_only => true }
+      define_attribute :id, String
 
       # @!attribute name
       #   @return [String] Describes your add-on and will appear in subscribers' invoices.
       define_attribute :name, String
 
       # @!attribute tax_code
-      #   @return [String] Optional field for EU VAT merchants and Avalara AvaTax Pro merchants. If you are using Recurly's EU VAT feature, you can use values of 'unknown', 'physical', or 'digital'. If you have your own AvaTax account configured, you can use Avalara tax codes to assign custom tax rules.
+      #   @return [String] Optional field used by Avalara, Vertex, and Recurly's EU VAT tax feature to determine taxation rules. If you have your own AvaTax or Vertex account configured, use their tax codes to assign specific tax rules. If you are using Recurly's EU VAT feature, you can use values of `unknown`, `physical`, or `digital`.
       define_attribute :tax_code, String
     end
   end

data/lib/recurly/requests/coupon_create.rb

@@ -20,7 +20,7 @@ module Recurly
 
       # @!attribute coupon_type
       #   @return [String] Whether the coupon is "single_code" or "bulk". Bulk coupons will require a `unique_code_template` and will generate unique codes through the `/generate` endpoint.
-      define_attribute :coupon_type, String, { :enum => ["single_code", "bulk"] }
+      define_attribute :coupon_type, String
 
       # @!attribute currencies
       #   @return [Array[CouponPricing]] Fixed discount currencies by currency. Required if the coupon type is `fixed`. This parameter should contain the coupon discount values
@@ -32,11 +32,11 @@ module Recurly
 
       # @!attribute discount_type
       #   @return [String] The type of discount provided by the coupon (how the amount discounted is calculated)
-      define_attribute :discount_type, String, { :enum => ["percent", "fixed", "free_trial"] }
+      define_attribute :discount_type, String
 
       # @!attribute duration
       #   @return [String] This field does not apply when the discount_type is `free_trial`. - "single_use" coupons applies to the first invoice only. - "temporal" coupons will apply to invoices for the duration determined by the `temporal_unit` and `temporal_amount` attributes. - "forever" coupons will apply to invoices forever.
-      define_attribute :duration, String, { :enum => ["forever", "single_use", "temporal"] }
+      define_attribute :duration, String
 
       # @!attribute free_trial_amount
       #   @return [Integer] Sets the duration of time the `free_trial_unit` is for. Required if `discount_type` is `free_trial`.
@@ -44,7 +44,7 @@ module Recurly
 
       # @!attribute free_trial_unit
       #   @return [String] Description of the unit of time the coupon is for. Used with `free_trial_amount` to determine the duration of time the coupon is for.  Required if `discount_type` is `free_trial`.
-      define_attribute :free_trial_unit, String, { :enum => ["day", "week", "month"] }
+      define_attribute :free_trial_unit, String
 
       # @!attribute hosted_description
       #   @return [String] This description will show up when a customer redeems a coupon on your Hosted Payment Pages, or if you choose to show the description on your own checkout page.
@@ -76,7 +76,7 @@ module Recurly
 
       # @!attribute redemption_resource
       #   @return [String] Whether the discount is for all eligible charges on the account, or only a specific subscription.
-      define_attribute :redemption_resource, String, { :enum => ["account", "subscription"] }
+      define_attribute :redemption_resource, String
 
       # @!attribute temporal_amount
       #   @return [Integer] If `duration` is "temporal" than `temporal_amount` is an integer which is multiplied by `temporal_unit` to define the duration that the coupon will be applied to invoices for.
@@ -84,7 +84,7 @@ module Recurly
 
       # @!attribute temporal_unit
       #   @return [String] If `duration` is "temporal" than `temporal_unit` is multiplied by `temporal_amount` to define the duration that the coupon will be applied to invoices for.
-      define_attribute :temporal_unit, String, { :enum => ["day", "week", "month", "year"] }
+      define_attribute :temporal_unit, String
 
       # @!attribute unique_code_template
       #   @return [String] On a bulk coupon, the template from which unique coupon codes are generated. - You must start the template with your coupon_code wrapped in single quotes. - Outside of single quotes, use a 9 for a character that you want to be a random number. - Outside of single quotes, use an "x" for a character that you want to be a random letter. - Outside of single quotes, use an * for a character that you want to be a random number or letter. - Use single quotes ' ' for characters that you want to remain static. These strings can be alphanumeric and may contain a - _ or +. For example: "'abc-'****'-def'"

data/lib/recurly/requests/external_refund.rb

@@ -12,7 +12,7 @@ module Recurly
 
       # @!attribute payment_method
       #   @return [String] Payment method used for external refund transaction.
-      define_attribute :payment_method, String, { :enum => ["credit_card", "paypal", "amazon", "roku", "ach", "apple_pay", "sepadirectdebit", "eft", "wire_transfer", "money_order", "check", "other"] }
+      define_attribute :payment_method, String
 
       # @!attribute refunded_at
       #   @return [DateTime] Date the external refund payment was made. Defaults to the current date-time.

data/lib/recurly/requests/invoice_create.rb

@@ -12,7 +12,7 @@ module Recurly
 
       # @!attribute collection_method
       #   @return [String] An automatic invoice means a corresponding transaction is run using the account's billing information at the same time the invoice is created. Manual invoices are created without a corresponding transaction. The merchant must enter a manual payment transaction or have the customer pay the invoice with an automatic method, like credit card, PayPal, Amazon, or ACH bank payment.
-      define_attribute :collection_method, String, { :enum => ["automatic", "manual"] }
+      define_attribute :collection_method, String
 
       # @!attribute credit_customer_notes
       #   @return [String] This will default to the Customer Notes text specified on the Invoice Settings for credit invoices. Specify customer notes to add or override Customer Notes on credit invoices.
@@ -36,7 +36,7 @@ module Recurly
 
       # @!attribute type
       #   @return [String] Specify a type to limit the type of line items that will be invoiced.
-      define_attribute :type, String, { :enum => ["charge", "credit"] }
+      define_attribute :type, String
 
       # @!attribute vat_reverse_charge_notes
       #   @return [String] VAT Reverse Charge Notes only appear if you have EU VAT enabled or are using your own Avalara AvaTax account and the customer is in the EU, has a VAT number, and is in a different country than your own. This will default to the VAT Reverse Charge Notes text specified on the Tax Settings page in your Recurly admin, unless custom notes were created with the original subscription.

data/lib/recurly/requests/invoice_refund.rb

@@ -24,11 +24,11 @@ module Recurly
 
       # @!attribute refund_method
       #   @return [String] Indicates how the invoice should be refunded when both a credit and transaction are present on the invoice: - `transaction_first` – Refunds the transaction first, then any amount is issued as credit back to the account. Default value when Credit Invoices feature is enabled. - `credit_first` – Issues credit back to the account first, then refunds any remaining amount back to the transaction. Default value when Credit Invoices feature is not enabled. - `all_credit` – Issues credit to the account for the entire amount of the refund. Only available when the Credit Invoices feature is enabled. - `all_transaction` – Refunds the entire amount back to transactions, using transactions from previous invoices if necessary. Only available when the Credit Invoices feature is enabled.
-      define_attribute :refund_method, String, { :enum => ["transaction_first", "credit_first", "all_credit", "all_transaction"] }
+      define_attribute :refund_method, String
 
       # @!attribute type
       #   @return [String] The type of refund. Amount and line items cannot both be specified in the request.
-      define_attribute :type, String, { :enum => ["amount", "line_items"] }
+      define_attribute :type, String
     end
   end
 end

data/lib/recurly/requests/line_item_create.rb

@@ -8,7 +8,7 @@ module Recurly
 
       # @!attribute credit_reason_code
       #   @return [String] The reason the credit was given when line item is `type=credit`. When the Credit Invoices feature is enabled, the value can be set and will default to `general`. When the Credit Invoices feature is not enabled, the value will always be `null`.
-      define_attribute :credit_reason_code, String, { :enum => ["general", "service", "promotional"] }
+      define_attribute :credit_reason_code, String
 
       # @!attribute currency
       #   @return [String] 3-letter ISO 4217 currency code.
@@ -31,7 +31,7 @@ module Recurly
       define_attribute :start_date, DateTime
 
       # @!attribute tax_code
-      #   @return [String] Optional field for EU VAT merchants and Avalara AvaTax Pro merchants. If you are using Recurly's EU VAT feature, you can use values of unknown, physical, or digital. If you have your own AvaTax account configured, you can use Avalara tax codes to assign custom tax rules.
+      #   @return [String] Optional field used by Avalara, Vertex, and Recurly's EU VAT tax feature to determine taxation rules. If you have your own AvaTax or Vertex account configured, use their tax codes to assign specific tax rules. If you are using Recurly's EU VAT feature, you can use values of `unknown`, `physical`, or `digital`.
       define_attribute :tax_code, String
 
       # @!attribute tax_exempt
@@ -40,7 +40,7 @@ module Recurly
 
       # @!attribute type
       #   @return [String] Line item type.
-      define_attribute :type, String, { :enum => ["charge", "credit"] }
+      define_attribute :type, String
 
       # @!attribute unit_amount
       #   @return [Float] A positive or negative amount with `type=charge` will result in a positive `unit_amount`. A positive or negative amount with `type=credit` will result in a negative `unit_amount`.

data/lib/recurly/requests/plan_create.rb

@@ -40,7 +40,7 @@ module Recurly
 
       # @!attribute interval_unit
       #   @return [String] Unit for the plan's billing interval.
-      define_attribute :interval_unit, String, { :enum => ["days", "months"] }
+      define_attribute :interval_unit, String
 
       # @!attribute name
       #   @return [String] This name describes your plan and will appear on the Hosted Payment Page and the subscriber's invoice.
@@ -51,7 +51,7 @@ module Recurly
       define_attribute :setup_fee_accounting_code, String
 
       # @!attribute tax_code
-      #   @return [String] Optional field for EU VAT merchants and Avalara AvaTax Pro merchants. If you are using Recurly's EU VAT feature, you can use values of 'unknown', 'physical', or 'digital'. If you have your own AvaTax account configured, you can use Avalara tax codes to assign custom tax rules.
+      #   @return [String] Optional field used by Avalara, Vertex, and Recurly's EU VAT tax feature to determine taxation rules. If you have your own AvaTax or Vertex account configured, use their tax codes to assign specific tax rules. If you are using Recurly's EU VAT feature, you can use values of `unknown`, `physical`, or `digital`.
       define_attribute :tax_code, String
 
       # @!attribute tax_exempt
@@ -68,7 +68,7 @@ module Recurly
 
       # @!attribute trial_unit
       #   @return [String] Units for the plan's trial period.
-      define_attribute :trial_unit, String, { :enum => ["days", "months"] }
+      define_attribute :trial_unit, String
     end
   end
 end

data/lib/recurly/requests/plan_update.rb

@@ -34,9 +34,9 @@ module Recurly
       #   @return [PlanHostedPages] Hosted pages settings
       define_attribute :hosted_pages, :PlanHostedPages
 
-      # @!attribute [r] id
+      # @!attribute id
       #   @return [String] Plan ID
-      define_attribute :id, String, { :read_only => true }
+      define_attribute :id, String
 
       # @!attribute name
       #   @return [String] This name describes your plan and will appear on the Hosted Payment Page and the subscriber's invoice.
@@ -47,7 +47,7 @@ module Recurly
       define_attribute :setup_fee_accounting_code, String
 
       # @!attribute tax_code
-      #   @return [String] Optional field for EU VAT merchants and Avalara AvaTax Pro merchants. If you are using Recurly's EU VAT feature, you can use values of 'unknown', 'physical', or 'digital'. If you have your own AvaTax account configured, you can use Avalara tax codes to assign custom tax rules.
+      #   @return [String] Optional field used by Avalara, Vertex, and Recurly's EU VAT tax feature to determine taxation rules. If you have your own AvaTax or Vertex account configured, use their tax codes to assign specific tax rules. If you are using Recurly's EU VAT feature, you can use values of `unknown`, `physical`, or `digital`.
       define_attribute :tax_code, String
 
       # @!attribute tax_exempt
@@ -64,7 +64,7 @@ module Recurly
 
       # @!attribute trial_unit
       #   @return [String] Units for the plan's trial period.
-      define_attribute :trial_unit, String, { :enum => ["days", "months"] }
+      define_attribute :trial_unit, String
     end
   end
 end

data/lib/recurly/requests/purchase_create.rb

@@ -0,0 +1,74 @@
+# This file is automatically created by Recurly's OpenAPI generation process
+# and thus any edits you make by hand will be lost. If you wish to make a
+# change to this file, please create a Github issue explaining the changes you
+# need and we will usher them to the appropriate places.
+module Recurly
+  module Requests
+    class PurchaseCreate < Request
+
+      # @!attribute account
+      #   @return [AccountPurchase]
+      define_attribute :account, :AccountPurchase
+
+      # @!attribute collection_method
+      #   @return [String] Collection method
+      define_attribute :collection_method, String
+
+      # @!attribute coupon_codes
+      #   @return [Array[String]] A list of coupon_codes to be redeemed on the subscription or account during the purchase.
+      define_attribute :coupon_codes, Array, { :item_type => String }
+
+      # @!attribute credit_customer_notes
+      #   @return [String] Notes to be put on the credit invoice resulting from credits in the purchase, if any.
+      define_attribute :credit_customer_notes, String
+
+      # @!attribute currency
+      #   @return [String] 3-letter ISO 4217 currency code.
+      define_attribute :currency, String
+
+      # @!attribute customer_notes
+      #   @return [String] Customer notes
+      define_attribute :customer_notes, String
+
+      # @!attribute gateway_code
+      #   @return [String] The default payment gateway identifier to be used for the purchase transaction.  This will also be applied as the default for any subscriptions included in the purchase request.
+      define_attribute :gateway_code, String
+
+      # @!attribute gift_card_redemption_code
+      #   @return [String] A gift card redemption code to be redeemed on the purchase invoice.
+      define_attribute :gift_card_redemption_code, String
+
+      # @!attribute line_items
+      #   @return [Array[LineItemCreate]] A list of one time charges or credits to be created with the purchase.
+      define_attribute :line_items, Array, { :item_type => :LineItemCreate }
+
+      # @!attribute net_terms
+      #   @return [Integer] Integer representing the number of days after an invoice's creation that the invoice will become past due. If an invoice's net terms are set to '0', it is due 'On Receipt' and will become past due 24 hours after it’s created. If an invoice is due net 30, it will become past due at 31 days exactly.
+      define_attribute :net_terms, Integer
+
+      # @!attribute po_number
+      #   @return [String] For manual invoicing, this identifies the PO number associated with the subscription.
+      define_attribute :po_number, String
+
+      # @!attribute shipping_address
+      #   @return [ShippingAddressCreate]
+      define_attribute :shipping_address, :ShippingAddressCreate
+
+      # @!attribute shipping_address_id
+      #   @return [String] Assign a shipping address from the account's existing shipping addresses. If this and `shipping_address` are both present, `shipping_address` will take precedence.
+      define_attribute :shipping_address_id, String
+
+      # @!attribute subscriptions
+      #   @return [Array[SubscriptionPurchase]] A list of subscriptions to be created with the purchase.
+      define_attribute :subscriptions, Array, { :item_type => :SubscriptionPurchase }
+
+      # @!attribute terms_and_conditions
+      #   @return [String] Terms and conditions to be put on the purchase invoice.
+      define_attribute :terms_and_conditions, String
+
+      # @!attribute vat_reverse_charge_notes
+      #   @return [String] VAT reverse charge notes for cross border European tax settlement.
+      define_attribute :vat_reverse_charge_notes, String
+    end
+  end
+end

data/lib/recurly/requests/shipping_address_update.rb

@@ -26,9 +26,9 @@ module Recurly
       #   @return [String]
       define_attribute :first_name, String
 
-      # @!attribute [r] id
+      # @!attribute id
       #   @return [String] Shipping Address ID
-      define_attribute :id, String, { :read_only => true }
+      define_attribute :id, String
 
       # @!attribute last_name
       #   @return [String]