tessitura_rest 0.7.4

data/lib/tessitura_rest/txn/sub_line_items.rb

@@ -0,0 +1,9 @@
+module SubLineItems
+
+  def get_return_tickets(constituent_id, status_id, performance_start_date, performance_end_date, order_id, options={})
+    options.merge!(basic_auth: @auth, headers: @headers)
+    response = self.class.get(base_api_endpoint("TXN/SubLineItems?constituentId=#{constituent_id}&orderId=#{order_id}&subLineItemStatusIds=#{status_id}&performanceStartDate=#{performance_start_date}&performanceEndDate=#{performance_end_date}"), options)
+    JSON.parse(response.body)
+  end
+
+end

data/lib/tessitura_rest/txn/web_contents.rb

@@ -0,0 +1,9 @@
+module WebContents
+
+  def get_web_contents(production_ids=nil, package_ids=nil, content_type_ids=nil, options={})
+    options.merge!(basic_auth: @auth, headers: @headers)
+    response = self.class.get(base_api_endpoint("TXN/WebContents?productionElementIds=#{production_ids}&packageIds=#{package_ids}&contentTypeIds=#{content_type_ids}"), options)
+    JSON.parse(response.body)
+  end
+
+end

data/lib/tessitura_rest/version.rb

@@ -0,0 +1,3 @@
+class TessituraRest
+  VERSION = '0.7.4'
+end

data/lib/tessitura_rest/web/cart.rb

@@ -0,0 +1,293 @@
+module Cart
+
+  def get_cart(session_key, options={})
+    options.merge!(basic_auth: @auth, headers: @headers)
+    self.class.get(base_api_endpoint("Web/Cart/#{session_key}"), options)
+  end
+
+  def empty_cart(session_key, options={})
+    options.merge!(basic_auth: @auth, headers: @headers)
+    self.class.delete(base_api_endpoint("Web/Cart/#{session_key}"), options)
+  end
+
+  def web_cart_text(session_key, options={})
+    options.merge!(basic_auth: @auth, headers: @headers)
+    self.class.get(base_api_endpoint("Web/Cart/#{session_key}/Messages?messageTypes=#{ENV['WEB_CART_TEXT']}&savedCart=false"), options)
+  end
+
+  def order_confirm_text(session_key, options={})
+    options.merge!(basic_auth: @auth, headers: @headers)
+    self.class.get(base_api_endpoint("Web/Cart/#{session_key}?messageTypes=#{ENV['ORDER_CONFIRM_TEXT']}&savedCart=true"), options)
+  end
+
+  def change_mode_of_sale(session_key, code, options={})
+    parameters =
+        {
+            'ModeOfSaleId': code
+        }
+    options.merge!(basic_auth: @auth, headers: @headers)
+    options.merge!(:body => parameters)
+    self.class.put(base_api_endpoint("Web/Cart/#{session_key}/Properties"), options)
+  end
+
+  def add_gift_certificate(session_key, amount, name, notes, gift_certificate_type, options={})
+    parameters =
+    {
+            'Amount': amount,
+            'PaymentMethodId': gift_certificate_type,
+            'Notes': notes,
+            'Name': name
+    }
+    options.merge!(basic_auth: @auth, headers: @headers)
+    options.merge!(:body => parameters)
+    self.class.post(base_api_endpoint("Web/Cart/#{session_key}/GiftCertificates"), options)
+  end
+
+  def remove_gift_certificate(session_key, gift_certificate_number, options={})
+    options.merge!(basic_auth: @auth, headers: @headers)
+    self.class.delete(base_api_endpoint("Web/Cart/#{session_key}/GiftCertificates/#{gift_certificate_number}"), options)
+  end
+
+  def apply_gift_certificate(session_key, gift_certificate_number, amount, options={})
+    parameters =
+        {
+            'Amount': amount,
+            'GiftCertificateNumber': gift_certificate_number
+        }
+    options.merge!(basic_auth: @auth, headers: @headers)
+    options.merge!(:body => parameters)
+    self.class.post(base_api_endpoint("Web/Cart/#{session_key}/Payments/GiftCertificate"), options)
+  end
+
+  def un_apply_gift_certificate(session_key, gift_certificate_number, options={})
+    options.merge!(basic_auth: @auth, headers: @headers)
+    self.class.delete(base_api_endpoint("Web/Cart/#{session_key}/Payments/GiftCertificate/#{gift_certificate_number}"), options)
+  end
+
+  def add_contribution(session_key, amount, fund, membership_level, renew=nil, upgrade=nil, options={})
+    parameters =
+    {
+        'Amount': amount,
+        'FundId': fund,
+        'Upgrade': upgrade,
+        'Renew': renew,
+        'MembershipLevelId': membership_level
+    }
+    options.merge!(basic_auth: @auth, headers: @headers)
+    options.merge!(:body => parameters)
+    self.class.post(base_api_endpoint("Web/Cart/#{session_key}/Contributions"), options)
+  end
+
+  def remove_contribution(session_key, line_item_id, options={})
+    options.merge!(basic_auth: @auth, headers: @headers)
+    self.class.delete(base_api_endpoint("Web/Cart/#{session_key}/Contributions/#{line_item_id}"), options)
+  end
+
+  def add_on_account(session_key, amount, payment_method_id, options={})
+    parameters =
+    {
+        'Amount': amount,
+        "PaymentMethodId": payment_method_id
+    }
+    options.merge!(basic_auth: @auth, headers: @headers)
+    options.merge!(:body => parameters)
+    self.class.post(base_api_endpoint("Web/Cart/#{session_key}/OnAccount"), options)
+  end
+
+  def remove_on_account(session_key, payment_id, options={})
+    options.merge!(basic_auth: @auth, headers: @headers)
+    self.class.delete(base_api_endpoint("Web/Cart/#{session_key}/OnAccount/#{payment_id}"), options)
+  end
+
+  def get_properties(session_key, options={})
+    options.merge!(basic_auth: @auth, headers: @headers)
+    self.class.get(base_api_endpoint("Web/Cart/#{session_key}/Properties"), options)
+  end
+
+  def update_properties(session_key, category=0, solicitor='webapi', channel=0, options={})
+    options.merge!(basic_auth: @auth, headers: @headers)
+    parameters =
+    {
+      "Solicitor": solicitor,
+      "ChannelId": channel
+    }
+    parameters["CategoryId"] = category if category != 0
+    options.merge!(:body => parameters)
+    self.class.put(base_api_endpoint("Web/Cart/#{session_key}/Properties"), options)
+  end
+
+  def update_source(session_key, source_no, solicitor='webapi', options={})
+    options.merge!(basic_auth: @auth, headers: @headers)
+    parameters =
+    {
+      "Solicitor": solicitor,
+      "SourceId": source_no
+    }
+    options.merge!(:body => parameters)
+    self.class.put(base_api_endpoint("Web/Cart/#{session_key}/Properties"), options)
+  end
+
+  def add_order_comment(session_key, notes, solicitor='webapi', options={})
+    options.merge!(basic_auth: @auth, headers: @headers)
+    parameters =
+    {
+      "Solicitor": solicitor,
+      "Notes": notes
+    }
+    options.merge!(:body => parameters)
+    self.class.put(base_api_endpoint("Web/Cart/#{session_key}/Properties"), options)
+  end
+
+  def reserve_tickets(session_key, number_of_seats, perf_id, price_type, zone_id, unseated, requested_seats=nil, special_requests=nil, options={})
+    parameters =
+    {
+      "PriceType": price_type,
+      "PerformanceId": perf_id,
+      "NumberOfSeats": number_of_seats,
+      "ZoneId": zone_id,
+      "SpecialRequests": special_requests,
+      "Unseated": unseated,
+      "RequestedSeats": requested_seats
+    }
+    options.merge!(basic_auth: @auth, headers: @headers)
+    options.merge!(:body => parameters)
+    self.class.post(base_api_endpoint("/Web/Cart/#{session_key}/Tickets"), options)
+  end
+
+  def return_tickets(session_key, return_or_donate, id, options={})
+    parameters =
+    {
+      "TicketNumber": id,
+      "ReturnOrDonate": return_or_donate
+    }
+    options.merge!(basic_auth: @auth, headers: @headers)
+    options.merge!(:body => parameters)
+    self.class.post(base_api_endpoint("/Web/Cart/#{session_key}/Tickets/Return"), options)
+  end
+
+  def add_package_item(session_key, price_type, package_id, number_of_seats, zone_id, leave_single_seats, parent_package_line_item_id, unseated, requested_seats=nil, options={})
+    parameters =
+    {
+      "PriceType": price_type,
+      "PackageId": package_id,
+      "NumberOfSeats": number_of_seats,
+      "ZoneId": zone_id,
+      "RequestedSeats": requested_seats,
+      "LeaveSingleSeats": leave_single_seats,
+      "ParentPackageLineItemId": parent_package_line_item_id,
+      "Unseated": unseated
+    }
+
+    options.merge!(basic_auth: @auth, headers: @headers)
+    options.merge!(:body => parameters)
+    self.class.post(base_api_endpoint("Web/Cart/#{session_key}/Packages/Fixed"), options)
+  end
+
+  def remove_package_item(session_key, package_id, line_item_id, options={})
+    options.merge!(basic_auth: @auth, headers: @headers)
+    self.class.delete(base_api_endpoint("Web/Cart/#{session_key}/Packages/Fixed/#{package_id}/#{line_item_id}"), options)
+  end
+
+  def add_nfs_package_item(session_key, nfs_package_line_item_id, performance_id, performance_group_id, price_type, package_id, number_of_seats, zone_id, leave_single_seats, unseated, options={})
+    parameters =
+    {
+      "NFSPackageLineItemId": nfs_package_line_item_id,
+      "PriceType": price_type,
+      "PackageId": package_id,
+      "PerformanceId": performance_id,
+      "PerformanceGroupId": performance_group_id,
+      "NumberOfSeats": number_of_seats,
+      "ZoneId": zone_id,
+      "LeaveSingleSeats": leave_single_seats,
+      "Unseated": unseated
+    }
+    options.merge!(basic_auth: @auth, headers: @headers)
+    options.merge!(:body => parameters)
+    self.class.post(base_api_endpoint("Web/Cart/#{session_key}/Packages/Nfs"), options)
+  end
+
+  def remove_nfs_package_item(session_key, line_item_id, options={})
+    options.merge!(basic_auth: @auth, headers: @headers)
+    self.class.delete(base_api_endpoint("Web/Cart/#{session_key}/Packages/Nfs/#{line_item_id}"), options)
+  end
+
+  def add_sub_package_item(session_key, price_type, sub_package_id, number_of_seats, zone_id, leave_single_seats, parent_super_line_item_id, super_line_item_id, unseated, requested_seats=nil, options={})
+    parameters =
+    {
+      "ParentSuperPackageLineItemId": parent_super_line_item_id,
+      "SuperPackageLineItemId": super_line_item_id,
+      "PriceType": price_type,
+      "SubPackageId": sub_package_id,
+      "NumberOfSeats": number_of_seats,
+      "ZoneId": zone_id,
+      "RequestedSeats": requested_seats,
+      "LeaveSingleSeats": leave_single_seats,
+      "Unseated": unseated
+    }
+    options.merge!(basic_auth: @auth, headers: @headers)
+    options.merge!(:body => parameters)
+    self.class.post(base_api_endpoint("Web/Cart/#{session_key}/Packages/Super"), options)
+  end
+
+  def remove_sub_package_item(session_key, super_package_id, super_package_line_item_id, options={})
+    options.merge!(basic_auth: @auth, headers: @headers)
+    self.class.delete(base_api_endpoint("Web/Cart/#{session_key}/Packages/Super/#{super_package_id}/#{super_package_line_item_id}"), options)
+  end
+
+  def print_ticket_elements(session_key, order_id, ticket_design, reprint, mode, new_ticket_no=false, options={})
+    parameters =
+        {
+            "NewTicketNoForReprints": new_ticket_no,
+            "ReprintTickets": reprint,
+            "OrderId": order_id,
+            "TicketDesignId": ticket_design,
+            "Mode": mode
+        }
+    options.merge!(basic_auth: @auth, headers: @headers)
+    options.merge!(:body => parameters)
+    self.class.post(base_api_endpoint("/Web/Cart/#{session_key}/Print/TicketElements"), options)
+  end
+
+  def remove_tickets(session_key, performance_id, line_item_id, options={})
+    options.merge!(basic_auth: @auth, headers: @headers)
+    self.class.delete(base_api_endpoint("/Web/Cart/#{session_key}/Tickets/#{performance_id}/#{line_item_id}"), options)
+  end
+
+  def add_or_update_fee(session_key, action, fee_id, item_fee_id=nil, amount=nil, options={})
+    parameters =
+    {
+      "Action": action,
+      "ItemFeeId": item_fee_id,
+      "FeeId": fee_id,
+      "Amount": amount
+    }
+    options.merge!(basic_auth: @auth, headers: @headers)
+    options.merge!(:body => parameters)
+    self.class.post(base_api_endpoint("Web/Cart/#{session_key}/Fees"), options)
+  end
+
+  def validate_cart(session_key, super_package=false, fixed=false, flex=false, plan=false, options={})
+    parameters =
+    {
+      "ValidateSuperPackages": super_package,
+      "ValidateFSPackages": fixed,
+      "ValidateNFSPackages": flex,
+      "ValidatePaymentPlan": plan
+    }
+    options.merge!(basic_auth: @auth, headers: @headers)
+    options.merge!(:body => parameters)
+    self.class.post(base_api_endpoint("Web/Cart/#{session_key}/Validate"), options)
+  end
+
+  def update_cart_properties_custom_data(session_key, index, value, options={})
+    parameters =
+    {
+      "Index": index,
+      "Value": value
+    }
+    options.merge!(basic_auth: @auth, headers: @headers)
+    options.merge!(:body => parameters)
+    put = self.class.put(base_api_endpoint("Web/Cart/#{session_key}/CustomData/#{index}"), options)
+    put.success?
+  end
+end

data/lib/tessitura_rest/web/login.rb

@@ -0,0 +1,55 @@
+module Login
+
+  def with_user(ip_address, business_unit_id, options={})
+    options.merge!(basic_auth: @auth, headers: @headers)
+    response = self.class.get(base_api_endpoint('Web/Session/'), options)
+    JSON.parse(response.body)
+  end
+
+  def login_using_email(email, password, login_type_id, promotion, session_key, options={})
+    parameters =
+      {
+        'UserName': email,
+        'Password': password, 
+        'LoginTypeId': login_type_id,
+        'PromotionCode': promotion
+      }
+    options.merge!(basic_auth: @auth, headers: @headers)
+    options.merge!(:body => parameters)
+    post = self.class.post(base_api_endpoint("Web/Session/#{session_key}/Login"), options)
+    post['IsLoggedIn']
+  end
+
+  def login_using_external(email, login_type_id, promotion, session_key, options={})
+    parameters =
+      {
+        'UserName': email,
+        'LoginTypeId': login_type_id,
+        'PromotionCode': promotion
+      }
+    options.merge!(basic_auth: @auth, headers: @headers)
+    options.merge!(:body => parameters.to_json, :headers => {'Content-Type' => 'application/json'})
+    post = self.class.post(base_api_endpoint("Web/Session/#{session_key}/Login/External"), options)
+    post.success?
+  end
+
+  def login_with_token(email, login_type_id, token, promotion, session_key, options={})
+    parameters =
+      {
+        'EmailAddress': email,
+        'ForgotLoginToken': token,
+        'LoginTypeId': login_type_id,
+        'PromotionCode': promotion
+      }
+    options.merge!(basic_auth: @auth, headers: @headers)
+    options.merge!(:body => parameters.to_json, :headers => {'Content-Type' => 'application/json'})
+    post = self.class.post(base_api_endpoint("Web/Session/#{session_key}/Login/Token"), options)
+    post['IsLoggedIn']
+  end
+
+  def logout(session_key, options={})
+    options.merge!(basic_auth: @auth, headers: @headers)
+    options.merge!(:body => {}, :headers => {'Content-Type' => 'application/json'})
+    self.class.post(base_api_endpoint("/Web/Session/#{session_key}/Logout"), options)
+  end
+end

data/lib/tessitura_rest/web/payment_plan_extension.rb

@@ -0,0 +1,51 @@
+module PaymentPlanExtension
+
+  def add_billing_payment_plan(session_key, billing_id, billing_type_id, name, number, month, year, start_date=nil, end_date=nil, options={})
+    parameters =
+      {
+          'BillingScheduleId': billing_id,
+          'BillingTypeId': billing_type_id,
+          'StartDate': start_date,
+          'EndDate': end_date,
+          "Card": {
+            "Name": name,
+            "Number": number,
+            "ExpiryMonth": month,
+            "ExpiryYear": year
+          }
+      }
+    options.merge!(basic_auth: @auth, headers: @headers)
+    options.merge!(:body => parameters)
+    response = self.class.post(base_api_endpoint("Web/Cart/#{session_key}/Payments/Plan/Schedule"), options)
+    JSON.parse(response.body)
+  end
+
+  def preview_billing_payment_plan(session_key, billing_id, start_date=nil, end_date=nil, options={})
+    parameters =
+      {
+          'BillingScheduleId': billing_id,
+          'StartDate': start_date,
+          'EndDate': end_date
+      }
+    options.merge!(basic_auth: @auth, headers: @headers)
+    options.merge!(:body => parameters)
+    response = self.class.post(base_api_endpoint("Web/Cart/#{session_key}/Payments/Plan/Schedule/Preview"), options)
+    JSON.parse(response.body)
+  end
+
+  def validate_payment_plan(session_key, options={})
+    parameters =
+      {
+          'ValidatePaymentPlan': true
+      }
+    options.merge!(basic_auth: @auth, headers: @headers)
+    options.merge!(:body => parameters)
+    response = self.class.post(base_api_endpoint("Web/Cart/#{session_key}/Validate"), options)
+    JSON.parse(response.body)
+  end
+
+  def remove_payment_plan(session_key, options={})
+    options.merge!(basic_auth: @auth, headers: @headers)
+    self.class.delete(base_api_endpoint("Web/Cart/#{session_key}/Payments/Plan"), options)
+  end
+end

data/lib/tessitura_rest/web/session.rb

@@ -0,0 +1,85 @@
+module Session
+
+  def get_session(key, options={})
+    options.merge!(basic_auth: @auth, headers: @headers)
+    response = self.class.get(base_api_endpoint("Web/Session/#{key}"), options)
+    JSON.parse(response.body)
+  end
+
+  def create_session(ip, options={})
+    parameters =
+      {
+        'IpAddress': ip,
+        'Organization': 'Tessitura Web'
+      }
+    options.merge!(basic_auth: @auth, headers: @headers)
+    options.merge!(body: parameters)
+    response = self.class.post(base_api_endpoint('Web/Session'), options)
+    JSON.parse(response.body)
+  end
+
+  def get_expiration(key, options={})
+    options.merge!(basic_auth: @auth, headers: @headers)
+    response = self.class.get(base_api_endpoint("Web/Session/#{key}/Expiration"), options)
+    JSON.parse(response.body)
+  end
+
+  def get_variables(key, options={})
+    options.merge!(basic_auth: @auth, headers: @headers)
+    response = self.class.get(base_api_endpoint("Web/Session/#{key}/Variables"), options)
+    JSON.parse(response.body)
+  end
+
+  def set_expiration(key, timeoffset, expiration, options={})
+    parameters =
+    {
+      'Expiration': expiration,
+      'TimeOffset': timeoffset
+    }
+    options.merge!(basic_auth: @auth, headers: @headers)
+    options.merge!(:body => parameters)
+    response = self.class.put(base_api_endpoint("Web/Session/#{key}/Expiration"), options)
+    JSON.parse(response.body)
+  end
+
+  def load_existing_order(key, order_id, options={})
+    options.merge!(basic_auth: @auth, headers: @headers)
+    self.class.post(base_api_endpoint("Web/Session/#{key}/LoadOrder/#{order_id}"), options)
+  end
+
+  def get_promotion(key, code, code_string, options={})
+    parameters =
+      {
+        'PromoCode': code,
+        'PromoCodeString': code_string
+      }
+    options.merge!(basic_auth: @auth, headers: @headers)
+    options.merge!(:body => parameters)
+    response = self.class.post(base_api_endpoint("Web/Session/#{key}/PromoCode"), options)
+    JSON.parse(response.body)
+  end
+
+  def get_renewals(key, season_id, renewal, mode_of_sale, options={})
+    options.merge!(basic_auth: @auth, headers: @headers)
+    response = self.class.get(base_api_endpoint("Web/Session/#{key}/Orders/Search?seasonId=#{season_id}&renewalsOnly=#{renewal}&modeOfSaleId=#{mode_of_sale}"), options)
+    JSON.parse(response.body)
+  end
+
+  def send_credentials(key, email, login_type, template_id, options={})
+    parameters =
+    {
+      'TemplateFormatId': template_id,
+      'LoginTypeId': login_type,
+      'EmailAddress': email
+    }
+    options.merge!(basic_auth: @auth, headers: @headers)
+    options.merge!(:body => parameters)
+    self.class.post(base_api_endpoint("/Web/Session/#{key}/Login/SendCredentials"), options)
+  end
+
+  def get_shipping_methods(key, options={})
+    options.merge!(basic_auth: @auth, headers: @headers)
+    response = self.class.get(base_api_endpoint("Web/Session/#{key}/DeliveryMethods"), options)
+    JSON.parse(response.body)
+  end
+end