onsite_edp_sdk ============== .. py:module:: onsite_edp_sdk .. autoapi-nested-parse:: ShopWorks OnSite EDP generation. Submodules ---------- .. toctree:: :maxdepth: 1 /autoapi/onsite_edp_sdk/models/index Classes ------- .. autoapisummary:: onsite_edp_sdk.Contact onsite_edp_sdk.Customer onsite_edp_sdk.Design onsite_edp_sdk.DesignLocation onsite_edp_sdk.EDPDocument onsite_edp_sdk.Order onsite_edp_sdk.Payment onsite_edp_sdk.Product Package Contents ---------------- .. py:class:: Contact(/, **data: Any) Bases: :py:obj:`BaseModel` Contact Block. .. py:attribute:: first_name :type: str | None :value: None .. py:attribute:: last_name :type: str | None :value: None .. py:attribute:: department :type: str | None :value: None .. py:attribute:: title :type: str | None :value: None .. py:attribute:: phone :type: str | None :value: None .. py:attribute:: fax :type: str | None :value: None .. py:attribute:: email :type: str | None :value: None .. py:attribute:: status_enable_bulk_email :type: IntBool | None :value: None .. py:attribute:: status_contact_add :type: IntBool | None :value: None .. py:class:: Customer(/, **data: Any) Bases: :py:obj:`BaseModel` Customer Block. .. py:attribute:: external_customer_id :type: str | None :value: None .. py:attribute:: customer_id :type: int | None :value: None .. py:attribute:: company :type: str | None :value: None .. py:attribute:: company_location_id :type: int | None :value: None .. py:attribute:: terms :type: str | None :value: None .. py:attribute:: website_url :type: str | None :value: None .. py:attribute:: email_main :type: str | None :value: None .. py:attribute:: address_description :type: str | None :value: None .. py:attribute:: address_company :type: str | None :value: None .. py:attribute:: address1 :type: str | None :value: None .. py:attribute:: address2 :type: str | None :value: None .. py:attribute:: address_city :type: str | None :value: None .. py:attribute:: address_state :type: str | None :value: None .. py:attribute:: address_zip :type: str | None :value: None .. py:attribute:: address_country :type: str | None :value: None .. py:attribute:: sts_apply_sales_tax_1 :type: IntBool | None :value: None .. py:attribute:: sts_apply_sales_tax_2 :type: IntBool | None :value: None .. py:attribute:: sts_apply_sales_tax_3 :type: IntBool | None :value: None .. py:attribute:: sts_apply_sales_tax_4 :type: IntBool | None :value: None .. py:attribute:: coa_account_sale_tax_1 :type: str | None :value: None .. py:attribute:: coa_account_sale_tax_2 :type: str | None :value: None .. py:attribute:: coa_account_sale_tax_3 :type: str | None :value: None .. py:attribute:: coa_account_sale_tax_4 :type: str | None :value: None .. py:attribute:: tax_exempt_number :type: str | None :value: None .. py:attribute:: discount_level_id :type: int | None :value: None .. py:attribute:: default_calculator_1_id :type: str | None :value: None .. py:attribute:: default_calculator_2_id :type: str | None :value: None .. py:attribute:: customer_server_rep :type: str | None :value: None .. py:attribute:: customer_type :type: str | None :value: None .. py:attribute:: customer_source :type: str | None :value: None .. py:attribute:: reference_from :type: str | None :value: None .. py:attribute:: sic_code :type: str | None :value: None .. py:attribute:: sic_description :type: str | None :value: None .. py:attribute:: employee_count :type: int | None :value: None .. py:attribute:: custom_field_1 :type: str | None :value: None .. py:attribute:: custom_field_2 :type: str | None :value: None .. py:attribute:: custom_field_3 :type: str | None :value: None .. py:attribute:: custom_field_4 :type: str | None :value: None .. py:attribute:: custom_field_5 :type: str | None :value: None .. py:attribute:: custom_field_6 :type: str | None :value: None .. py:attribute:: custom_field_7 :type: Date | None :value: None .. py:attribute:: custom_field_8 :type: Date | None :value: None .. py:attribute:: custom_field_9 :type: Date | None :value: None .. py:attribute:: custom_field_10 :type: Date | None :value: None .. py:class:: Design(/, **data: Any) Bases: :py:obj:`BaseModel` Design Block. .. py:attribute:: external_design_id :type: str | None :value: None .. py:attribute:: design_id :type: int | None :value: None .. py:attribute:: design_type_id :type: int | None :value: None .. py:attribute:: design_name :type: str | None :value: None .. py:class:: DesignLocation(/, **data: Any) Bases: :py:obj:`BaseModel` Design Location Block. .. py:attribute:: location :type: str :value: None .. py:attribute:: total_colors :type: int | None :value: None .. py:attribute:: total_flashes :type: int | None :value: None .. py:attribute:: total_stitches :type: int | None :value: None .. py:attribute:: design_code :type: str | None :value: None .. py:attribute:: color :type: str | None :value: None .. py:attribute:: map :type: str | None :value: None .. py:class:: EDPDocument(/, **data: Any) Bases: :py:obj:`BaseModel` EDP Document. .. py:attribute:: order :type: Order .. py:attribute:: customer :type: Customer .. py:attribute:: contact :type: Contact | None :value: None .. py:attribute:: designs :type: list[tuple[Design, list[DesignLocation]]] | None :value: None .. py:attribute:: products :type: list[Product] | None :value: None .. py:attribute:: payment :type: Payment | None :value: None .. py:method:: to_edp(tag_bracket: str = '----', data_separator: str = ': ', carriage_return: str = '') -> str Serialize to EDP format. .. py:class:: Order(/, **data: Any) Bases: :py:obj:`BaseModel` Order Block. .. py:attribute:: external_order_id :type: str :value: None .. py:attribute:: external_source :type: str | None :value: None .. py:attribute:: date_external :type: Date | None :value: None .. py:attribute:: order_type_id :type: float :value: None .. py:attribute:: customer_purchase_order :type: str | None :value: None .. py:attribute:: terms_name :type: str | None :value: None .. py:attribute:: customer_service_rep :type: str | None :value: None .. py:attribute:: customer_type :type: str | None :value: None .. py:attribute:: company_location_id :type: int | None :value: None .. py:attribute:: sales_status_id :type: int | None :value: None .. py:attribute:: status_allow_commission :type: IntBool | None :value: None .. py:attribute:: on_hold :type: YesNoBool | None :value: None .. py:attribute:: date_order_placed :type: Date :value: None .. py:attribute:: date_order_requested_to_ship :type: Date | None :value: None .. py:attribute:: date_order_drop_dead :type: Date | None :value: None .. py:attribute:: status_order_sales_tax_override :type: IntBool | None :value: None .. py:attribute:: status_apply_sales_tax_1 :type: IntBool | None :value: None .. py:attribute:: status_apply_sales_tax_2 :type: IntBool | None :value: None .. py:attribute:: status_apply_sales_tax_3 :type: IntBool | None :value: None .. py:attribute:: status_apply_sales_tax_4 :type: IntBool | None :value: None .. py:attribute:: coa_account_sales_tax_1 :type: IntBool | None :value: None .. py:attribute:: coa_account_sales_tax_2 :type: IntBool | None :value: None .. py:attribute:: coa_account_sales_tax_3 :type: IntBool | None :value: None .. py:attribute:: coa_account_sales_tax_4 :type: IntBool | None :value: None .. py:attribute:: status_shipping_taxable :type: IntBool | None :value: None .. py:attribute:: address_description :type: str | None :value: None .. py:attribute:: address_company :type: str | None :value: None .. py:attribute:: address1 :type: str | None :value: None .. py:attribute:: address2 :type: str | None :value: None .. py:attribute:: address_city :type: str | None :value: None .. py:attribute:: address_state :type: str | None :value: None .. py:attribute:: address_zip :type: str | None :value: None .. py:attribute:: address_country :type: str | None :value: None .. py:attribute:: ship_method :type: str | None :value: None .. py:attribute:: status_shipping_taxable_field :type: IntBool | None :value: None .. py:attribute:: cur_shipping :type: float | None :value: None .. py:attribute:: status_order_shipping_address_add :type: IntBool | None :value: None .. py:attribute:: notes_to_art :type: str | None :value: None .. py:attribute:: notes_to_production :type: str | None :value: None .. py:attribute:: notes_to_receiving :type: str | None :value: None .. py:attribute:: notes_to_purchasing :type: str | None :value: None .. py:attribute:: notes_to_shipping :type: str | None :value: None .. py:attribute:: notes_to_accounting :type: str | None :value: None .. py:attribute:: notes_to_purchasing_sub :type: str | None :value: None .. py:class:: Payment(/, **data: Any) Bases: :py:obj:`BaseModel` Payment Block. .. py:attribute:: date_payment :type: Date :value: None .. py:attribute:: cur_payment :type: float | None :value: None .. py:attribute:: payment_type :type: str | None :value: None .. py:attribute:: payment_number :type: str | None :value: None .. py:attribute:: card_name_first :type: str | None :value: None .. py:attribute:: card_name_last :type: str | None :value: None .. py:attribute:: card_expiration_date :type: str | None :value: None .. py:attribute:: notes :type: str | None :value: None .. py:class:: Product(/, **data: Any) Bases: :py:obj:`BaseModel` Product Block. .. py:attribute:: part_number :type: str :value: None .. py:attribute:: part_color_range :type: str | None :value: None .. py:attribute:: part_color :type: str | None :value: None .. py:attribute:: part_description :type: str | None :value: None .. py:attribute:: cur_unit_price_user_entered :type: float | None :value: None .. py:attribute:: order_instructions :type: str | None :value: None .. py:attribute:: size1_required :type: int | None :value: None .. py:attribute:: size2_required :type: int | None :value: None .. py:attribute:: size3_required :type: int | None :value: None .. py:attribute:: size4_required :type: int | None :value: None .. py:attribute:: size5_required :type: int | None :value: None .. py:attribute:: size6_required :type: int | None :value: None .. py:attribute:: status_production_product_override :type: IntBool | None :value: None .. py:attribute:: cur_unit_cost :type: float | None :value: None .. py:attribute:: status_enable_commission :type: IntBool | None :value: None .. py:attribute:: product_class_id :type: int | None :value: None .. py:attribute:: status_production_sales_tax_override :type: IntBool | None :value: None .. py:attribute:: status_enable_tax_1 :type: IntBool | None :value: None .. py:attribute:: status_enable_tax_2 :type: IntBool | None :value: None .. py:attribute:: status_enable_tax_3 :type: IntBool | None :value: None .. py:attribute:: status_enable_tax_4 :type: IntBool | None :value: None .. py:attribute:: status_production_secondary_units_override :type: IntBool | None :value: None .. py:attribute:: status_use_secondary_units :type: IntBool | None :value: None .. py:attribute:: units_quantity :type: int | None :value: None .. py:attribute:: units_type :type: Literal['Linear Feet', 'Linear Inches', 'Linear Centimeters', 'Linear Meters', 'Linear Yards', 'Square Feet', 'Square Inches', 'Square Yards', 'Square Meters', 'Square Centimeters', 'Units', 'Pieces', 'Count'] | None :value: None .. py:attribute:: units_area1 :type: int | None :value: None .. py:attribute:: units_area2 :type: int | None :value: None .. py:attribute:: status_units_pricing :type: IntBool | None :value: None .. py:attribute:: status_units_purchasing :type: IntBool | None :value: None .. py:attribute:: status_units_purchasing_extra_percent :type: float | None :value: None .. py:attribute:: status_units_purchasing_extra_round :type: Literal[1] | None :value: None .. py:attribute:: status_production_behavior_override :type: IntBool | None :value: None .. py:attribute:: status_product_source_supplied :type: IntBool | None :value: None .. py:attribute:: status_product_source_purchase :type: IntBool | None :value: None .. py:attribute:: status_product_source_inventory :type: IntBool | None :value: None .. py:attribute:: status_production_designs :type: IntBool | None :value: None .. py:attribute:: status_production_subcontract :type: IntBool | None :value: None .. py:attribute:: status_production_components :type: IntBool | None :value: None .. py:attribute:: status_storage_ship :type: IntBool | None :value: None .. py:attribute:: status_storage_inventory :type: IntBool | None :value: None .. py:attribute:: status_invoicing_invoice :type: IntBool | None :value: None