ultracart_api 4.1.230 → 4.1.231

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 (37) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +19 -2
  3. data/docs/ItemAutoOrder.md +1 -1
  4. data/docs/SfvbApi.md +287 -0
  5. data/docs/SfvbApprovalCreateRequest.md +3 -1
  6. data/docs/SfvbCampaign.md +2 -0
  7. data/docs/SfvbCommsMember.md +22 -0
  8. data/docs/SfvbCommsMembersResponse.md +36 -0
  9. data/docs/SfvbFlow.md +2 -0
  10. data/docs/SfvbPostcardAddress.md +28 -0
  11. data/docs/SfvbPostcardCard.md +40 -0
  12. data/docs/SfvbPostcardTrackingResponse.md +34 -0
  13. data/docs/SfvbTransactionalChange.md +24 -0
  14. data/docs/SfvbTransactionalDeliveryOption.md +22 -0
  15. data/docs/SfvbTransactionalEmailDetail.md +30 -0
  16. data/docs/SfvbTransactionalEmailResponse.md +24 -0
  17. data/docs/SfvbTransactionalEmailUpdateRequest.md +28 -0
  18. data/docs/SfvbTransactionalSender.md +24 -0
  19. data/lib/ultracart_api/api/sfvb_api.rb +398 -0
  20. data/lib/ultracart_api/models/item_auto_order.rb +1 -1
  21. data/lib/ultracart_api/models/sfvb_approval_create_request.rb +15 -6
  22. data/lib/ultracart_api/models/sfvb_campaign.rb +11 -1
  23. data/lib/ultracart_api/models/sfvb_comms_member.rb +240 -0
  24. data/lib/ultracart_api/models/sfvb_comms_members_response.rb +314 -0
  25. data/lib/ultracart_api/models/sfvb_flow.rb +11 -1
  26. data/lib/ultracart_api/models/sfvb_postcard_address.rb +270 -0
  27. data/lib/ultracart_api/models/sfvb_postcard_card.rb +328 -0
  28. data/lib/ultracart_api/models/sfvb_postcard_tracking_response.rb +304 -0
  29. data/lib/ultracart_api/models/sfvb_transactional_change.rb +250 -0
  30. data/lib/ultracart_api/models/sfvb_transactional_delivery_option.rb +240 -0
  31. data/lib/ultracart_api/models/sfvb_transactional_email_detail.rb +283 -0
  32. data/lib/ultracart_api/models/sfvb_transactional_email_response.rb +253 -0
  33. data/lib/ultracart_api/models/sfvb_transactional_email_update_request.rb +272 -0
  34. data/lib/ultracart_api/models/sfvb_transactional_sender.rb +250 -0
  35. data/lib/ultracart_api/version.rb +1 -1
  36. data/lib/ultracart_api.rb +11 -0
  37. metadata +23 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 8f9e8c96d40d233f7b4de128adb8b7ad1dcb6fa3e759cf34386c5b5dca84f14f
4
- data.tar.gz: 84aedc789f08af3d4b05854443ba583ac6735c261f1732c1c08aa778d32ae50d
3
+ metadata.gz: dcde7cba5dd0621691aa5391f6f7c46b5792172018f897da1898a6ee63735015
4
+ data.tar.gz: 429ce3d4d320b966d2e9c9ee1d8c4d04d315725f114dc2c44b2be6836bead467
5
5
  SHA512:
6
- metadata.gz: a9148b9834b2edfe1461224ac073fad73ead2aa41292e502768f123c86a1927414273c1ff524553a584d9ab30d841ca52d842bc7322e538943d264ee6db4f540
7
- data.tar.gz: d0bbeb2f7b483c0bcdbcbd54e676c4d3481fa455be87d683a170c0703e2b298c650fc59431c93af5f3ed117d5af8ab563969b252a1887067eb7436411967aef3
6
+ metadata.gz: 4e9df0afbc6550dabf30a517188337cab264b610f5a511bb22d6bab935db4df2f8afb685f8a0e4677f366c5def6873a58aee80a43f90bae52714b0bd863e4822
7
+ data.tar.gz: '06085c5c64588823122b2453d1676900455b0f3d2993cb92de7b50c1a3a036356172f3c696362ac8041f8b2ac19c6991fec4e4d4fa0bf84e140679a4c53a1229'
data/README.md CHANGED
@@ -7,7 +7,7 @@ Note: Every method has a sample for every language. See https://github.com/Ultr
7
7
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
8
8
 
9
9
  - API version: 2.0.0
10
- - Package version: 4.1.230
10
+ - Package version: 4.1.231
11
11
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
12
12
  - For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
13
13
 
@@ -16,7 +16,7 @@ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-g
16
16
  gemfile:
17
17
 
18
18
  ```shell
19
- gem 'ultracart_api', '4.1.230'
19
+ gem 'ultracart_api', '4.1.231'
20
20
  ```
21
21
 
22
22
  install:
@@ -545,7 +545,9 @@ Class | Method | HTTP request | Description
545
545
  *UltracartClient::SfvbApi* | [**get_sfvb_comms_folder**](docs/SfvbApi.md#get_sfvb_comms_folder) | **GET** /sfvb/storefronts/{storefront_oid}/list_segment_folders/{folder_uuid} | Read one list and segment folder
546
546
  *UltracartClient::SfvbApi* | [**get_sfvb_comms_folders**](docs/SfvbApi.md#get_sfvb_comms_folders) | **GET** /sfvb/storefronts/{storefront_oid}/list_segment_folders | List the list and segment folders
547
547
  *UltracartClient::SfvbApi* | [**get_sfvb_comms_list**](docs/SfvbApi.md#get_sfvb_comms_list) | **GET** /sfvb/storefronts/{storefront_oid}/lists/{list_uuid} | Read one email list
548
+ *UltracartClient::SfvbApi* | [**get_sfvb_comms_list_members**](docs/SfvbApi.md#get_sfvb_comms_list_members) | **GET** /sfvb/storefronts/{storefront_oid}/lists/{list_uuid}/members | Read one page of a list's members
548
549
  *UltracartClient::SfvbApi* | [**get_sfvb_comms_segment**](docs/SfvbApi.md#get_sfvb_comms_segment) | **GET** /sfvb/storefronts/{storefront_oid}/segments/{segment_uuid} | Read one segment, with its rule
550
+ *UltracartClient::SfvbApi* | [**get_sfvb_comms_segment_members**](docs/SfvbApi.md#get_sfvb_comms_segment_members) | **GET** /sfvb/storefronts/{storefront_oid}/segments/{segment_uuid}/members | Read one page of a segment's members
549
551
  *UltracartClient::SfvbApi* | [**get_sfvb_comms_sending_domain**](docs/SfvbApi.md#get_sfvb_comms_sending_domain) | **GET** /sfvb/comms/sending_domains/{domain} | Read a sending domain
550
552
  *UltracartClient::SfvbApi* | [**get_sfvb_comms_sending_domains**](docs/SfvbApi.md#get_sfvb_comms_sending_domains) | **GET** /sfvb/comms/sending_domains | List the sending domains
551
553
  *UltracartClient::SfvbApi* | [**get_sfvb_comms_twilio_account**](docs/SfvbApi.md#get_sfvb_comms_twilio_account) | **GET** /sfvb/comms/twilio_account | Read the Twilio account
@@ -582,6 +584,7 @@ Class | Method | HTTP request | Description
582
584
  *UltracartClient::SfvbApi* | [**get_sfvb_page_blog_posts**](docs/SfvbApi.md#get_sfvb_page_blog_posts) | **GET** /sfvb/storefronts/{storefront_oid}/pages/blog_posts | Read the blog posts assigned to a page
583
585
  *UltracartClient::SfvbApi* | [**get_sfvb_page_items**](docs/SfvbApi.md#get_sfvb_page_items) | **GET** /sfvb/storefronts/{storefront_oid}/pages/items | Read the items assigned to a page
584
586
  *UltracartClient::SfvbApi* | [**get_sfvb_page_selectors**](docs/SfvbApi.md#get_sfvb_page_selectors) | **GET** /sfvb/storefronts/{storefront_oid}/pages/selectors | Read a page's selectors
587
+ *UltracartClient::SfvbApi* | [**get_sfvb_postcard_tracking**](docs/SfvbApi.md#get_sfvb_postcard_tracking) | **GET** /sfvb/storefronts/{storefront_oid}/postcards/{postcard_uuid}/tracking | Read one page of the cards mailed for a postcard
585
588
  *UltracartClient::SfvbApi* | [**get_sfvb_preview_url**](docs/SfvbApi.md#get_sfvb_preview_url) | **GET** /sfvb/storefronts/{storefront_oid}/preview_sessions/{preview_session_id}/url | URL that renders a preview session
586
589
  *UltracartClient::SfvbApi* | [**get_sfvb_recording**](docs/SfvbApi.md#get_sfvb_recording) | **GET** /sfvb/storefronts/{storefront_oid}/recordings/{screen_recording_uuid} | Get a screen recording
587
590
  *UltracartClient::SfvbApi* | [**get_sfvb_recording_page_view_events**](docs/SfvbApi.md#get_sfvb_recording_page_view_events) | **GET** /sfvb/storefronts/{storefront_oid}/recordings/{screen_recording_uuid}/page_views/{screen_recording_page_view_uuid}/events | Get one recorded page view's replay events
@@ -607,6 +610,7 @@ Class | Method | HTTP request | Description
607
610
  *UltracartClient::SfvbApi* | [**get_sfvb_tracking_provider**](docs/SfvbApi.md#get_sfvb_tracking_provider) | **GET** /sfvb/storefronts/{storefront_oid}/tracking/providers/{provider} | Read one tracking provider
608
611
  *UltracartClient::SfvbApi* | [**get_sfvb_tracking_providers**](docs/SfvbApi.md#get_sfvb_tracking_providers) | **GET** /sfvb/storefronts/{storefront_oid}/tracking/providers | List a storefront's tracking providers
609
612
  *UltracartClient::SfvbApi* | [**get_sfvb_tracking_settings**](docs/SfvbApi.md#get_sfvb_tracking_settings) | **GET** /sfvb/storefronts/{storefront_oid}/tracking | Read a storefront's privacy rules and advanced conversion settings
613
+ *UltracartClient::SfvbApi* | [**get_sfvb_transactional_email**](docs/SfvbApi.md#get_sfvb_transactional_email) | **GET** /sfvb/storefronts/{storefront_oid}/transactional_emails/{file_name} | Read a transactional email's subject, delivery options and sender
610
614
  *UltracartClient::SfvbApi* | [**get_sfvb_transactional_emails**](docs/SfvbApi.md#get_sfvb_transactional_emails) | **GET** /sfvb/storefronts/{storefront_oid}/transactional_emails | List the transactional emails a storefront sends
611
615
  *UltracartClient::SfvbApi* | [**get_sfvb_upsell_offer**](docs/SfvbApi.md#get_sfvb_upsell_offer) | **GET** /sfvb/storefronts/{storefront_oid}/upsell_offers/{upsell_offer_oid} | Get an upsell offer
612
616
  *UltracartClient::SfvbApi* | [**get_sfvb_upsell_path**](docs/SfvbApi.md#get_sfvb_upsell_path) | **GET** /sfvb/storefronts/{storefront_oid}/upsell_paths/{upsell_path_oid} | Get an upsell path
@@ -725,6 +729,7 @@ Class | Method | HTTP request | Description
725
729
  *UltracartClient::SfvbApi* | [**update_sfvb_tracking_html**](docs/SfvbApi.md#update_sfvb_tracking_html) | **PUT** /sfvb/storefronts/{storefront_oid}/tracking/html/{slot} | Write one custom tracking HTML slot
726
730
  *UltracartClient::SfvbApi* | [**update_sfvb_tracking_privacy**](docs/SfvbApi.md#update_sfvb_tracking_privacy) | **PUT** /sfvb/storefronts/{storefront_oid}/tracking/privacy | Change a storefront's privacy rules
727
731
  *UltracartClient::SfvbApi* | [**update_sfvb_tracking_provider**](docs/SfvbApi.md#update_sfvb_tracking_provider) | **PUT** /sfvb/storefronts/{storefront_oid}/tracking/providers/{provider} | Change one tracking provider
732
+ *UltracartClient::SfvbApi* | [**update_sfvb_transactional_email**](docs/SfvbApi.md#update_sfvb_transactional_email) | **PUT** /sfvb/storefronts/{storefront_oid}/transactional_emails/{file_name} | Change a transactional email's subject, delivery options or sender
728
733
  *UltracartClient::SfvbApi* | [**update_sfvb_upsell_offer**](docs/SfvbApi.md#update_sfvb_upsell_offer) | **PUT** /sfvb/storefronts/{storefront_oid}/upsell_offers/{upsell_offer_oid} | Update an upsell offer
729
734
  *UltracartClient::SfvbApi* | [**update_sfvb_upsell_path**](docs/SfvbApi.md#update_sfvb_upsell_path) | **PUT** /sfvb/storefronts/{storefront_oid}/upsell_paths/{upsell_path_oid} | Update an upsell path
730
735
  *UltracartClient::SfvbApi* | [**update_sfvb_utm_shortcode**](docs/SfvbApi.md#update_sfvb_utm_shortcode) | **PUT** /sfvb/storefronts/{storefront_oid}/utm_shortcodes/{shortcode_oid} | Change a UTM shortcode
@@ -1992,6 +1997,8 @@ Class | Method | HTTP request | Description
1992
1997
  - [UltracartClient::SfvbCommsListResponse](docs/SfvbCommsListResponse.md)
1993
1998
  - [UltracartClient::SfvbCommsListWriteRequest](docs/SfvbCommsListWriteRequest.md)
1994
1999
  - [UltracartClient::SfvbCommsListsResponse](docs/SfvbCommsListsResponse.md)
2000
+ - [UltracartClient::SfvbCommsMember](docs/SfvbCommsMember.md)
2001
+ - [UltracartClient::SfvbCommsMembersResponse](docs/SfvbCommsMembersResponse.md)
1995
2002
  - [UltracartClient::SfvbCommsPostcard](docs/SfvbCommsPostcard.md)
1996
2003
  - [UltracartClient::SfvbCommsSegment](docs/SfvbCommsSegment.md)
1997
2004
  - [UltracartClient::SfvbCommsSegmentDetail](docs/SfvbCommsSegmentDetail.md)
@@ -2140,8 +2147,11 @@ Class | Method | HTTP request | Description
2140
2147
  - [UltracartClient::SfvbPageSelectors](docs/SfvbPageSelectors.md)
2141
2148
  - [UltracartClient::SfvbPageSettingsRequest](docs/SfvbPageSettingsRequest.md)
2142
2149
  - [UltracartClient::SfvbPageSummary](docs/SfvbPageSummary.md)
2150
+ - [UltracartClient::SfvbPostcardAddress](docs/SfvbPostcardAddress.md)
2151
+ - [UltracartClient::SfvbPostcardCard](docs/SfvbPostcardCard.md)
2143
2152
  - [UltracartClient::SfvbPostcardProofRequest](docs/SfvbPostcardProofRequest.md)
2144
2153
  - [UltracartClient::SfvbPostcardProofResponse](docs/SfvbPostcardProofResponse.md)
2154
+ - [UltracartClient::SfvbPostcardTrackingResponse](docs/SfvbPostcardTrackingResponse.md)
2145
2155
  - [UltracartClient::SfvbPreviewAccessRequest](docs/SfvbPreviewAccessRequest.md)
2146
2156
  - [UltracartClient::SfvbPreviewAccessResponse](docs/SfvbPreviewAccessResponse.md)
2147
2157
  - [UltracartClient::SfvbPreviewSessionRequest](docs/SfvbPreviewSessionRequest.md)
@@ -2250,8 +2260,14 @@ Class | Method | HTTP request | Description
2250
2260
  - [UltracartClient::SfvbTrackingProvidersResponse](docs/SfvbTrackingProvidersResponse.md)
2251
2261
  - [UltracartClient::SfvbTrackingSettingsResponse](docs/SfvbTrackingSettingsResponse.md)
2252
2262
  - [UltracartClient::SfvbTrackingWholesaleTier](docs/SfvbTrackingWholesaleTier.md)
2263
+ - [UltracartClient::SfvbTransactionalChange](docs/SfvbTransactionalChange.md)
2264
+ - [UltracartClient::SfvbTransactionalDeliveryOption](docs/SfvbTransactionalDeliveryOption.md)
2253
2265
  - [UltracartClient::SfvbTransactionalEmail](docs/SfvbTransactionalEmail.md)
2266
+ - [UltracartClient::SfvbTransactionalEmailDetail](docs/SfvbTransactionalEmailDetail.md)
2267
+ - [UltracartClient::SfvbTransactionalEmailResponse](docs/SfvbTransactionalEmailResponse.md)
2268
+ - [UltracartClient::SfvbTransactionalEmailUpdateRequest](docs/SfvbTransactionalEmailUpdateRequest.md)
2254
2269
  - [UltracartClient::SfvbTransactionalEmailsResponse](docs/SfvbTransactionalEmailsResponse.md)
2270
+ - [UltracartClient::SfvbTransactionalSender](docs/SfvbTransactionalSender.md)
2255
2271
  - [UltracartClient::SfvbUpsellItemLogic](docs/SfvbUpsellItemLogic.md)
2256
2272
  - [UltracartClient::SfvbUpsellItemLogicItem](docs/SfvbUpsellItemLogicItem.md)
2257
2273
  - [UltracartClient::SfvbUpsellOffer](docs/SfvbUpsellOffer.md)
@@ -2443,6 +2459,7 @@ Not every change is committed to every SDK.
2443
2459
 
2444
2460
  | Version | Date | Comments |
2445
2461
  | --: | :-: | --- |
2462
+ | 4.1.231 | 11/05/2026 | sfvb internal testing |
2446
2463
  | 4.1.230 | 11/05/2026 | sfvb internal testing |
2447
2464
  | 4.1.229 | 11/04/2026 | sfvb internal testing |
2448
2465
  | 4.1.228 | 11/04/2026 | sfvb internal testing |
@@ -15,7 +15,7 @@
15
15
  | **auto_order_cancel_minimum_rebill_value** | **Float** | The minimum rebill value that must be paid in order to not be charged the cancellation item. | [optional] |
16
16
  | **auto_order_downgrade_items** | **Array<String>** | List of downgrade items presented to customer service representatives | [optional] |
17
17
  | **auto_order_myaccount_frequency_day_counts** | **Array<Integer>** | Day counts (1 to 365, at most 20) a customer may switch this auto-enrolled item to from MyAccount, for example [30, 60, 90]. Requires the advanced auto order settings to be enabled on the account. Omit to leave unchanged; send an empty array to clear. | [optional] |
18
- | **auto_order_myaccount_frequency_last_step_only** | **Boolean** | True if the MyAccount frequency change is only offered once the item is on its last auto order step. Omit to leave unchanged. | [optional] |
18
+ | **auto_order_myaccount_frequency_last_step_only** | **Boolean** | True if the MyAccount frequency change is only offered once the item is on its last auto order step. If auto_order_myaccount_frequency_schedules or auto_order_myaccount_frequency_day_counts is sent without this property, it is set to false; if none of the three are sent, it is left unchanged. | [optional] |
19
19
  | **auto_order_myaccount_frequency_schedules** | **Array<String>** | Standard schedules a customer may switch this auto-enrolled item to from MyAccount. Requires the advanced auto order settings to be enabled on the account. Omit to leave unchanged; send an empty array to clear. | [optional] |
20
20
  | **auto_order_paused** | **Boolean** | True if the rebill processing of this item is paused | [optional] |
21
21
  | **auto_order_prohibit_expiring_cards** | **Integer** | Minimum number of months before expiration for the card. Overrides the account level setting if higher. Set to zero to disable. | [optional] |
data/docs/SfvbApi.md CHANGED
@@ -73,7 +73,9 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
73
73
  | [**get_sfvb_comms_folder**](SfvbApi.md#get_sfvb_comms_folder) | **GET** /sfvb/storefronts/{storefront_oid}/list_segment_folders/{folder_uuid} | Read one list and segment folder |
74
74
  | [**get_sfvb_comms_folders**](SfvbApi.md#get_sfvb_comms_folders) | **GET** /sfvb/storefronts/{storefront_oid}/list_segment_folders | List the list and segment folders |
75
75
  | [**get_sfvb_comms_list**](SfvbApi.md#get_sfvb_comms_list) | **GET** /sfvb/storefronts/{storefront_oid}/lists/{list_uuid} | Read one email list |
76
+ | [**get_sfvb_comms_list_members**](SfvbApi.md#get_sfvb_comms_list_members) | **GET** /sfvb/storefronts/{storefront_oid}/lists/{list_uuid}/members | Read one page of a list's members |
76
77
  | [**get_sfvb_comms_segment**](SfvbApi.md#get_sfvb_comms_segment) | **GET** /sfvb/storefronts/{storefront_oid}/segments/{segment_uuid} | Read one segment, with its rule |
78
+ | [**get_sfvb_comms_segment_members**](SfvbApi.md#get_sfvb_comms_segment_members) | **GET** /sfvb/storefronts/{storefront_oid}/segments/{segment_uuid}/members | Read one page of a segment's members |
77
79
  | [**get_sfvb_comms_sending_domain**](SfvbApi.md#get_sfvb_comms_sending_domain) | **GET** /sfvb/comms/sending_domains/{domain} | Read a sending domain |
78
80
  | [**get_sfvb_comms_sending_domains**](SfvbApi.md#get_sfvb_comms_sending_domains) | **GET** /sfvb/comms/sending_domains | List the sending domains |
79
81
  | [**get_sfvb_comms_twilio_account**](SfvbApi.md#get_sfvb_comms_twilio_account) | **GET** /sfvb/comms/twilio_account | Read the Twilio account |
@@ -110,6 +112,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
110
112
  | [**get_sfvb_page_blog_posts**](SfvbApi.md#get_sfvb_page_blog_posts) | **GET** /sfvb/storefronts/{storefront_oid}/pages/blog_posts | Read the blog posts assigned to a page |
111
113
  | [**get_sfvb_page_items**](SfvbApi.md#get_sfvb_page_items) | **GET** /sfvb/storefronts/{storefront_oid}/pages/items | Read the items assigned to a page |
112
114
  | [**get_sfvb_page_selectors**](SfvbApi.md#get_sfvb_page_selectors) | **GET** /sfvb/storefronts/{storefront_oid}/pages/selectors | Read a page's selectors |
115
+ | [**get_sfvb_postcard_tracking**](SfvbApi.md#get_sfvb_postcard_tracking) | **GET** /sfvb/storefronts/{storefront_oid}/postcards/{postcard_uuid}/tracking | Read one page of the cards mailed for a postcard |
113
116
  | [**get_sfvb_preview_url**](SfvbApi.md#get_sfvb_preview_url) | **GET** /sfvb/storefronts/{storefront_oid}/preview_sessions/{preview_session_id}/url | URL that renders a preview session |
114
117
  | [**get_sfvb_recording**](SfvbApi.md#get_sfvb_recording) | **GET** /sfvb/storefronts/{storefront_oid}/recordings/{screen_recording_uuid} | Get a screen recording |
115
118
  | [**get_sfvb_recording_page_view_events**](SfvbApi.md#get_sfvb_recording_page_view_events) | **GET** /sfvb/storefronts/{storefront_oid}/recordings/{screen_recording_uuid}/page_views/{screen_recording_page_view_uuid}/events | Get one recorded page view's replay events |
@@ -135,6 +138,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
135
138
  | [**get_sfvb_tracking_provider**](SfvbApi.md#get_sfvb_tracking_provider) | **GET** /sfvb/storefronts/{storefront_oid}/tracking/providers/{provider} | Read one tracking provider |
136
139
  | [**get_sfvb_tracking_providers**](SfvbApi.md#get_sfvb_tracking_providers) | **GET** /sfvb/storefronts/{storefront_oid}/tracking/providers | List a storefront's tracking providers |
137
140
  | [**get_sfvb_tracking_settings**](SfvbApi.md#get_sfvb_tracking_settings) | **GET** /sfvb/storefronts/{storefront_oid}/tracking | Read a storefront's privacy rules and advanced conversion settings |
141
+ | [**get_sfvb_transactional_email**](SfvbApi.md#get_sfvb_transactional_email) | **GET** /sfvb/storefronts/{storefront_oid}/transactional_emails/{file_name} | Read a transactional email's subject, delivery options and sender |
138
142
  | [**get_sfvb_transactional_emails**](SfvbApi.md#get_sfvb_transactional_emails) | **GET** /sfvb/storefronts/{storefront_oid}/transactional_emails | List the transactional emails a storefront sends |
139
143
  | [**get_sfvb_upsell_offer**](SfvbApi.md#get_sfvb_upsell_offer) | **GET** /sfvb/storefronts/{storefront_oid}/upsell_offers/{upsell_offer_oid} | Get an upsell offer |
140
144
  | [**get_sfvb_upsell_path**](SfvbApi.md#get_sfvb_upsell_path) | **GET** /sfvb/storefronts/{storefront_oid}/upsell_paths/{upsell_path_oid} | Get an upsell path |
@@ -253,6 +257,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
253
257
  | [**update_sfvb_tracking_html**](SfvbApi.md#update_sfvb_tracking_html) | **PUT** /sfvb/storefronts/{storefront_oid}/tracking/html/{slot} | Write one custom tracking HTML slot |
254
258
  | [**update_sfvb_tracking_privacy**](SfvbApi.md#update_sfvb_tracking_privacy) | **PUT** /sfvb/storefronts/{storefront_oid}/tracking/privacy | Change a storefront's privacy rules |
255
259
  | [**update_sfvb_tracking_provider**](SfvbApi.md#update_sfvb_tracking_provider) | **PUT** /sfvb/storefronts/{storefront_oid}/tracking/providers/{provider} | Change one tracking provider |
260
+ | [**update_sfvb_transactional_email**](SfvbApi.md#update_sfvb_transactional_email) | **PUT** /sfvb/storefronts/{storefront_oid}/transactional_emails/{file_name} | Change a transactional email's subject, delivery options or sender |
256
261
  | [**update_sfvb_upsell_offer**](SfvbApi.md#update_sfvb_upsell_offer) | **PUT** /sfvb/storefronts/{storefront_oid}/upsell_offers/{upsell_offer_oid} | Update an upsell offer |
257
262
  | [**update_sfvb_upsell_path**](SfvbApi.md#update_sfvb_upsell_path) | **PUT** /sfvb/storefronts/{storefront_oid}/upsell_paths/{upsell_path_oid} | Update an upsell path |
258
263
  | [**update_sfvb_utm_shortcode**](SfvbApi.md#update_sfvb_utm_shortcode) | **PUT** /sfvb/storefronts/{storefront_oid}/utm_shortcodes/{shortcode_oid} | Change a UTM shortcode |
@@ -4016,6 +4021,63 @@ end
4016
4021
  - **Accept**: application/json
4017
4022
 
4018
4023
 
4024
+ ## get_sfvb_comms_list_members
4025
+
4026
+ > <SfvbCommsMembersResponse> get_sfvb_comms_list_members(storefront_oid, list_uuid, opts)
4027
+
4028
+ Read one page of a list's members
4029
+
4030
+ Each member's customer uuid, email and the date they joined. Email addresses are masked (w***a@example.com) and customer_data is masked, unless show_customer_data is true, which returns the real addresses and needs the sfvb_publish scope. Every such read is logged. Ask for them only when the merchant needs a person's address. Read only.
4031
+
4032
+
4033
+ ### Examples
4034
+
4035
+
4036
+ (No example for this operation).
4037
+
4038
+
4039
+ #### Using the get_sfvb_comms_list_members_with_http_info variant
4040
+
4041
+ This returns an Array which contains the response data, status code and headers.
4042
+
4043
+ > <Array(<SfvbCommsMembersResponse>, Integer, Hash)> get_sfvb_comms_list_members_with_http_info(storefront_oid, list_uuid, opts)
4044
+
4045
+ ```ruby
4046
+ begin
4047
+ # Read one page of a list's members
4048
+ data, status_code, headers = api_instance.get_sfvb_comms_list_members_with_http_info(storefront_oid, list_uuid, opts)
4049
+ p status_code # => 2xx
4050
+ p headers # => { ... }
4051
+ p data # => <SfvbCommsMembersResponse>
4052
+ rescue UltracartClient::ApiError => e
4053
+ puts "Error when calling SfvbApi->get_sfvb_comms_list_members_with_http_info: #{e}"
4054
+ end
4055
+ ```
4056
+
4057
+ ### Parameters
4058
+
4059
+ | Name | Type | Description | Notes |
4060
+ | ---- | ---- | ----------- | ----- |
4061
+ | **storefront_oid** | **Integer** | | |
4062
+ | **list_uuid** | **String** | | |
4063
+ | **page** | **Integer** | The page, from 1 | [optional] |
4064
+ | **page_size** | **Integer** | Members per page, 1 to 100 (default 50) | [optional] |
4065
+ | **show_customer_data** | **Boolean** | True to return the real email addresses instead of masked ones | [optional] |
4066
+
4067
+ ### Return type
4068
+
4069
+ [**SfvbCommsMembersResponse**](SfvbCommsMembersResponse.md)
4070
+
4071
+ ### Authorization
4072
+
4073
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
4074
+
4075
+ ### HTTP request headers
4076
+
4077
+ - **Content-Type**: Not defined
4078
+ - **Accept**: application/json
4079
+
4080
+
4019
4081
  ## get_sfvb_comms_segment
4020
4082
 
4021
4083
  > <SfvbCommsSegmentResponse> get_sfvb_comms_segment(storefront_oid, segment_uuid)
@@ -4070,6 +4132,63 @@ end
4070
4132
  - **Accept**: application/json
4071
4133
 
4072
4134
 
4135
+ ## get_sfvb_comms_segment_members
4136
+
4137
+ > <SfvbCommsMembersResponse> get_sfvb_comms_segment_members(storefront_oid, segment_uuid, opts)
4138
+
4139
+ Read one page of a segment's members
4140
+
4141
+ Each member's customer uuid, email and the date they joined. Email addresses are masked (w***a@example.com) and customer_data is masked, unless show_customer_data is true, which returns the real addresses and needs the sfvb_publish scope. Every such read is logged. Ask for them only when the merchant needs a person's address. Read only.
4142
+
4143
+
4144
+ ### Examples
4145
+
4146
+
4147
+ (No example for this operation).
4148
+
4149
+
4150
+ #### Using the get_sfvb_comms_segment_members_with_http_info variant
4151
+
4152
+ This returns an Array which contains the response data, status code and headers.
4153
+
4154
+ > <Array(<SfvbCommsMembersResponse>, Integer, Hash)> get_sfvb_comms_segment_members_with_http_info(storefront_oid, segment_uuid, opts)
4155
+
4156
+ ```ruby
4157
+ begin
4158
+ # Read one page of a segment's members
4159
+ data, status_code, headers = api_instance.get_sfvb_comms_segment_members_with_http_info(storefront_oid, segment_uuid, opts)
4160
+ p status_code # => 2xx
4161
+ p headers # => { ... }
4162
+ p data # => <SfvbCommsMembersResponse>
4163
+ rescue UltracartClient::ApiError => e
4164
+ puts "Error when calling SfvbApi->get_sfvb_comms_segment_members_with_http_info: #{e}"
4165
+ end
4166
+ ```
4167
+
4168
+ ### Parameters
4169
+
4170
+ | Name | Type | Description | Notes |
4171
+ | ---- | ---- | ----------- | ----- |
4172
+ | **storefront_oid** | **Integer** | | |
4173
+ | **segment_uuid** | **String** | | |
4174
+ | **page** | **Integer** | The page, from 1 | [optional] |
4175
+ | **page_size** | **Integer** | Members per page, 1 to 100 (default 50) | [optional] |
4176
+ | **show_customer_data** | **Boolean** | True to return the real email addresses instead of masked ones | [optional] |
4177
+
4178
+ ### Return type
4179
+
4180
+ [**SfvbCommsMembersResponse**](SfvbCommsMembersResponse.md)
4181
+
4182
+ ### Authorization
4183
+
4184
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
4185
+
4186
+ ### HTTP request headers
4187
+
4188
+ - **Content-Type**: Not defined
4189
+ - **Accept**: application/json
4190
+
4191
+
4073
4192
  ## get_sfvb_comms_sending_domain
4074
4193
 
4075
4194
  > <SfvbCommsSendingDomain> get_sfvb_comms_sending_domain(domain)
@@ -6020,6 +6139,63 @@ end
6020
6139
  - **Accept**: application/json
6021
6140
 
6022
6141
 
6142
+ ## get_sfvb_postcard_tracking
6143
+
6144
+ > <SfvbPostcardTrackingResponse> get_sfvb_postcard_tracking(storefront_oid, postcard_uuid, opts)
6145
+
6146
+ Read one page of the cards mailed for a postcard
6147
+
6148
+ Every printed card mailed for the postcard, newest first, with its status, cost, dates and the order it converted to. Recipients are masked (the name an initial, the street lines hidden, city, state and postal code kept) and the vendor's status text is left out, unless show_customer_data is true, which needs the sfvb_publish scope and is logged. The return address is the merchant's own. Read only.
6149
+
6150
+
6151
+ ### Examples
6152
+
6153
+
6154
+ (No example for this operation).
6155
+
6156
+
6157
+ #### Using the get_sfvb_postcard_tracking_with_http_info variant
6158
+
6159
+ This returns an Array which contains the response data, status code and headers.
6160
+
6161
+ > <Array(<SfvbPostcardTrackingResponse>, Integer, Hash)> get_sfvb_postcard_tracking_with_http_info(storefront_oid, postcard_uuid, opts)
6162
+
6163
+ ```ruby
6164
+ begin
6165
+ # Read one page of the cards mailed for a postcard
6166
+ data, status_code, headers = api_instance.get_sfvb_postcard_tracking_with_http_info(storefront_oid, postcard_uuid, opts)
6167
+ p status_code # => 2xx
6168
+ p headers # => { ... }
6169
+ p data # => <SfvbPostcardTrackingResponse>
6170
+ rescue UltracartClient::ApiError => e
6171
+ puts "Error when calling SfvbApi->get_sfvb_postcard_tracking_with_http_info: #{e}"
6172
+ end
6173
+ ```
6174
+
6175
+ ### Parameters
6176
+
6177
+ | Name | Type | Description | Notes |
6178
+ | ---- | ---- | ----------- | ----- |
6179
+ | **storefront_oid** | **Integer** | | |
6180
+ | **postcard_uuid** | **String** | | |
6181
+ | **page** | **Integer** | The page, from 1 | [optional] |
6182
+ | **page_size** | **Integer** | Cards per page, 1 to 100 (default 50) | [optional] |
6183
+ | **show_customer_data** | **Boolean** | True to return the recipients&#39; real names and street addresses | [optional] |
6184
+
6185
+ ### Return type
6186
+
6187
+ [**SfvbPostcardTrackingResponse**](SfvbPostcardTrackingResponse.md)
6188
+
6189
+ ### Authorization
6190
+
6191
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
6192
+
6193
+ ### HTTP request headers
6194
+
6195
+ - **Content-Type**: Not defined
6196
+ - **Accept**: application/json
6197
+
6198
+
6023
6199
  ## get_sfvb_preview_url
6024
6200
 
6025
6201
  > <SfvbPreviewUrlResponse> get_sfvb_preview_url(storefront_oid, preview_session_id, opts)
@@ -7366,6 +7542,60 @@ end
7366
7542
  - **Accept**: application/json
7367
7543
 
7368
7544
 
7545
+ ## get_sfvb_transactional_email
7546
+
7547
+ > <SfvbTransactionalEmailResponse> get_sfvb_transactional_email(storefront_oid, file_name)
7548
+
7549
+ Read a transactional email's subject, delivery options and sender
7550
+
7551
+ file_name is the template file from the transactional email list, such as receipt_html.vm, or its display name. The sender is shared by every storefront on the same screen branding theme (sender_shared_with); a sender that sends through the merchant's own mail server shows smtp true and never its credentials. hash_sha256 is the If-Match for an update. The template itself is a theme file.
7552
+
7553
+
7554
+ ### Examples
7555
+
7556
+
7557
+ (No example for this operation).
7558
+
7559
+
7560
+ #### Using the get_sfvb_transactional_email_with_http_info variant
7561
+
7562
+ This returns an Array which contains the response data, status code and headers.
7563
+
7564
+ > <Array(<SfvbTransactionalEmailResponse>, Integer, Hash)> get_sfvb_transactional_email_with_http_info(storefront_oid, file_name)
7565
+
7566
+ ```ruby
7567
+ begin
7568
+ # Read a transactional email's subject, delivery options and sender
7569
+ data, status_code, headers = api_instance.get_sfvb_transactional_email_with_http_info(storefront_oid, file_name)
7570
+ p status_code # => 2xx
7571
+ p headers # => { ... }
7572
+ p data # => <SfvbTransactionalEmailResponse>
7573
+ rescue UltracartClient::ApiError => e
7574
+ puts "Error when calling SfvbApi->get_sfvb_transactional_email_with_http_info: #{e}"
7575
+ end
7576
+ ```
7577
+
7578
+ ### Parameters
7579
+
7580
+ | Name | Type | Description | Notes |
7581
+ | ---- | ---- | ----------- | ----- |
7582
+ | **storefront_oid** | **Integer** | | |
7583
+ | **file_name** | **String** | | |
7584
+
7585
+ ### Return type
7586
+
7587
+ [**SfvbTransactionalEmailResponse**](SfvbTransactionalEmailResponse.md)
7588
+
7589
+ ### Authorization
7590
+
7591
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
7592
+
7593
+ ### HTTP request headers
7594
+
7595
+ - **Content-Type**: Not defined
7596
+ - **Accept**: application/json
7597
+
7598
+
7369
7599
  ## get_sfvb_transactional_emails
7370
7600
 
7371
7601
  > <SfvbTransactionalEmailsResponse> get_sfvb_transactional_emails(storefront_oid)
@@ -13875,6 +14105,63 @@ end
13875
14105
  - **Accept**: application/json
13876
14106
 
13877
14107
 
14108
+ ## update_sfvb_transactional_email
14109
+
14110
+ > <SfvbTransactionalEmailResponse> update_sfvb_transactional_email(storefront_oid, file_name, if_match, transactional_email_update_request, opts)
14111
+
14112
+ Change a transactional email's subject, delivery options or sender
14113
+
14114
+ A field left out stays as it is. It goes to every matching order from the moment it is saved, so every change needs sfvb_publish, the email's hash_sha256 as If-Match, and an approved transactional_email.update request for exactly this change (params.path the template file). dry_run checks and shows the change without writing or using an approval. Delivery options are named by name. A sender change reaches every storefront on the same screen branding theme, and is refused for one that sends through the merchant's own mail server.
14115
+
14116
+
14117
+ ### Examples
14118
+
14119
+
14120
+ (No example for this operation).
14121
+
14122
+
14123
+ #### Using the update_sfvb_transactional_email_with_http_info variant
14124
+
14125
+ This returns an Array which contains the response data, status code and headers.
14126
+
14127
+ > <Array(<SfvbTransactionalEmailResponse>, Integer, Hash)> update_sfvb_transactional_email_with_http_info(storefront_oid, file_name, if_match, transactional_email_update_request, opts)
14128
+
14129
+ ```ruby
14130
+ begin
14131
+ # Change a transactional email's subject, delivery options or sender
14132
+ data, status_code, headers = api_instance.update_sfvb_transactional_email_with_http_info(storefront_oid, file_name, if_match, transactional_email_update_request, opts)
14133
+ p status_code # => 2xx
14134
+ p headers # => { ... }
14135
+ p data # => <SfvbTransactionalEmailResponse>
14136
+ rescue UltracartClient::ApiError => e
14137
+ puts "Error when calling SfvbApi->update_sfvb_transactional_email_with_http_info: #{e}"
14138
+ end
14139
+ ```
14140
+
14141
+ ### Parameters
14142
+
14143
+ | Name | Type | Description | Notes |
14144
+ | ---- | ---- | ----------- | ----- |
14145
+ | **storefront_oid** | **Integer** | | |
14146
+ | **file_name** | **String** | | |
14147
+ | **if_match** | **String** | The email&#39;s hash_sha256 from the last read. Required; 428 when absent, 412 when stale. | |
14148
+ | **transactional_email_update_request** | [**SfvbTransactionalEmailUpdateRequest**](SfvbTransactionalEmailUpdateRequest.md) | The fields to change | |
14149
+ | **approval_id** | **String** | The approval_id of an approved transactional_email.update request for exactly this change. See POST /sfvb/approvals. | [optional] |
14150
+
14151
+ ### Return type
14152
+
14153
+ [**SfvbTransactionalEmailResponse**](SfvbTransactionalEmailResponse.md)
14154
+
14155
+ ### Authorization
14156
+
14157
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
14158
+
14159
+ ### HTTP request headers
14160
+
14161
+ - **Content-Type**: application/json
14162
+ - **Accept**: application/json
14163
+
14164
+
13878
14165
  ## update_sfvb_upsell_offer
13879
14166
 
13880
14167
  > <SfvbUpsellOffer> update_sfvb_upsell_offer(storefront_oid, upsell_offer_oid, if_match, upsell_offer)
@@ -17,6 +17,7 @@
17
17
  | **site_seo** | [**SfvbSiteSeoRequest**](SfvbSiteSeoRequest.md) | | [optional] |
18
18
  | **smart_attribution** | [**SfvbSmartAttributionRequest**](SfvbSmartAttributionRequest.md) | | [optional] |
19
19
  | **tracking_provider** | [**SfvbTrackingProviderRequest**](SfvbTrackingProviderRequest.md) | | [optional] |
20
+ | **transactional_email** | [**SfvbTransactionalEmailUpdateRequest**](SfvbTransactionalEmailUpdateRequest.md) | | [optional] |
20
21
 
21
22
  ## Example
22
23
 
@@ -36,7 +37,8 @@ instance = UltracartClient::SfvbApprovalCreateRequest.new(
36
37
  segment_update: null,
37
38
  site_seo: null,
38
39
  smart_attribution: null,
39
- tracking_provider: null
40
+ tracking_provider: null,
41
+ transactional_email: null
40
42
  )
41
43
  ```
42
44
 
data/docs/SfvbCampaign.md CHANGED
@@ -21,6 +21,7 @@
21
21
  | **sending_domain_uuid** | **String** | The sending domain uuid. Defaults to the storefront&#39;s marketing sending domain. | [optional] |
22
22
  | **sending_name** | **String** | The from name. Defaults to the storefront&#39;s marketing setting. | [optional] |
23
23
  | **sending_user** | **String** | The part of the from address before the at sign. Defaults to the storefront&#39;s marketing setting. | [optional] |
24
+ | **sms_phone_number** | **String** | The number this campaign&#39;s SMS steps send from. Without one, every SMS step skips every customer, whatever the account&#39;s SMS settings say. | [optional] |
24
25
  | **status** | **String** | The status, such as draft, scheduled, sending, sent or archived. | [optional] |
25
26
  | **status_dts** | **String** | When the status last changed (ISO 8601, UTC). | [optional] |
26
27
 
@@ -47,6 +48,7 @@ instance = UltracartClient::SfvbCampaign.new(
47
48
  sending_domain_uuid: null,
48
49
  sending_name: null,
49
50
  sending_user: null,
51
+ sms_phone_number: null,
50
52
  status: null,
51
53
  status_dts: null
52
54
  )
@@ -0,0 +1,22 @@
1
+ # UltracartClient::SfvbCommsMember
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **added_dts** | **String** | When the customer joined the list or segment. | [optional] |
8
+ | **customer_uuid** | **String** | The customer uuid, the same on every list, segment and flow. | [optional] |
9
+ | **email** | **String** | The email address, masked as w***a@example.com unless show_customer_data was sent. | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'ultracart_api'
15
+
16
+ instance = UltracartClient::SfvbCommsMember.new(
17
+ added_dts: null,
18
+ customer_uuid: null,
19
+ email: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,36 @@
1
+ # UltracartClient::SfvbCommsMembersResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **customer_data** | **String** | masked, or shown when show_customer_data was sent. | [optional] |
8
+ | **list_uuid** | **String** | The list, for a list&#39;s members. | [optional] |
9
+ | **members** | [**Array&lt;SfvbCommsMember&gt;**](SfvbCommsMember.md) | This page of members. | [optional] |
10
+ | **notes** | **Array&lt;String&gt;** | What to keep in mind, such as how to handle customer data that is shown. | [optional] |
11
+ | **page** | **Integer** | The page number, from 1. | [optional] |
12
+ | **page_size** | **Integer** | Members per page. | [optional] |
13
+ | **rebuild_required** | **Boolean** | For a segment, true while it is being rebuilt, so the members are from the last rebuild. | [optional] |
14
+ | **segment_uuid** | **String** | The segment, for a segment&#39;s members. | [optional] |
15
+ | **total_members** | **Integer** | How many members there are. | [optional] |
16
+ | **total_pages** | **Integer** | How many pages there are. | [optional] |
17
+
18
+ ## Example
19
+
20
+ ```ruby
21
+ require 'ultracart_api'
22
+
23
+ instance = UltracartClient::SfvbCommsMembersResponse.new(
24
+ customer_data: null,
25
+ list_uuid: null,
26
+ members: null,
27
+ notes: null,
28
+ page: null,
29
+ page_size: null,
30
+ rebuild_required: null,
31
+ segment_uuid: null,
32
+ total_members: null,
33
+ total_pages: null
34
+ )
35
+ ```
36
+
data/docs/SfvbFlow.md CHANGED
@@ -22,6 +22,7 @@
22
22
  | **sending_domain_uuid** | **String** | The sending domain uuid. Defaults to the storefront&#39;s marketing sending domain. | [optional] |
23
23
  | **sending_name** | **String** | The from name. Defaults to the storefront&#39;s marketing setting. | [optional] |
24
24
  | **sending_user** | **String** | The part of the from address before the at sign. Defaults to the storefront&#39;s marketing setting. | [optional] |
25
+ | **sms_phone_number** | **String** | The number this flow&#39;s SMS steps send from. Without one, every SMS step skips every customer, whatever the account&#39;s SMS settings say. | [optional] |
25
26
  | **status** | **String** | The status, such as draft, active, paused, draining or inactive. | [optional] |
26
27
  | **status_dts** | **String** | When the status last changed (ISO 8601, UTC). | [optional] |
27
28
  | **trigger_parameter** | **String** | The list or segment uuid, or other value, the trigger is limited to. | [optional] |
@@ -52,6 +53,7 @@ instance = UltracartClient::SfvbFlow.new(
52
53
  sending_domain_uuid: null,
53
54
  sending_name: null,
54
55
  sending_user: null,
56
+ sms_phone_number: null,
55
57
  status: null,
56
58
  status_dts: null,
57
59
  trigger_parameter: null,
@@ -0,0 +1,28 @@
1
+ # UltracartClient::SfvbPostcardAddress
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **address_line_1** | **String** | The first street line. For the recipient, [hidden] unless customer data was asked for. | [optional] |
8
+ | **address_line_2** | **String** | The second street line, masked the same way. | [optional] |
9
+ | **city** | **String** | The city. | [optional] |
10
+ | **name** | **String** | The name. For the recipient, an initial unless customer data was asked for. | [optional] |
11
+ | **state** | **String** | The state or region. | [optional] |
12
+ | **zip** | **String** | The postal code. | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'ultracart_api'
18
+
19
+ instance = UltracartClient::SfvbPostcardAddress.new(
20
+ address_line_1: null,
21
+ address_line_2: null,
22
+ city: null,
23
+ name: null,
24
+ state: null,
25
+ zip: null
26
+ )
27
+ ```
28
+
@@ -0,0 +1,40 @@
1
+ # UltracartClient::SfvbPostcardCard
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **conversion_dts** | **String** | When the customer ordered after it. | [optional] |
8
+ | **cost** | **Float** | What the account is billed for this card. | [optional] |
9
+ | **customer_uuid** | **String** | The customer it was mailed to. | [optional] |
10
+ | **delivered_dts** | **String** | When it was delivered. | [optional] |
11
+ | **from** | [**SfvbPostcardAddress**](SfvbPostcardAddress.md) | | [optional] |
12
+ | **mailed_dts** | **String** | When it was mailed. | [optional] |
13
+ | **order_id** | **String** | The order it converted to. | [optional] |
14
+ | **print_record_uuid** | **String** | The print vendor&#39;s record for this card. | [optional] |
15
+ | **status** | **String** | The vendor&#39;s latest status. | [optional] |
16
+ | **submit_dts** | **String** | When it was sent to the printer. | [optional] |
17
+ | **to** | [**SfvbPostcardAddress**](SfvbPostcardAddress.md) | | [optional] |
18
+ | **tracking_description** | **String** | The vendor&#39;s own words for the latest status. Only when customer data was asked for, since it can name where the card went. | [optional] |
19
+
20
+ ## Example
21
+
22
+ ```ruby
23
+ require 'ultracart_api'
24
+
25
+ instance = UltracartClient::SfvbPostcardCard.new(
26
+ conversion_dts: null,
27
+ cost: null,
28
+ customer_uuid: null,
29
+ delivered_dts: null,
30
+ from: null,
31
+ mailed_dts: null,
32
+ order_id: null,
33
+ print_record_uuid: null,
34
+ status: null,
35
+ submit_dts: null,
36
+ to: null,
37
+ tracking_description: null
38
+ )
39
+ ```
40
+