diff --git a/.mock/definition/accounting/__package__.yml b/.mock/definition/accounting/__package__.yml index 3a198d77..5aed4bae 100644 --- a/.mock/definition/accounting/__package__.yml +++ b/.mock/definition/accounting/__package__.yml @@ -11176,6 +11176,26 @@ types: source: openapi: openapi/openapi.yml inline: true + CompanyInfoAddressesItem: + discriminated: false + union: + - type: string + validation: + format: uuid + - Address + source: + openapi: openapi/openapi.yml + inline: true + CompanyInfoPhoneNumbersItem: + discriminated: false + union: + - type: string + validation: + format: uuid + - AccountingPhoneNumber + source: + openapi: openapi/openapi.yml + inline: true CompanyInfo: docs: >- # The CompanyInfo Object @@ -11853,8 +11873,8 @@ types: urls: type: optional>> docs: The company's urls. - addresses: optional> - phone_numbers: optional> + addresses: optional> + phone_numbers: optional> remote_was_deleted: type: optional docs: >- @@ -14362,7 +14382,7 @@ types: - type: string validation: format: uuid - - Contact + - Project source: openapi: openapi/openapi.yml inline: true @@ -14485,7 +14505,7 @@ types: - type: string validation: format: uuid - - CreditNoteLineItemRequest + - CreditNoteLineItem source: openapi: openapi/openapi.yml inline: true @@ -15891,6 +15911,14 @@ types: source: openapi: openapi/openapi.yml inline: true + DataPassthroughRequestRequestFormat: + discriminated: false + union: + - RequestFormatEnum + - string + source: + openapi: openapi/openapi.yml + inline: true DataPassthroughRequest: docs: >- # The DataPassthrough Object @@ -15936,7 +15964,7 @@ types: authorization headers). `Content-Type` header is required for passthrough. Choose content type corresponding to expected format of receiving server. - request_format: optional + request_format: optional normalize_response: type: optional docs: >- @@ -19738,7 +19766,7 @@ types: - type: string validation: format: uuid - - Contact + - Project source: openapi: openapi/openapi.yml inline: true @@ -20423,6 +20451,19 @@ types: access: write-only source: openapi: openapi/openapi.yml + ExpenseReportEmployee: + discriminated: false + docs: >- + Identifier for the employee who submitted or is associated with the + expense report + union: + - type: string + validation: + format: uuid + - Employee + source: + openapi: openapi/openapi.yml + inline: true ExpenseReportStatus: discriminated: false docs: >- @@ -20443,751 +20484,3412 @@ types: source: openapi: openapi/openapi.yml inline: true - ExpenseReportCompany: + ExpenseReportCurrency: discriminated: false - docs: The subsidiary that the expense report is created in - union: - - type: string - validation: - format: uuid - - CompanyInfo - source: - openapi: openapi/openapi.yml - inline: true - ExpenseReport: docs: >- - # The ExpenseReport Object + Currency code for the expense report - ### Description - The `ExpenseReport` object represents a collection of expenses submitted - for review and reimbursement. + * `XUA` - ADB Unit of Account - It includes details about the submitter, status, amounts, and associated - metadata. + * `AFN` - Afghan Afghani + * `AFA` - Afghan Afghani (1927–2002) - ### Usage Example + * `ALL` - Albanian Lek - Fetch from the `GET ExpenseReport` endpoint to view details of expense - reports and their line items. - properties: - id: - type: optional - validation: - format: uuid - access: read-only - remote_id: - type: optional - docs: The third-party API ID of the matching object. - created_at: - type: optional - docs: The datetime that this object was created by Merge. - access: read-only - modified_at: - type: optional - docs: The datetime that this object was modified by Merge. - access: read-only - report_date: - type: optional - docs: The date of the expense report. - report_identifier: - type: optional - docs: Human-readable expense report identifier. - validation: - maxLength: 1024 - employee: - type: optional - docs: >- - Identifier for the employee who submitted or is associated with the - expense report - validation: - format: uuid - status: - type: optional - docs: >- - Overall status of the expense report. One of DRAFT, SUBMITTED, - APPROVED, REJECTED + * `ALK` - Albanian Lek (1946–1965) + * `DZD` - Algerian Dinar - * `DRAFT` - DRAFT + * `ADP` - Andorran Peseta - * `SUBMITTED` - SUBMITTED + * `AOA` - Angolan Kwanza - * `APPROVED` - APPROVED + * `AOK` - Angolan Kwanza (1977–1991) - * `REJECTED` - REJECTED - total_amount: - type: optional - docs: Total amount of the expense report - lines: - type: optional> - access: read-only - currency: - type: optional - docs: >- - Currency code for the expense report + * `AON` - Angolan New Kwanza (1990–2000) + * `AOR` - Angolan Readjusted Kwanza (1995–1999) - * `XUA` - ADB Unit of Account + * `ARA` - Argentine Austral - * `AFN` - Afghan Afghani + * `ARS` - Argentine Peso - * `AFA` - Afghan Afghani (1927–2002) + * `ARM` - Argentine Peso (1881–1970) - * `ALL` - Albanian Lek + * `ARP` - Argentine Peso (1983–1985) - * `ALK` - Albanian Lek (1946–1965) + * `ARL` - Argentine Peso Ley (1970–1983) - * `DZD` - Algerian Dinar + * `AMD` - Armenian Dram - * `ADP` - Andorran Peseta + * `AWG` - Aruban Florin - * `AOA` - Angolan Kwanza + * `AUD` - Australian Dollar - * `AOK` - Angolan Kwanza (1977–1991) + * `ATS` - Austrian Schilling - * `AON` - Angolan New Kwanza (1990–2000) + * `AZN` - Azerbaijani Manat - * `AOR` - Angolan Readjusted Kwanza (1995–1999) + * `AZM` - Azerbaijani Manat (1993–2006) - * `ARA` - Argentine Austral + * `BSD` - Bahamian Dollar - * `ARS` - Argentine Peso + * `BHD` - Bahraini Dinar - * `ARM` - Argentine Peso (1881–1970) + * `BDT` - Bangladeshi Taka - * `ARP` - Argentine Peso (1983–1985) + * `BBD` - Barbadian Dollar - * `ARL` - Argentine Peso Ley (1970–1983) + * `BYN` - Belarusian Ruble - * `AMD` - Armenian Dram + * `BYB` - Belarusian Ruble (1994–1999) - * `AWG` - Aruban Florin + * `BYR` - Belarusian Ruble (2000–2016) - * `AUD` - Australian Dollar + * `BEF` - Belgian Franc - * `ATS` - Austrian Schilling + * `BEC` - Belgian Franc (convertible) - * `AZN` - Azerbaijani Manat + * `BEL` - Belgian Franc (financial) - * `AZM` - Azerbaijani Manat (1993–2006) + * `BZD` - Belize Dollar - * `BSD` - Bahamian Dollar + * `BMD` - Bermudan Dollar - * `BHD` - Bahraini Dinar + * `BTN` - Bhutanese Ngultrum - * `BDT` - Bangladeshi Taka + * `BOB` - Bolivian Boliviano - * `BBD` - Barbadian Dollar + * `BOL` - Bolivian Boliviano (1863–1963) - * `BYN` - Belarusian Ruble + * `BOV` - Bolivian Mvdol - * `BYB` - Belarusian Ruble (1994–1999) + * `BOP` - Bolivian Peso - * `BYR` - Belarusian Ruble (2000–2016) + * `BAM` - Bosnia-Herzegovina Convertible Mark - * `BEF` - Belgian Franc + * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) - * `BEC` - Belgian Franc (convertible) + * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) - * `BEL` - Belgian Franc (financial) + * `BWP` - Botswanan Pula - * `BZD` - Belize Dollar + * `BRC` - Brazilian Cruzado (1986–1989) - * `BMD` - Bermudan Dollar + * `BRZ` - Brazilian Cruzeiro (1942–1967) - * `BTN` - Bhutanese Ngultrum + * `BRE` - Brazilian Cruzeiro (1990–1993) - * `BOB` - Bolivian Boliviano + * `BRR` - Brazilian Cruzeiro (1993–1994) - * `BOL` - Bolivian Boliviano (1863–1963) + * `BRN` - Brazilian New Cruzado (1989–1990) - * `BOV` - Bolivian Mvdol + * `BRB` - Brazilian New Cruzeiro (1967–1986) - * `BOP` - Bolivian Peso + * `BRL` - Brazilian Real - * `BAM` - Bosnia-Herzegovina Convertible Mark + * `GBP` - British Pound - * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) + * `BND` - Brunei Dollar - * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) + * `BGL` - Bulgarian Hard Lev - * `BWP` - Botswanan Pula + * `BGN` - Bulgarian Lev - * `BRC` - Brazilian Cruzado (1986–1989) + * `BGO` - Bulgarian Lev (1879–1952) - * `BRZ` - Brazilian Cruzeiro (1942–1967) + * `BGM` - Bulgarian Socialist Lev - * `BRE` - Brazilian Cruzeiro (1990–1993) + * `BUK` - Burmese Kyat - * `BRR` - Brazilian Cruzeiro (1993–1994) + * `BIF` - Burundian Franc - * `BRN` - Brazilian New Cruzado (1989–1990) + * `XPF` - CFP Franc - * `BRB` - Brazilian New Cruzeiro (1967–1986) + * `KHR` - Cambodian Riel - * `BRL` - Brazilian Real + * `CAD` - Canadian Dollar - * `GBP` - British Pound + * `CVE` - Cape Verdean Escudo - * `BND` - Brunei Dollar + * `KYD` - Cayman Islands Dollar - * `BGL` - Bulgarian Hard Lev + * `XAF` - Central African CFA Franc - * `BGN` - Bulgarian Lev + * `CLE` - Chilean Escudo - * `BGO` - Bulgarian Lev (1879–1952) + * `CLP` - Chilean Peso - * `BGM` - Bulgarian Socialist Lev + * `CLF` - Chilean Unit of Account (UF) - * `BUK` - Burmese Kyat + * `CNX` - Chinese People’s Bank Dollar - * `BIF` - Burundian Franc + * `CNY` - Chinese Yuan - * `XPF` - CFP Franc + * `CNH` - Chinese Yuan (offshore) - * `KHR` - Cambodian Riel + * `COP` - Colombian Peso - * `CAD` - Canadian Dollar + * `COU` - Colombian Real Value Unit - * `CVE` - Cape Verdean Escudo + * `KMF` - Comorian Franc - * `KYD` - Cayman Islands Dollar + * `CDF` - Congolese Franc - * `XAF` - Central African CFA Franc + * `CRC` - Costa Rican Colón - * `CLE` - Chilean Escudo + * `HRD` - Croatian Dinar - * `CLP` - Chilean Peso + * `HRK` - Croatian Kuna - * `CLF` - Chilean Unit of Account (UF) + * `CUC` - Cuban Convertible Peso - * `CNX` - Chinese People’s Bank Dollar + * `CUP` - Cuban Peso - * `CNY` - Chinese Yuan + * `CYP` - Cypriot Pound - * `CNH` - Chinese Yuan (offshore) + * `CZK` - Czech Koruna - * `COP` - Colombian Peso + * `CSK` - Czechoslovak Hard Koruna - * `COU` - Colombian Real Value Unit + * `DKK` - Danish Krone - * `KMF` - Comorian Franc + * `DJF` - Djiboutian Franc - * `CDF` - Congolese Franc + * `DOP` - Dominican Peso - * `CRC` - Costa Rican Colón + * `NLG` - Dutch Guilder - * `HRD` - Croatian Dinar + * `XCD` - East Caribbean Dollar - * `HRK` - Croatian Kuna + * `DDM` - East German Mark - * `CUC` - Cuban Convertible Peso + * `ECS` - Ecuadorian Sucre - * `CUP` - Cuban Peso + * `ECV` - Ecuadorian Unit of Constant Value - * `CYP` - Cypriot Pound + * `EGP` - Egyptian Pound - * `CZK` - Czech Koruna + * `GQE` - Equatorial Guinean Ekwele - * `CSK` - Czechoslovak Hard Koruna + * `ERN` - Eritrean Nakfa - * `DKK` - Danish Krone + * `EEK` - Estonian Kroon - * `DJF` - Djiboutian Franc + * `ETB` - Ethiopian Birr - * `DOP` - Dominican Peso + * `EUR` - Euro - * `NLG` - Dutch Guilder + * `XBA` - European Composite Unit - * `XCD` - East Caribbean Dollar + * `XEU` - European Currency Unit - * `DDM` - East German Mark + * `XBB` - European Monetary Unit - * `ECS` - Ecuadorian Sucre + * `XBC` - European Unit of Account (XBC) - * `ECV` - Ecuadorian Unit of Constant Value + * `XBD` - European Unit of Account (XBD) - * `EGP` - Egyptian Pound + * `FKP` - Falkland Islands Pound - * `GQE` - Equatorial Guinean Ekwele + * `FJD` - Fijian Dollar - * `ERN` - Eritrean Nakfa + * `FIM` - Finnish Markka - * `EEK` - Estonian Kroon + * `FRF` - French Franc - * `ETB` - Ethiopian Birr + * `XFO` - French Gold Franc - * `EUR` - Euro + * `XFU` - French UIC-Franc - * `XBA` - European Composite Unit + * `GMD` - Gambian Dalasi - * `XEU` - European Currency Unit + * `GEK` - Georgian Kupon Larit - * `XBB` - European Monetary Unit + * `GEL` - Georgian Lari - * `XBC` - European Unit of Account (XBC) + * `DEM` - German Mark - * `XBD` - European Unit of Account (XBD) + * `GHS` - Ghanaian Cedi - * `FKP` - Falkland Islands Pound + * `GHC` - Ghanaian Cedi (1979–2007) - * `FJD` - Fijian Dollar + * `GIP` - Gibraltar Pound - * `FIM` - Finnish Markka + * `XAU` - Gold - * `FRF` - French Franc + * `GRD` - Greek Drachma - * `XFO` - French Gold Franc + * `GTQ` - Guatemalan Quetzal - * `XFU` - French UIC-Franc + * `GWP` - Guinea-Bissau Peso - * `GMD` - Gambian Dalasi + * `GNF` - Guinean Franc - * `GEK` - Georgian Kupon Larit + * `GNS` - Guinean Syli - * `GEL` - Georgian Lari + * `GYD` - Guyanaese Dollar - * `DEM` - German Mark + * `HTG` - Haitian Gourde - * `GHS` - Ghanaian Cedi + * `HNL` - Honduran Lempira - * `GHC` - Ghanaian Cedi (1979–2007) + * `HKD` - Hong Kong Dollar - * `GIP` - Gibraltar Pound + * `HUF` - Hungarian Forint - * `XAU` - Gold + * `IMP` - IMP - * `GRD` - Greek Drachma + * `ISK` - Icelandic Króna - * `GTQ` - Guatemalan Quetzal + * `ISJ` - Icelandic Króna (1918–1981) - * `GWP` - Guinea-Bissau Peso + * `INR` - Indian Rupee - * `GNF` - Guinean Franc + * `IDR` - Indonesian Rupiah - * `GNS` - Guinean Syli + * `IRR` - Iranian Rial - * `GYD` - Guyanaese Dollar + * `IQD` - Iraqi Dinar - * `HTG` - Haitian Gourde + * `IEP` - Irish Pound - * `HNL` - Honduran Lempira + * `ILS` - Israeli New Shekel - * `HKD` - Hong Kong Dollar + * `ILP` - Israeli Pound - * `HUF` - Hungarian Forint + * `ILR` - Israeli Shekel (1980–1985) - * `IMP` - IMP + * `ITL` - Italian Lira - * `ISK` - Icelandic Króna + * `JMD` - Jamaican Dollar - * `ISJ` - Icelandic Króna (1918–1981) + * `JPY` - Japanese Yen - * `INR` - Indian Rupee + * `JOD` - Jordanian Dinar - * `IDR` - Indonesian Rupiah + * `KZT` - Kazakhstani Tenge - * `IRR` - Iranian Rial + * `KES` - Kenyan Shilling - * `IQD` - Iraqi Dinar + * `KWD` - Kuwaiti Dinar - * `IEP` - Irish Pound + * `KGS` - Kyrgystani Som - * `ILS` - Israeli New Shekel + * `LAK` - Laotian Kip - * `ILP` - Israeli Pound + * `LVL` - Latvian Lats - * `ILR` - Israeli Shekel (1980–1985) + * `LVR` - Latvian Ruble - * `ITL` - Italian Lira + * `LBP` - Lebanese Pound - * `JMD` - Jamaican Dollar + * `LSL` - Lesotho Loti - * `JPY` - Japanese Yen + * `LRD` - Liberian Dollar - * `JOD` - Jordanian Dinar + * `LYD` - Libyan Dinar - * `KZT` - Kazakhstani Tenge + * `LTL` - Lithuanian Litas - * `KES` - Kenyan Shilling + * `LTT` - Lithuanian Talonas - * `KWD` - Kuwaiti Dinar + * `LUL` - Luxembourg Financial Franc - * `KGS` - Kyrgystani Som + * `LUC` - Luxembourgian Convertible Franc - * `LAK` - Laotian Kip + * `LUF` - Luxembourgian Franc - * `LVL` - Latvian Lats + * `MOP` - Macanese Pataca - * `LVR` - Latvian Ruble + * `MKD` - Macedonian Denar - * `LBP` - Lebanese Pound + * `MKN` - Macedonian Denar (1992–1993) - * `LSL` - Lesotho Loti + * `MGA` - Malagasy Ariary - * `LRD` - Liberian Dollar + * `MGF` - Malagasy Franc - * `LYD` - Libyan Dinar + * `MWK` - Malawian Kwacha - * `LTL` - Lithuanian Litas + * `MYR` - Malaysian Ringgit - * `LTT` - Lithuanian Talonas + * `MVR` - Maldivian Rufiyaa - * `LUL` - Luxembourg Financial Franc + * `MVP` - Maldivian Rupee (1947–1981) - * `LUC` - Luxembourgian Convertible Franc + * `MLF` - Malian Franc - * `LUF` - Luxembourgian Franc + * `MTL` - Maltese Lira - * `MOP` - Macanese Pataca + * `MTP` - Maltese Pound - * `MKD` - Macedonian Denar + * `MRU` - Mauritanian Ouguiya - * `MKN` - Macedonian Denar (1992–1993) + * `MRO` - Mauritanian Ouguiya (1973–2017) - * `MGA` - Malagasy Ariary + * `MUR` - Mauritian Rupee - * `MGF` - Malagasy Franc + * `MXV` - Mexican Investment Unit - * `MWK` - Malawian Kwacha + * `MXN` - Mexican Peso - * `MYR` - Malaysian Ringgit + * `MXP` - Mexican Silver Peso (1861–1992) - * `MVR` - Maldivian Rufiyaa + * `MDC` - Moldovan Cupon - * `MVP` - Maldivian Rupee (1947–1981) + * `MDL` - Moldovan Leu - * `MLF` - Malian Franc + * `MCF` - Monegasque Franc - * `MTL` - Maltese Lira + * `MNT` - Mongolian Tugrik - * `MTP` - Maltese Pound + * `MAD` - Moroccan Dirham - * `MRU` - Mauritanian Ouguiya + * `MAF` - Moroccan Franc - * `MRO` - Mauritanian Ouguiya (1973–2017) + * `MZE` - Mozambican Escudo - * `MUR` - Mauritian Rupee + * `MZN` - Mozambican Metical - * `MXV` - Mexican Investment Unit + * `MZM` - Mozambican Metical (1980–2006) - * `MXN` - Mexican Peso + * `MMK` - Myanmar Kyat - * `MXP` - Mexican Silver Peso (1861–1992) + * `NAD` - Namibian Dollar - * `MDC` - Moldovan Cupon + * `NPR` - Nepalese Rupee - * `MDL` - Moldovan Leu + * `ANG` - Netherlands Antillean Guilder - * `MCF` - Monegasque Franc + * `TWD` - New Taiwan Dollar - * `MNT` - Mongolian Tugrik + * `NZD` - New Zealand Dollar - * `MAD` - Moroccan Dirham + * `NIO` - Nicaraguan Córdoba - * `MAF` - Moroccan Franc + * `NIC` - Nicaraguan Córdoba (1988–1991) - * `MZE` - Mozambican Escudo + * `NGN` - Nigerian Naira - * `MZN` - Mozambican Metical + * `KPW` - North Korean Won - * `MZM` - Mozambican Metical (1980–2006) + * `NOK` - Norwegian Krone - * `MMK` - Myanmar Kyat + * `OMR` - Omani Rial - * `NAD` - Namibian Dollar + * `PKR` - Pakistani Rupee - * `NPR` - Nepalese Rupee + * `XPD` - Palladium - * `ANG` - Netherlands Antillean Guilder + * `PAB` - Panamanian Balboa - * `TWD` - New Taiwan Dollar + * `PGK` - Papua New Guinean Kina - * `NZD` - New Zealand Dollar + * `PYG` - Paraguayan Guarani - * `NIO` - Nicaraguan Córdoba + * `PEI` - Peruvian Inti - * `NIC` - Nicaraguan Córdoba (1988–1991) + * `PEN` - Peruvian Sol - * `NGN` - Nigerian Naira + * `PES` - Peruvian Sol (1863–1965) - * `KPW` - North Korean Won + * `PHP` - Philippine Peso - * `NOK` - Norwegian Krone + * `XPT` - Platinum - * `OMR` - Omani Rial + * `PLN` - Polish Zloty - * `PKR` - Pakistani Rupee + * `PLZ` - Polish Zloty (1950–1995) + + * `PTE` - Portuguese Escudo + + * `GWE` - Portuguese Guinea Escudo + + * `QAR` - Qatari Rial + + * `XRE` - RINET Funds + + * `RHD` - Rhodesian Dollar + + * `RON` - Romanian Leu + + * `ROL` - Romanian Leu (1952–2006) + + * `RUB` - Russian Ruble + + * `RUR` - Russian Ruble (1991–1998) + + * `RWF` - Rwandan Franc + + * `SVC` - Salvadoran Colón + + * `WST` - Samoan Tala + + * `SAR` - Saudi Riyal + + * `RSD` - Serbian Dinar + + * `CSD` - Serbian Dinar (2002–2006) + + * `SCR` - Seychellois Rupee + + * `SLL` - Sierra Leonean Leone + + * `XAG` - Silver + + * `SGD` - Singapore Dollar + + * `SKK` - Slovak Koruna + + * `SIT` - Slovenian Tolar + + * `SBD` - Solomon Islands Dollar + + * `SOS` - Somali Shilling + + * `ZAR` - South African Rand + + * `ZAL` - South African Rand (financial) + + * `KRH` - South Korean Hwan (1953–1962) + + * `KRW` - South Korean Won + + * `KRO` - South Korean Won (1945–1953) + + * `SSP` - South Sudanese Pound + + * `SUR` - Soviet Rouble + + * `ESP` - Spanish Peseta + + * `ESA` - Spanish Peseta (A account) + + * `ESB` - Spanish Peseta (convertible account) + + * `XDR` - Special Drawing Rights + + * `LKR` - Sri Lankan Rupee + + * `SHP` - St. Helena Pound + + * `XSU` - Sucre + + * `SDD` - Sudanese Dinar (1992–2007) + + * `SDG` - Sudanese Pound + + * `SDP` - Sudanese Pound (1957–1998) + + * `SRD` - Surinamese Dollar + + * `SRG` - Surinamese Guilder + + * `SZL` - Swazi Lilangeni + + * `SEK` - Swedish Krona + + * `CHF` - Swiss Franc + + * `SYP` - Syrian Pound + + * `STN` - São Tomé & Príncipe Dobra + + * `STD` - São Tomé & Príncipe Dobra (1977–2017) + + * `TVD` - TVD + + * `TJR` - Tajikistani Ruble + + * `TJS` - Tajikistani Somoni + + * `TZS` - Tanzanian Shilling + + * `XTS` - Testing Currency Code + + * `THB` - Thai Baht + + * `XXX` - The codes assigned for transactions where no currency is + involved + + * `TPE` - Timorese Escudo + + * `TOP` - Tongan Paʻanga + + * `TTD` - Trinidad & Tobago Dollar + + * `TND` - Tunisian Dinar + + * `TRY` - Turkish Lira + + * `TRL` - Turkish Lira (1922–2005) + + * `TMT` - Turkmenistani Manat + + * `TMM` - Turkmenistani Manat (1993–2009) + + * `USD` - US Dollar + + * `USN` - US Dollar (Next day) + + * `USS` - US Dollar (Same day) + + * `UGX` - Ugandan Shilling + + * `UGS` - Ugandan Shilling (1966–1987) + + * `UAH` - Ukrainian Hryvnia + + * `UAK` - Ukrainian Karbovanets + + * `AED` - United Arab Emirates Dirham + + * `UYW` - Uruguayan Nominal Wage Index Unit + + * `UYU` - Uruguayan Peso + + * `UYP` - Uruguayan Peso (1975–1993) + + * `UYI` - Uruguayan Peso (Indexed Units) + + * `UZS` - Uzbekistani Som + + * `VUV` - Vanuatu Vatu + + * `VES` - Venezuelan Bolívar + + * `VEB` - Venezuelan Bolívar (1871–2008) + + * `VEF` - Venezuelan Bolívar (2008–2018) + + * `VND` - Vietnamese Dong + + * `VNN` - Vietnamese Dong (1978–1985) + + * `CHE` - WIR Euro + + * `CHW` - WIR Franc + + * `XOF` - West African CFA Franc + + * `YDD` - Yemeni Dinar + + * `YER` - Yemeni Rial + + * `YUN` - Yugoslavian Convertible Dinar (1990–1992) + + * `YUD` - Yugoslavian Hard Dinar (1966–1990) + + * `YUM` - Yugoslavian New Dinar (1994–2002) + + * `YUR` - Yugoslavian Reformed Dinar (1992–1993) + + * `ZWN` - ZWN + + * `ZRN` - Zairean New Zaire (1993–1998) + + * `ZRZ` - Zairean Zaire (1971–1993) + + * `ZMW` - Zambian Kwacha + + * `ZMK` - Zambian Kwacha (1968–2012) + + * `ZWD` - Zimbabwean Dollar (1980–2008) + + * `ZWR` - Zimbabwean Dollar (2008) + + * `ZWL` - Zimbabwean Dollar (2009) + union: + - TransactionCurrencyEnum + - string + source: + openapi: openapi/openapi.yml + inline: true + ExpenseReportAccountingPeriod: + discriminated: false + docs: The accounting period the report was posted in + union: + - type: string + validation: + format: uuid + - AccountingPeriod + source: + openapi: openapi/openapi.yml + inline: true + ExpenseReportCompany: + discriminated: false + docs: The subsidiary that the expense report is created in + union: + - type: string + validation: + format: uuid + - CompanyInfo + source: + openapi: openapi/openapi.yml + inline: true + ExpenseReport: + docs: >- + # The ExpenseReport Object + + ### Description + + The `ExpenseReport` object represents a collection of expenses submitted + for review and reimbursement. + + It includes details about the submitter, status, amounts, and associated + metadata. + + + ### Usage Example + + Fetch from the `GET ExpenseReport` endpoint to view details of expense + reports and their line items. + properties: + id: + type: optional + validation: + format: uuid + access: read-only + remote_id: + type: optional + docs: The third-party API ID of the matching object. + created_at: + type: optional + docs: The datetime that this object was created by Merge. + access: read-only + modified_at: + type: optional + docs: The datetime that this object was modified by Merge. + access: read-only + report_date: + type: optional + docs: The date of the expense report. + report_identifier: + type: optional + docs: Human-readable expense report identifier. + validation: + maxLength: 1024 + employee: + type: optional + docs: >- + Identifier for the employee who submitted or is associated with the + expense report + status: + type: optional + docs: >- + Overall status of the expense report. One of DRAFT, SUBMITTED, + APPROVED, REJECTED + + + * `DRAFT` - DRAFT + + * `SUBMITTED` - SUBMITTED + + * `APPROVED` - APPROVED + + * `REJECTED` - REJECTED + total_amount: + type: optional + docs: Total amount of the expense report + lines: + type: optional> + access: read-only + currency: + type: optional + docs: >- + Currency code for the expense report + + + * `XUA` - ADB Unit of Account + + * `AFN` - Afghan Afghani + + * `AFA` - Afghan Afghani (1927–2002) + + * `ALL` - Albanian Lek + + * `ALK` - Albanian Lek (1946–1965) + + * `DZD` - Algerian Dinar + + * `ADP` - Andorran Peseta + + * `AOA` - Angolan Kwanza + + * `AOK` - Angolan Kwanza (1977–1991) + + * `AON` - Angolan New Kwanza (1990–2000) + + * `AOR` - Angolan Readjusted Kwanza (1995–1999) + + * `ARA` - Argentine Austral + + * `ARS` - Argentine Peso + + * `ARM` - Argentine Peso (1881–1970) + + * `ARP` - Argentine Peso (1983–1985) + + * `ARL` - Argentine Peso Ley (1970–1983) + + * `AMD` - Armenian Dram + + * `AWG` - Aruban Florin + + * `AUD` - Australian Dollar + + * `ATS` - Austrian Schilling + + * `AZN` - Azerbaijani Manat + + * `AZM` - Azerbaijani Manat (1993–2006) + + * `BSD` - Bahamian Dollar + + * `BHD` - Bahraini Dinar + + * `BDT` - Bangladeshi Taka + + * `BBD` - Barbadian Dollar + + * `BYN` - Belarusian Ruble + + * `BYB` - Belarusian Ruble (1994–1999) + + * `BYR` - Belarusian Ruble (2000–2016) + + * `BEF` - Belgian Franc + + * `BEC` - Belgian Franc (convertible) + + * `BEL` - Belgian Franc (financial) + + * `BZD` - Belize Dollar + + * `BMD` - Bermudan Dollar + + * `BTN` - Bhutanese Ngultrum + + * `BOB` - Bolivian Boliviano + + * `BOL` - Bolivian Boliviano (1863–1963) + + * `BOV` - Bolivian Mvdol + + * `BOP` - Bolivian Peso + + * `BAM` - Bosnia-Herzegovina Convertible Mark + + * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) + + * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) + + * `BWP` - Botswanan Pula + + * `BRC` - Brazilian Cruzado (1986–1989) + + * `BRZ` - Brazilian Cruzeiro (1942–1967) + + * `BRE` - Brazilian Cruzeiro (1990–1993) + + * `BRR` - Brazilian Cruzeiro (1993–1994) + + * `BRN` - Brazilian New Cruzado (1989–1990) + + * `BRB` - Brazilian New Cruzeiro (1967–1986) + + * `BRL` - Brazilian Real + + * `GBP` - British Pound + + * `BND` - Brunei Dollar + + * `BGL` - Bulgarian Hard Lev + + * `BGN` - Bulgarian Lev + + * `BGO` - Bulgarian Lev (1879–1952) + + * `BGM` - Bulgarian Socialist Lev + + * `BUK` - Burmese Kyat + + * `BIF` - Burundian Franc + + * `XPF` - CFP Franc + + * `KHR` - Cambodian Riel + + * `CAD` - Canadian Dollar + + * `CVE` - Cape Verdean Escudo + + * `KYD` - Cayman Islands Dollar + + * `XAF` - Central African CFA Franc + + * `CLE` - Chilean Escudo + + * `CLP` - Chilean Peso + + * `CLF` - Chilean Unit of Account (UF) + + * `CNX` - Chinese People’s Bank Dollar + + * `CNY` - Chinese Yuan + + * `CNH` - Chinese Yuan (offshore) + + * `COP` - Colombian Peso + + * `COU` - Colombian Real Value Unit + + * `KMF` - Comorian Franc + + * `CDF` - Congolese Franc + + * `CRC` - Costa Rican Colón + + * `HRD` - Croatian Dinar + + * `HRK` - Croatian Kuna + + * `CUC` - Cuban Convertible Peso + + * `CUP` - Cuban Peso + + * `CYP` - Cypriot Pound + + * `CZK` - Czech Koruna + + * `CSK` - Czechoslovak Hard Koruna + + * `DKK` - Danish Krone + + * `DJF` - Djiboutian Franc + + * `DOP` - Dominican Peso + + * `NLG` - Dutch Guilder + + * `XCD` - East Caribbean Dollar + + * `DDM` - East German Mark + + * `ECS` - Ecuadorian Sucre + + * `ECV` - Ecuadorian Unit of Constant Value + + * `EGP` - Egyptian Pound + + * `GQE` - Equatorial Guinean Ekwele + + * `ERN` - Eritrean Nakfa + + * `EEK` - Estonian Kroon + + * `ETB` - Ethiopian Birr + + * `EUR` - Euro + + * `XBA` - European Composite Unit + + * `XEU` - European Currency Unit + + * `XBB` - European Monetary Unit + + * `XBC` - European Unit of Account (XBC) + + * `XBD` - European Unit of Account (XBD) + + * `FKP` - Falkland Islands Pound + + * `FJD` - Fijian Dollar + + * `FIM` - Finnish Markka + + * `FRF` - French Franc + + * `XFO` - French Gold Franc + + * `XFU` - French UIC-Franc + + * `GMD` - Gambian Dalasi + + * `GEK` - Georgian Kupon Larit + + * `GEL` - Georgian Lari + + * `DEM` - German Mark + + * `GHS` - Ghanaian Cedi + + * `GHC` - Ghanaian Cedi (1979–2007) + + * `GIP` - Gibraltar Pound + + * `XAU` - Gold + + * `GRD` - Greek Drachma + + * `GTQ` - Guatemalan Quetzal + + * `GWP` - Guinea-Bissau Peso + + * `GNF` - Guinean Franc + + * `GNS` - Guinean Syli + + * `GYD` - Guyanaese Dollar + + * `HTG` - Haitian Gourde + + * `HNL` - Honduran Lempira + + * `HKD` - Hong Kong Dollar + + * `HUF` - Hungarian Forint + + * `IMP` - IMP + + * `ISK` - Icelandic Króna + + * `ISJ` - Icelandic Króna (1918–1981) + + * `INR` - Indian Rupee + + * `IDR` - Indonesian Rupiah + + * `IRR` - Iranian Rial + + * `IQD` - Iraqi Dinar + + * `IEP` - Irish Pound + + * `ILS` - Israeli New Shekel + + * `ILP` - Israeli Pound + + * `ILR` - Israeli Shekel (1980–1985) + + * `ITL` - Italian Lira + + * `JMD` - Jamaican Dollar + + * `JPY` - Japanese Yen + + * `JOD` - Jordanian Dinar + + * `KZT` - Kazakhstani Tenge + + * `KES` - Kenyan Shilling + + * `KWD` - Kuwaiti Dinar + + * `KGS` - Kyrgystani Som + + * `LAK` - Laotian Kip + + * `LVL` - Latvian Lats + + * `LVR` - Latvian Ruble + + * `LBP` - Lebanese Pound + + * `LSL` - Lesotho Loti + + * `LRD` - Liberian Dollar + + * `LYD` - Libyan Dinar + + * `LTL` - Lithuanian Litas + + * `LTT` - Lithuanian Talonas + + * `LUL` - Luxembourg Financial Franc + + * `LUC` - Luxembourgian Convertible Franc + + * `LUF` - Luxembourgian Franc + + * `MOP` - Macanese Pataca + + * `MKD` - Macedonian Denar + + * `MKN` - Macedonian Denar (1992–1993) + + * `MGA` - Malagasy Ariary + + * `MGF` - Malagasy Franc + + * `MWK` - Malawian Kwacha + + * `MYR` - Malaysian Ringgit + + * `MVR` - Maldivian Rufiyaa + + * `MVP` - Maldivian Rupee (1947–1981) + + * `MLF` - Malian Franc + + * `MTL` - Maltese Lira + + * `MTP` - Maltese Pound + + * `MRU` - Mauritanian Ouguiya + + * `MRO` - Mauritanian Ouguiya (1973–2017) + + * `MUR` - Mauritian Rupee + + * `MXV` - Mexican Investment Unit + + * `MXN` - Mexican Peso + + * `MXP` - Mexican Silver Peso (1861–1992) + + * `MDC` - Moldovan Cupon + + * `MDL` - Moldovan Leu + + * `MCF` - Monegasque Franc + + * `MNT` - Mongolian Tugrik + + * `MAD` - Moroccan Dirham + + * `MAF` - Moroccan Franc + + * `MZE` - Mozambican Escudo + + * `MZN` - Mozambican Metical + + * `MZM` - Mozambican Metical (1980–2006) + + * `MMK` - Myanmar Kyat + + * `NAD` - Namibian Dollar + + * `NPR` - Nepalese Rupee + + * `ANG` - Netherlands Antillean Guilder + + * `TWD` - New Taiwan Dollar + + * `NZD` - New Zealand Dollar + + * `NIO` - Nicaraguan Córdoba + + * `NIC` - Nicaraguan Córdoba (1988–1991) + + * `NGN` - Nigerian Naira + + * `KPW` - North Korean Won + + * `NOK` - Norwegian Krone + + * `OMR` - Omani Rial + + * `PKR` - Pakistani Rupee + + * `XPD` - Palladium + + * `PAB` - Panamanian Balboa + + * `PGK` - Papua New Guinean Kina + + * `PYG` - Paraguayan Guarani + + * `PEI` - Peruvian Inti + + * `PEN` - Peruvian Sol + + * `PES` - Peruvian Sol (1863–1965) + + * `PHP` - Philippine Peso + + * `XPT` - Platinum + + * `PLN` - Polish Zloty + + * `PLZ` - Polish Zloty (1950–1995) + + * `PTE` - Portuguese Escudo + + * `GWE` - Portuguese Guinea Escudo + + * `QAR` - Qatari Rial + + * `XRE` - RINET Funds + + * `RHD` - Rhodesian Dollar + + * `RON` - Romanian Leu + + * `ROL` - Romanian Leu (1952–2006) + + * `RUB` - Russian Ruble + + * `RUR` - Russian Ruble (1991–1998) + + * `RWF` - Rwandan Franc + + * `SVC` - Salvadoran Colón + + * `WST` - Samoan Tala + + * `SAR` - Saudi Riyal + + * `RSD` - Serbian Dinar + + * `CSD` - Serbian Dinar (2002–2006) + + * `SCR` - Seychellois Rupee + + * `SLL` - Sierra Leonean Leone + + * `XAG` - Silver + + * `SGD` - Singapore Dollar + + * `SKK` - Slovak Koruna + + * `SIT` - Slovenian Tolar + + * `SBD` - Solomon Islands Dollar + + * `SOS` - Somali Shilling + + * `ZAR` - South African Rand + + * `ZAL` - South African Rand (financial) + + * `KRH` - South Korean Hwan (1953–1962) + + * `KRW` - South Korean Won + + * `KRO` - South Korean Won (1945–1953) + + * `SSP` - South Sudanese Pound + + * `SUR` - Soviet Rouble + + * `ESP` - Spanish Peseta + + * `ESA` - Spanish Peseta (A account) + + * `ESB` - Spanish Peseta (convertible account) + + * `XDR` - Special Drawing Rights + + * `LKR` - Sri Lankan Rupee + + * `SHP` - St. Helena Pound + + * `XSU` - Sucre + + * `SDD` - Sudanese Dinar (1992–2007) + + * `SDG` - Sudanese Pound + + * `SDP` - Sudanese Pound (1957–1998) + + * `SRD` - Surinamese Dollar + + * `SRG` - Surinamese Guilder + + * `SZL` - Swazi Lilangeni + + * `SEK` - Swedish Krona + + * `CHF` - Swiss Franc + + * `SYP` - Syrian Pound + + * `STN` - São Tomé & Príncipe Dobra + + * `STD` - São Tomé & Príncipe Dobra (1977–2017) + + * `TVD` - TVD + + * `TJR` - Tajikistani Ruble + + * `TJS` - Tajikistani Somoni + + * `TZS` - Tanzanian Shilling + + * `XTS` - Testing Currency Code + + * `THB` - Thai Baht + + * `XXX` - The codes assigned for transactions where no currency is + involved + + * `TPE` - Timorese Escudo + + * `TOP` - Tongan Paʻanga + + * `TTD` - Trinidad & Tobago Dollar + + * `TND` - Tunisian Dinar + + * `TRY` - Turkish Lira + + * `TRL` - Turkish Lira (1922–2005) + + * `TMT` - Turkmenistani Manat + + * `TMM` - Turkmenistani Manat (1993–2009) + + * `USD` - US Dollar + + * `USN` - US Dollar (Next day) + + * `USS` - US Dollar (Same day) + + * `UGX` - Ugandan Shilling + + * `UGS` - Ugandan Shilling (1966–1987) + + * `UAH` - Ukrainian Hryvnia + + * `UAK` - Ukrainian Karbovanets + + * `AED` - United Arab Emirates Dirham + + * `UYW` - Uruguayan Nominal Wage Index Unit + + * `UYU` - Uruguayan Peso + + * `UYP` - Uruguayan Peso (1975–1993) + + * `UYI` - Uruguayan Peso (Indexed Units) + + * `UZS` - Uzbekistani Som + + * `VUV` - Vanuatu Vatu + + * `VES` - Venezuelan Bolívar + + * `VEB` - Venezuelan Bolívar (1871–2008) + + * `VEF` - Venezuelan Bolívar (2008–2018) + + * `VND` - Vietnamese Dong + + * `VNN` - Vietnamese Dong (1978–1985) + + * `CHE` - WIR Euro + + * `CHW` - WIR Franc + + * `XOF` - West African CFA Franc + + * `YDD` - Yemeni Dinar + + * `YER` - Yemeni Rial + + * `YUN` - Yugoslavian Convertible Dinar (1990–1992) + + * `YUD` - Yugoslavian Hard Dinar (1966–1990) + + * `YUM` - Yugoslavian New Dinar (1994–2002) + + * `YUR` - Yugoslavian Reformed Dinar (1992–1993) + + * `ZWN` - ZWN + + * `ZRN` - Zairean New Zaire (1993–1998) + + * `ZRZ` - Zairean Zaire (1971–1993) + + * `ZMW` - Zambian Kwacha + + * `ZMK` - Zambian Kwacha (1968–2012) + + * `ZWD` - Zimbabwean Dollar (1980–2008) + + * `ZWR` - Zimbabwean Dollar (2008) + + * `ZWL` - Zimbabwean Dollar (2009) + description: + type: optional + docs: A brief description or purpose for the expense report + validation: + maxLength: 1024 + accounting_period: + type: optional + docs: The accounting period the report was posted in + company: + type: optional + docs: The subsidiary that the expense report is created in + tracking_categories: + docs: The related tracking categories associated with the expense report + type: list + remote_was_deleted: + type: optional + docs: >- + Indicates whether or not this object has been deleted in the third + party platform. Full coverage deletion detection is a premium add-on. + Native deletion detection is offered for free with limited coverage. + [Learn + more](https://docs.merge.dev/integrations/hris/supported-features/). + access: read-only + field_mappings: + type: optional> + access: read-only + remote_data: + type: optional> + access: read-only + remote_fields: + type: optional> + access: read-only + source: + openapi: openapi/openapi.yml + ExpenseReportLineAccount: + discriminated: false + union: + - type: string + validation: + format: uuid + - Account + source: + openapi: openapi/openapi.yml + inline: true + ExpenseReportLineCurrency: + discriminated: false + docs: >- + Currency of the expense line (if different from the report currency). + + + * `XUA` - ADB Unit of Account + + * `AFN` - Afghan Afghani + + * `AFA` - Afghan Afghani (1927–2002) + + * `ALL` - Albanian Lek + + * `ALK` - Albanian Lek (1946–1965) + + * `DZD` - Algerian Dinar + + * `ADP` - Andorran Peseta + + * `AOA` - Angolan Kwanza + + * `AOK` - Angolan Kwanza (1977–1991) + + * `AON` - Angolan New Kwanza (1990–2000) + + * `AOR` - Angolan Readjusted Kwanza (1995–1999) + + * `ARA` - Argentine Austral + + * `ARS` - Argentine Peso + + * `ARM` - Argentine Peso (1881–1970) + + * `ARP` - Argentine Peso (1983–1985) + + * `ARL` - Argentine Peso Ley (1970–1983) + + * `AMD` - Armenian Dram + + * `AWG` - Aruban Florin + + * `AUD` - Australian Dollar + + * `ATS` - Austrian Schilling + + * `AZN` - Azerbaijani Manat + + * `AZM` - Azerbaijani Manat (1993–2006) + + * `BSD` - Bahamian Dollar + + * `BHD` - Bahraini Dinar + + * `BDT` - Bangladeshi Taka + + * `BBD` - Barbadian Dollar + + * `BYN` - Belarusian Ruble + + * `BYB` - Belarusian Ruble (1994–1999) + + * `BYR` - Belarusian Ruble (2000–2016) + + * `BEF` - Belgian Franc + + * `BEC` - Belgian Franc (convertible) + + * `BEL` - Belgian Franc (financial) + + * `BZD` - Belize Dollar + + * `BMD` - Bermudan Dollar + + * `BTN` - Bhutanese Ngultrum + + * `BOB` - Bolivian Boliviano + + * `BOL` - Bolivian Boliviano (1863–1963) + + * `BOV` - Bolivian Mvdol + + * `BOP` - Bolivian Peso + + * `BAM` - Bosnia-Herzegovina Convertible Mark + + * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) + + * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) + + * `BWP` - Botswanan Pula + + * `BRC` - Brazilian Cruzado (1986–1989) + + * `BRZ` - Brazilian Cruzeiro (1942–1967) + + * `BRE` - Brazilian Cruzeiro (1990–1993) + + * `BRR` - Brazilian Cruzeiro (1993–1994) + + * `BRN` - Brazilian New Cruzado (1989–1990) + + * `BRB` - Brazilian New Cruzeiro (1967–1986) + + * `BRL` - Brazilian Real + + * `GBP` - British Pound + + * `BND` - Brunei Dollar + + * `BGL` - Bulgarian Hard Lev + + * `BGN` - Bulgarian Lev + + * `BGO` - Bulgarian Lev (1879–1952) + + * `BGM` - Bulgarian Socialist Lev + + * `BUK` - Burmese Kyat + + * `BIF` - Burundian Franc + + * `XPF` - CFP Franc + + * `KHR` - Cambodian Riel + + * `CAD` - Canadian Dollar + + * `CVE` - Cape Verdean Escudo + + * `KYD` - Cayman Islands Dollar + + * `XAF` - Central African CFA Franc + + * `CLE` - Chilean Escudo + + * `CLP` - Chilean Peso + + * `CLF` - Chilean Unit of Account (UF) + + * `CNX` - Chinese People’s Bank Dollar + + * `CNY` - Chinese Yuan + + * `CNH` - Chinese Yuan (offshore) + + * `COP` - Colombian Peso + + * `COU` - Colombian Real Value Unit + + * `KMF` - Comorian Franc + + * `CDF` - Congolese Franc + + * `CRC` - Costa Rican Colón + + * `HRD` - Croatian Dinar + + * `HRK` - Croatian Kuna + + * `CUC` - Cuban Convertible Peso + + * `CUP` - Cuban Peso + + * `CYP` - Cypriot Pound + + * `CZK` - Czech Koruna + + * `CSK` - Czechoslovak Hard Koruna + + * `DKK` - Danish Krone + + * `DJF` - Djiboutian Franc + + * `DOP` - Dominican Peso + + * `NLG` - Dutch Guilder + + * `XCD` - East Caribbean Dollar + + * `DDM` - East German Mark + + * `ECS` - Ecuadorian Sucre + + * `ECV` - Ecuadorian Unit of Constant Value + + * `EGP` - Egyptian Pound + + * `GQE` - Equatorial Guinean Ekwele + + * `ERN` - Eritrean Nakfa + + * `EEK` - Estonian Kroon + + * `ETB` - Ethiopian Birr + + * `EUR` - Euro + + * `XBA` - European Composite Unit + + * `XEU` - European Currency Unit + + * `XBB` - European Monetary Unit + + * `XBC` - European Unit of Account (XBC) + + * `XBD` - European Unit of Account (XBD) + + * `FKP` - Falkland Islands Pound + + * `FJD` - Fijian Dollar + + * `FIM` - Finnish Markka + + * `FRF` - French Franc + + * `XFO` - French Gold Franc + + * `XFU` - French UIC-Franc + + * `GMD` - Gambian Dalasi + + * `GEK` - Georgian Kupon Larit + + * `GEL` - Georgian Lari + + * `DEM` - German Mark + + * `GHS` - Ghanaian Cedi + + * `GHC` - Ghanaian Cedi (1979–2007) + + * `GIP` - Gibraltar Pound + + * `XAU` - Gold + + * `GRD` - Greek Drachma + + * `GTQ` - Guatemalan Quetzal + + * `GWP` - Guinea-Bissau Peso + + * `GNF` - Guinean Franc + + * `GNS` - Guinean Syli + + * `GYD` - Guyanaese Dollar + + * `HTG` - Haitian Gourde + + * `HNL` - Honduran Lempira + + * `HKD` - Hong Kong Dollar + + * `HUF` - Hungarian Forint + + * `IMP` - IMP + + * `ISK` - Icelandic Króna + + * `ISJ` - Icelandic Króna (1918–1981) + + * `INR` - Indian Rupee + + * `IDR` - Indonesian Rupiah + + * `IRR` - Iranian Rial + + * `IQD` - Iraqi Dinar + + * `IEP` - Irish Pound + + * `ILS` - Israeli New Shekel + + * `ILP` - Israeli Pound + + * `ILR` - Israeli Shekel (1980–1985) + + * `ITL` - Italian Lira + + * `JMD` - Jamaican Dollar + + * `JPY` - Japanese Yen + + * `JOD` - Jordanian Dinar + + * `KZT` - Kazakhstani Tenge + + * `KES` - Kenyan Shilling + + * `KWD` - Kuwaiti Dinar + + * `KGS` - Kyrgystani Som + + * `LAK` - Laotian Kip + + * `LVL` - Latvian Lats + + * `LVR` - Latvian Ruble + + * `LBP` - Lebanese Pound + + * `LSL` - Lesotho Loti + + * `LRD` - Liberian Dollar + + * `LYD` - Libyan Dinar + + * `LTL` - Lithuanian Litas + + * `LTT` - Lithuanian Talonas + + * `LUL` - Luxembourg Financial Franc + + * `LUC` - Luxembourgian Convertible Franc + + * `LUF` - Luxembourgian Franc + + * `MOP` - Macanese Pataca + + * `MKD` - Macedonian Denar + + * `MKN` - Macedonian Denar (1992–1993) + + * `MGA` - Malagasy Ariary + + * `MGF` - Malagasy Franc + + * `MWK` - Malawian Kwacha + + * `MYR` - Malaysian Ringgit + + * `MVR` - Maldivian Rufiyaa + + * `MVP` - Maldivian Rupee (1947–1981) + + * `MLF` - Malian Franc + + * `MTL` - Maltese Lira + + * `MTP` - Maltese Pound + + * `MRU` - Mauritanian Ouguiya + + * `MRO` - Mauritanian Ouguiya (1973–2017) + + * `MUR` - Mauritian Rupee + + * `MXV` - Mexican Investment Unit + + * `MXN` - Mexican Peso + + * `MXP` - Mexican Silver Peso (1861–1992) + + * `MDC` - Moldovan Cupon + + * `MDL` - Moldovan Leu + + * `MCF` - Monegasque Franc + + * `MNT` - Mongolian Tugrik + + * `MAD` - Moroccan Dirham + + * `MAF` - Moroccan Franc + + * `MZE` - Mozambican Escudo + + * `MZN` - Mozambican Metical + + * `MZM` - Mozambican Metical (1980–2006) + + * `MMK` - Myanmar Kyat + + * `NAD` - Namibian Dollar + + * `NPR` - Nepalese Rupee + + * `ANG` - Netherlands Antillean Guilder + + * `TWD` - New Taiwan Dollar + + * `NZD` - New Zealand Dollar + + * `NIO` - Nicaraguan Córdoba + + * `NIC` - Nicaraguan Córdoba (1988–1991) + + * `NGN` - Nigerian Naira + + * `KPW` - North Korean Won + + * `NOK` - Norwegian Krone + + * `OMR` - Omani Rial + + * `PKR` - Pakistani Rupee + + * `XPD` - Palladium + + * `PAB` - Panamanian Balboa + + * `PGK` - Papua New Guinean Kina + + * `PYG` - Paraguayan Guarani + + * `PEI` - Peruvian Inti + + * `PEN` - Peruvian Sol + + * `PES` - Peruvian Sol (1863–1965) + + * `PHP` - Philippine Peso + + * `XPT` - Platinum + + * `PLN` - Polish Zloty + + * `PLZ` - Polish Zloty (1950–1995) + + * `PTE` - Portuguese Escudo + + * `GWE` - Portuguese Guinea Escudo + + * `QAR` - Qatari Rial + + * `XRE` - RINET Funds + + * `RHD` - Rhodesian Dollar + + * `RON` - Romanian Leu + + * `ROL` - Romanian Leu (1952–2006) + + * `RUB` - Russian Ruble + + * `RUR` - Russian Ruble (1991–1998) + + * `RWF` - Rwandan Franc + + * `SVC` - Salvadoran Colón + + * `WST` - Samoan Tala + + * `SAR` - Saudi Riyal + + * `RSD` - Serbian Dinar + + * `CSD` - Serbian Dinar (2002–2006) + + * `SCR` - Seychellois Rupee + + * `SLL` - Sierra Leonean Leone + + * `XAG` - Silver + + * `SGD` - Singapore Dollar + + * `SKK` - Slovak Koruna + + * `SIT` - Slovenian Tolar + + * `SBD` - Solomon Islands Dollar + + * `SOS` - Somali Shilling + + * `ZAR` - South African Rand + + * `ZAL` - South African Rand (financial) + + * `KRH` - South Korean Hwan (1953–1962) + + * `KRW` - South Korean Won + + * `KRO` - South Korean Won (1945–1953) + + * `SSP` - South Sudanese Pound + + * `SUR` - Soviet Rouble + + * `ESP` - Spanish Peseta + + * `ESA` - Spanish Peseta (A account) + + * `ESB` - Spanish Peseta (convertible account) + + * `XDR` - Special Drawing Rights + + * `LKR` - Sri Lankan Rupee + + * `SHP` - St. Helena Pound + + * `XSU` - Sucre + + * `SDD` - Sudanese Dinar (1992–2007) + + * `SDG` - Sudanese Pound + + * `SDP` - Sudanese Pound (1957–1998) + + * `SRD` - Surinamese Dollar + + * `SRG` - Surinamese Guilder + + * `SZL` - Swazi Lilangeni + + * `SEK` - Swedish Krona + + * `CHF` - Swiss Franc + + * `SYP` - Syrian Pound + + * `STN` - São Tomé & Príncipe Dobra + + * `STD` - São Tomé & Príncipe Dobra (1977–2017) + + * `TVD` - TVD + + * `TJR` - Tajikistani Ruble + + * `TJS` - Tajikistani Somoni + + * `TZS` - Tanzanian Shilling + + * `XTS` - Testing Currency Code + + * `THB` - Thai Baht + + * `XXX` - The codes assigned for transactions where no currency is + involved + + * `TPE` - Timorese Escudo + + * `TOP` - Tongan Paʻanga + + * `TTD` - Trinidad & Tobago Dollar + + * `TND` - Tunisian Dinar + + * `TRY` - Turkish Lira + + * `TRL` - Turkish Lira (1922–2005) + + * `TMT` - Turkmenistani Manat + + * `TMM` - Turkmenistani Manat (1993–2009) + + * `USD` - US Dollar + + * `USN` - US Dollar (Next day) + + * `USS` - US Dollar (Same day) + + * `UGX` - Ugandan Shilling + + * `UGS` - Ugandan Shilling (1966–1987) + + * `UAH` - Ukrainian Hryvnia + + * `UAK` - Ukrainian Karbovanets + + * `AED` - United Arab Emirates Dirham + + * `UYW` - Uruguayan Nominal Wage Index Unit + + * `UYU` - Uruguayan Peso + + * `UYP` - Uruguayan Peso (1975–1993) + + * `UYI` - Uruguayan Peso (Indexed Units) + + * `UZS` - Uzbekistani Som + + * `VUV` - Vanuatu Vatu + + * `VES` - Venezuelan Bolívar + + * `VEB` - Venezuelan Bolívar (1871–2008) + + * `VEF` - Venezuelan Bolívar (2008–2018) + + * `VND` - Vietnamese Dong + + * `VNN` - Vietnamese Dong (1978–1985) + + * `CHE` - WIR Euro + + * `CHW` - WIR Franc + + * `XOF` - West African CFA Franc + + * `YDD` - Yemeni Dinar + + * `YER` - Yemeni Rial + + * `YUN` - Yugoslavian Convertible Dinar (1990–1992) + + * `YUD` - Yugoslavian Hard Dinar (1966–1990) + + * `YUM` - Yugoslavian New Dinar (1994–2002) + + * `YUR` - Yugoslavian Reformed Dinar (1992–1993) + + * `ZWN` - ZWN + + * `ZRN` - Zairean New Zaire (1993–1998) + + * `ZRZ` - Zairean Zaire (1971–1993) + + * `ZMW` - Zambian Kwacha + + * `ZMK` - Zambian Kwacha (1968–2012) + + * `ZWD` - Zimbabwean Dollar (1980–2008) + + * `ZWR` - Zimbabwean Dollar (2008) + + * `ZWL` - Zimbabwean Dollar (2009) + union: + - TransactionCurrencyEnum + - string + source: + openapi: openapi/openapi.yml + inline: true + ExpenseReportLineEmployee: + discriminated: false + docs: >- + Identifier for the employee who submitted or is associated with the + expense report + union: + - type: string + validation: + format: uuid + - Employee + source: + openapi: openapi/openapi.yml + inline: true + ExpenseReportLineProject: + discriminated: false + union: + - type: string + validation: + format: uuid + - Project + source: + openapi: openapi/openapi.yml + inline: true + ExpenseReportLineCompany: + discriminated: false + docs: The subsidiary that the expense report is created in + union: + - type: string + validation: + format: uuid + - CompanyInfo + source: + openapi: openapi/openapi.yml + inline: true + ExpenseReportLineContact: + discriminated: false + union: + - type: string + validation: + format: uuid + - Contact + source: + openapi: openapi/openapi.yml + inline: true + ExpenseReportLineTaxRate: + discriminated: false + union: + - type: string + validation: + format: uuid + - TaxRate + source: + openapi: openapi/openapi.yml + inline: true + ExpenseReportLine: + docs: >- + # The ExpenseReportLine Object + + ### Description + + The `ExpenseReportLine` object represents an individual line item within + an expense report, containing details about + + a specific expense such as amount, description, and associated metadata. + + + ### Usage Example + + Fetch from the `GET ExpenseReport` endpoint and expand the lines field to + view all line items in the expense report. + properties: + id: + type: optional + validation: + format: uuid + access: read-only + remote_id: + type: optional + docs: The third-party API ID of the matching object. + created_at: + type: optional + docs: The datetime that this object was created by Merge. + access: read-only + modified_at: + type: optional + docs: The datetime that this object was modified by Merge. + access: read-only + account: optional + description: + type: optional + docs: Description of the individual expense. + validation: + maxLength: 1024 + expense_date: + type: optional + docs: The date the individual expense was incurred. + amount: + type: optional + docs: The amount of the expense for the line item. + currency: + type: optional + docs: >- + Currency of the expense line (if different from the report currency). + + + * `XUA` - ADB Unit of Account + + * `AFN` - Afghan Afghani + + * `AFA` - Afghan Afghani (1927–2002) + + * `ALL` - Albanian Lek + + * `ALK` - Albanian Lek (1946–1965) + + * `DZD` - Algerian Dinar + + * `ADP` - Andorran Peseta + + * `AOA` - Angolan Kwanza + + * `AOK` - Angolan Kwanza (1977–1991) + + * `AON` - Angolan New Kwanza (1990–2000) + + * `AOR` - Angolan Readjusted Kwanza (1995–1999) + + * `ARA` - Argentine Austral + + * `ARS` - Argentine Peso + + * `ARM` - Argentine Peso (1881–1970) + + * `ARP` - Argentine Peso (1983–1985) + + * `ARL` - Argentine Peso Ley (1970–1983) + + * `AMD` - Armenian Dram + + * `AWG` - Aruban Florin + + * `AUD` - Australian Dollar + + * `ATS` - Austrian Schilling + + * `AZN` - Azerbaijani Manat + + * `AZM` - Azerbaijani Manat (1993–2006) + + * `BSD` - Bahamian Dollar + + * `BHD` - Bahraini Dinar + + * `BDT` - Bangladeshi Taka + + * `BBD` - Barbadian Dollar + + * `BYN` - Belarusian Ruble + + * `BYB` - Belarusian Ruble (1994–1999) + + * `BYR` - Belarusian Ruble (2000–2016) + + * `BEF` - Belgian Franc + + * `BEC` - Belgian Franc (convertible) + + * `BEL` - Belgian Franc (financial) + + * `BZD` - Belize Dollar + + * `BMD` - Bermudan Dollar + + * `BTN` - Bhutanese Ngultrum + + * `BOB` - Bolivian Boliviano + + * `BOL` - Bolivian Boliviano (1863–1963) + + * `BOV` - Bolivian Mvdol + + * `BOP` - Bolivian Peso + + * `BAM` - Bosnia-Herzegovina Convertible Mark + + * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) + + * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) + + * `BWP` - Botswanan Pula + + * `BRC` - Brazilian Cruzado (1986–1989) + + * `BRZ` - Brazilian Cruzeiro (1942–1967) + + * `BRE` - Brazilian Cruzeiro (1990–1993) + + * `BRR` - Brazilian Cruzeiro (1993–1994) + + * `BRN` - Brazilian New Cruzado (1989–1990) + + * `BRB` - Brazilian New Cruzeiro (1967–1986) + + * `BRL` - Brazilian Real + + * `GBP` - British Pound + + * `BND` - Brunei Dollar + + * `BGL` - Bulgarian Hard Lev + + * `BGN` - Bulgarian Lev + + * `BGO` - Bulgarian Lev (1879–1952) + + * `BGM` - Bulgarian Socialist Lev + + * `BUK` - Burmese Kyat + + * `BIF` - Burundian Franc + + * `XPF` - CFP Franc + + * `KHR` - Cambodian Riel + + * `CAD` - Canadian Dollar + + * `CVE` - Cape Verdean Escudo + + * `KYD` - Cayman Islands Dollar + + * `XAF` - Central African CFA Franc + + * `CLE` - Chilean Escudo + + * `CLP` - Chilean Peso + + * `CLF` - Chilean Unit of Account (UF) + + * `CNX` - Chinese People’s Bank Dollar + + * `CNY` - Chinese Yuan + + * `CNH` - Chinese Yuan (offshore) + + * `COP` - Colombian Peso + + * `COU` - Colombian Real Value Unit + + * `KMF` - Comorian Franc + + * `CDF` - Congolese Franc + + * `CRC` - Costa Rican Colón + + * `HRD` - Croatian Dinar + + * `HRK` - Croatian Kuna + + * `CUC` - Cuban Convertible Peso + + * `CUP` - Cuban Peso + + * `CYP` - Cypriot Pound + + * `CZK` - Czech Koruna + + * `CSK` - Czechoslovak Hard Koruna + + * `DKK` - Danish Krone + + * `DJF` - Djiboutian Franc + + * `DOP` - Dominican Peso + + * `NLG` - Dutch Guilder + + * `XCD` - East Caribbean Dollar + + * `DDM` - East German Mark + + * `ECS` - Ecuadorian Sucre + + * `ECV` - Ecuadorian Unit of Constant Value + + * `EGP` - Egyptian Pound + + * `GQE` - Equatorial Guinean Ekwele + + * `ERN` - Eritrean Nakfa + + * `EEK` - Estonian Kroon + + * `ETB` - Ethiopian Birr + + * `EUR` - Euro + + * `XBA` - European Composite Unit + + * `XEU` - European Currency Unit + + * `XBB` - European Monetary Unit + + * `XBC` - European Unit of Account (XBC) + + * `XBD` - European Unit of Account (XBD) + + * `FKP` - Falkland Islands Pound + + * `FJD` - Fijian Dollar + + * `FIM` - Finnish Markka + + * `FRF` - French Franc + + * `XFO` - French Gold Franc + + * `XFU` - French UIC-Franc + + * `GMD` - Gambian Dalasi + + * `GEK` - Georgian Kupon Larit + + * `GEL` - Georgian Lari + + * `DEM` - German Mark + + * `GHS` - Ghanaian Cedi + + * `GHC` - Ghanaian Cedi (1979–2007) + + * `GIP` - Gibraltar Pound + + * `XAU` - Gold + + * `GRD` - Greek Drachma + + * `GTQ` - Guatemalan Quetzal + + * `GWP` - Guinea-Bissau Peso + + * `GNF` - Guinean Franc + + * `GNS` - Guinean Syli + + * `GYD` - Guyanaese Dollar + + * `HTG` - Haitian Gourde + + * `HNL` - Honduran Lempira + + * `HKD` - Hong Kong Dollar + + * `HUF` - Hungarian Forint + + * `IMP` - IMP + + * `ISK` - Icelandic Króna + + * `ISJ` - Icelandic Króna (1918–1981) + + * `INR` - Indian Rupee + + * `IDR` - Indonesian Rupiah + + * `IRR` - Iranian Rial + + * `IQD` - Iraqi Dinar + + * `IEP` - Irish Pound + + * `ILS` - Israeli New Shekel + + * `ILP` - Israeli Pound + + * `ILR` - Israeli Shekel (1980–1985) + + * `ITL` - Italian Lira + + * `JMD` - Jamaican Dollar + + * `JPY` - Japanese Yen + + * `JOD` - Jordanian Dinar + + * `KZT` - Kazakhstani Tenge + + * `KES` - Kenyan Shilling + + * `KWD` - Kuwaiti Dinar + + * `KGS` - Kyrgystani Som + + * `LAK` - Laotian Kip + + * `LVL` - Latvian Lats + + * `LVR` - Latvian Ruble + + * `LBP` - Lebanese Pound + + * `LSL` - Lesotho Loti + + * `LRD` - Liberian Dollar + + * `LYD` - Libyan Dinar + + * `LTL` - Lithuanian Litas + + * `LTT` - Lithuanian Talonas + + * `LUL` - Luxembourg Financial Franc + + * `LUC` - Luxembourgian Convertible Franc + + * `LUF` - Luxembourgian Franc + + * `MOP` - Macanese Pataca + + * `MKD` - Macedonian Denar + + * `MKN` - Macedonian Denar (1992–1993) + + * `MGA` - Malagasy Ariary + + * `MGF` - Malagasy Franc + + * `MWK` - Malawian Kwacha + + * `MYR` - Malaysian Ringgit + + * `MVR` - Maldivian Rufiyaa + + * `MVP` - Maldivian Rupee (1947–1981) + + * `MLF` - Malian Franc + + * `MTL` - Maltese Lira + + * `MTP` - Maltese Pound + + * `MRU` - Mauritanian Ouguiya + + * `MRO` - Mauritanian Ouguiya (1973–2017) + + * `MUR` - Mauritian Rupee + + * `MXV` - Mexican Investment Unit + + * `MXN` - Mexican Peso + + * `MXP` - Mexican Silver Peso (1861–1992) + + * `MDC` - Moldovan Cupon + + * `MDL` - Moldovan Leu + + * `MCF` - Monegasque Franc + + * `MNT` - Mongolian Tugrik + + * `MAD` - Moroccan Dirham + + * `MAF` - Moroccan Franc + + * `MZE` - Mozambican Escudo + + * `MZN` - Mozambican Metical + + * `MZM` - Mozambican Metical (1980–2006) + + * `MMK` - Myanmar Kyat + + * `NAD` - Namibian Dollar + + * `NPR` - Nepalese Rupee + + * `ANG` - Netherlands Antillean Guilder + + * `TWD` - New Taiwan Dollar + + * `NZD` - New Zealand Dollar + + * `NIO` - Nicaraguan Córdoba + + * `NIC` - Nicaraguan Córdoba (1988–1991) + + * `NGN` - Nigerian Naira + + * `KPW` - North Korean Won + + * `NOK` - Norwegian Krone + + * `OMR` - Omani Rial + + * `PKR` - Pakistani Rupee * `XPD` - Palladium - * `PAB` - Panamanian Balboa + * `PAB` - Panamanian Balboa + + * `PGK` - Papua New Guinean Kina + + * `PYG` - Paraguayan Guarani + + * `PEI` - Peruvian Inti + + * `PEN` - Peruvian Sol + + * `PES` - Peruvian Sol (1863–1965) + + * `PHP` - Philippine Peso + + * `XPT` - Platinum + + * `PLN` - Polish Zloty + + * `PLZ` - Polish Zloty (1950–1995) + + * `PTE` - Portuguese Escudo + + * `GWE` - Portuguese Guinea Escudo + + * `QAR` - Qatari Rial + + * `XRE` - RINET Funds + + * `RHD` - Rhodesian Dollar + + * `RON` - Romanian Leu + + * `ROL` - Romanian Leu (1952–2006) + + * `RUB` - Russian Ruble + + * `RUR` - Russian Ruble (1991–1998) + + * `RWF` - Rwandan Franc + + * `SVC` - Salvadoran Colón + + * `WST` - Samoan Tala + + * `SAR` - Saudi Riyal + + * `RSD` - Serbian Dinar + + * `CSD` - Serbian Dinar (2002–2006) + + * `SCR` - Seychellois Rupee + + * `SLL` - Sierra Leonean Leone + + * `XAG` - Silver + + * `SGD` - Singapore Dollar + + * `SKK` - Slovak Koruna + + * `SIT` - Slovenian Tolar + + * `SBD` - Solomon Islands Dollar + + * `SOS` - Somali Shilling + + * `ZAR` - South African Rand + + * `ZAL` - South African Rand (financial) + + * `KRH` - South Korean Hwan (1953–1962) + + * `KRW` - South Korean Won + + * `KRO` - South Korean Won (1945–1953) + + * `SSP` - South Sudanese Pound + + * `SUR` - Soviet Rouble + + * `ESP` - Spanish Peseta + + * `ESA` - Spanish Peseta (A account) + + * `ESB` - Spanish Peseta (convertible account) + + * `XDR` - Special Drawing Rights + + * `LKR` - Sri Lankan Rupee + + * `SHP` - St. Helena Pound + + * `XSU` - Sucre + + * `SDD` - Sudanese Dinar (1992–2007) + + * `SDG` - Sudanese Pound + + * `SDP` - Sudanese Pound (1957–1998) + + * `SRD` - Surinamese Dollar + + * `SRG` - Surinamese Guilder + + * `SZL` - Swazi Lilangeni + + * `SEK` - Swedish Krona + + * `CHF` - Swiss Franc + + * `SYP` - Syrian Pound + + * `STN` - São Tomé & Príncipe Dobra + + * `STD` - São Tomé & Príncipe Dobra (1977–2017) + + * `TVD` - TVD + + * `TJR` - Tajikistani Ruble + + * `TJS` - Tajikistani Somoni + + * `TZS` - Tanzanian Shilling + + * `XTS` - Testing Currency Code + + * `THB` - Thai Baht + + * `XXX` - The codes assigned for transactions where no currency is + involved + + * `TPE` - Timorese Escudo + + * `TOP` - Tongan Paʻanga + + * `TTD` - Trinidad & Tobago Dollar + + * `TND` - Tunisian Dinar + + * `TRY` - Turkish Lira + + * `TRL` - Turkish Lira (1922–2005) + + * `TMT` - Turkmenistani Manat + + * `TMM` - Turkmenistani Manat (1993–2009) + + * `USD` - US Dollar + + * `USN` - US Dollar (Next day) + + * `USS` - US Dollar (Same day) + + * `UGX` - Ugandan Shilling + + * `UGS` - Ugandan Shilling (1966–1987) + + * `UAH` - Ukrainian Hryvnia + + * `UAK` - Ukrainian Karbovanets + + * `AED` - United Arab Emirates Dirham + + * `UYW` - Uruguayan Nominal Wage Index Unit + + * `UYU` - Uruguayan Peso + + * `UYP` - Uruguayan Peso (1975–1993) + + * `UYI` - Uruguayan Peso (Indexed Units) + + * `UZS` - Uzbekistani Som + + * `VUV` - Vanuatu Vatu + + * `VES` - Venezuelan Bolívar + + * `VEB` - Venezuelan Bolívar (1871–2008) + + * `VEF` - Venezuelan Bolívar (2008–2018) + + * `VND` - Vietnamese Dong + + * `VNN` - Vietnamese Dong (1978–1985) + + * `CHE` - WIR Euro + + * `CHW` - WIR Franc + + * `XOF` - West African CFA Franc + + * `YDD` - Yemeni Dinar + + * `YER` - Yemeni Rial + + * `YUN` - Yugoslavian Convertible Dinar (1990–1992) + + * `YUD` - Yugoslavian Hard Dinar (1966–1990) + + * `YUM` - Yugoslavian New Dinar (1994–2002) + + * `YUR` - Yugoslavian Reformed Dinar (1992–1993) + + * `ZWN` - ZWN + + * `ZRN` - Zairean New Zaire (1993–1998) + + * `ZRZ` - Zairean Zaire (1971–1993) + + * `ZMW` - Zambian Kwacha + + * `ZMK` - Zambian Kwacha (1968–2012) + + * `ZWD` - Zimbabwean Dollar (1980–2008) + + * `ZWR` - Zimbabwean Dollar (2008) + + * `ZWL` - Zimbabwean Dollar (2009) + exchange_rate: + type: optional + docs: Exchange rate used if the line item is in a foreign currency. + validation: + pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ + is_billable: + type: optional + docs: Whether the expense line is billable to a client or project. + tracking_categories: + docs: >- + The related tracking categories associated with the expense report + (Department, Location, Class, Expense Category) + type: list + employee: + type: optional + docs: >- + Identifier for the employee who submitted or is associated with the + expense report + project: optional + company: + type: optional + docs: The subsidiary that the expense report is created in + contact: optional + quantity: + type: optional + docs: Quantity for the expense line (e.g., miles driven, items purchased). + unit_price: + type: optional + docs: Price per unit for the expense line (if applicable). + non_reimbursable: + type: optional + docs: >- + Whether the expense line is non-reimbursable (e.g., paid via company + card). + tax_amount: + type: optional + docs: Tax amount applicable for the line item. + inclusive_of_tax: + type: optional + docs: Whether the amount is inclusive of tax. + tax_rate: optional + remote_was_deleted: + type: optional + docs: >- + Indicates whether or not this object has been deleted in the third + party platform. Full coverage deletion detection is a premium add-on. + Native deletion detection is offered for free with limited coverage. + [Learn + more](https://docs.merge.dev/integrations/hris/supported-features/). + access: read-only + remote_fields: + type: optional> + access: read-only + source: + openapi: openapi/openapi.yml + ExpenseReportLineRequestAccount: + discriminated: false + union: + - type: string + validation: + format: uuid + - Account + source: + openapi: openapi/openapi.yml + inline: true + ExpenseReportLineRequestCurrency: + discriminated: false + docs: >- + Currency of the expense line (if different from the report currency). + + + * `XUA` - ADB Unit of Account + + * `AFN` - Afghan Afghani + + * `AFA` - Afghan Afghani (1927–2002) + + * `ALL` - Albanian Lek + + * `ALK` - Albanian Lek (1946–1965) + + * `DZD` - Algerian Dinar + + * `ADP` - Andorran Peseta + + * `AOA` - Angolan Kwanza + + * `AOK` - Angolan Kwanza (1977–1991) + + * `AON` - Angolan New Kwanza (1990–2000) + + * `AOR` - Angolan Readjusted Kwanza (1995–1999) + + * `ARA` - Argentine Austral + + * `ARS` - Argentine Peso + + * `ARM` - Argentine Peso (1881–1970) + + * `ARP` - Argentine Peso (1983–1985) + + * `ARL` - Argentine Peso Ley (1970–1983) + + * `AMD` - Armenian Dram + + * `AWG` - Aruban Florin + + * `AUD` - Australian Dollar + + * `ATS` - Austrian Schilling + + * `AZN` - Azerbaijani Manat + + * `AZM` - Azerbaijani Manat (1993–2006) + + * `BSD` - Bahamian Dollar + + * `BHD` - Bahraini Dinar + + * `BDT` - Bangladeshi Taka + + * `BBD` - Barbadian Dollar + + * `BYN` - Belarusian Ruble + + * `BYB` - Belarusian Ruble (1994–1999) + + * `BYR` - Belarusian Ruble (2000–2016) + + * `BEF` - Belgian Franc + + * `BEC` - Belgian Franc (convertible) + + * `BEL` - Belgian Franc (financial) + + * `BZD` - Belize Dollar + + * `BMD` - Bermudan Dollar + + * `BTN` - Bhutanese Ngultrum + + * `BOB` - Bolivian Boliviano + + * `BOL` - Bolivian Boliviano (1863–1963) + + * `BOV` - Bolivian Mvdol + + * `BOP` - Bolivian Peso + + * `BAM` - Bosnia-Herzegovina Convertible Mark + + * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) + + * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) + + * `BWP` - Botswanan Pula + + * `BRC` - Brazilian Cruzado (1986–1989) + + * `BRZ` - Brazilian Cruzeiro (1942–1967) + + * `BRE` - Brazilian Cruzeiro (1990–1993) + + * `BRR` - Brazilian Cruzeiro (1993–1994) + + * `BRN` - Brazilian New Cruzado (1989–1990) + + * `BRB` - Brazilian New Cruzeiro (1967–1986) + + * `BRL` - Brazilian Real + + * `GBP` - British Pound + + * `BND` - Brunei Dollar + + * `BGL` - Bulgarian Hard Lev + + * `BGN` - Bulgarian Lev + + * `BGO` - Bulgarian Lev (1879–1952) + + * `BGM` - Bulgarian Socialist Lev + + * `BUK` - Burmese Kyat + + * `BIF` - Burundian Franc + + * `XPF` - CFP Franc + + * `KHR` - Cambodian Riel + + * `CAD` - Canadian Dollar + + * `CVE` - Cape Verdean Escudo + + * `KYD` - Cayman Islands Dollar + + * `XAF` - Central African CFA Franc + + * `CLE` - Chilean Escudo + + * `CLP` - Chilean Peso + + * `CLF` - Chilean Unit of Account (UF) + + * `CNX` - Chinese People’s Bank Dollar + + * `CNY` - Chinese Yuan + + * `CNH` - Chinese Yuan (offshore) + + * `COP` - Colombian Peso + + * `COU` - Colombian Real Value Unit + + * `KMF` - Comorian Franc + + * `CDF` - Congolese Franc + + * `CRC` - Costa Rican Colón + + * `HRD` - Croatian Dinar + + * `HRK` - Croatian Kuna + + * `CUC` - Cuban Convertible Peso + + * `CUP` - Cuban Peso + + * `CYP` - Cypriot Pound + + * `CZK` - Czech Koruna + + * `CSK` - Czechoslovak Hard Koruna + + * `DKK` - Danish Krone + + * `DJF` - Djiboutian Franc + + * `DOP` - Dominican Peso + + * `NLG` - Dutch Guilder + + * `XCD` - East Caribbean Dollar + + * `DDM` - East German Mark - * `PGK` - Papua New Guinean Kina + * `ECS` - Ecuadorian Sucre - * `PYG` - Paraguayan Guarani + * `ECV` - Ecuadorian Unit of Constant Value - * `PEI` - Peruvian Inti + * `EGP` - Egyptian Pound - * `PEN` - Peruvian Sol + * `GQE` - Equatorial Guinean Ekwele - * `PES` - Peruvian Sol (1863–1965) + * `ERN` - Eritrean Nakfa - * `PHP` - Philippine Peso + * `EEK` - Estonian Kroon - * `XPT` - Platinum + * `ETB` - Ethiopian Birr - * `PLN` - Polish Zloty + * `EUR` - Euro - * `PLZ` - Polish Zloty (1950–1995) + * `XBA` - European Composite Unit - * `PTE` - Portuguese Escudo + * `XEU` - European Currency Unit - * `GWE` - Portuguese Guinea Escudo + * `XBB` - European Monetary Unit - * `QAR` - Qatari Rial + * `XBC` - European Unit of Account (XBC) - * `XRE` - RINET Funds + * `XBD` - European Unit of Account (XBD) - * `RHD` - Rhodesian Dollar + * `FKP` - Falkland Islands Pound - * `RON` - Romanian Leu + * `FJD` - Fijian Dollar - * `ROL` - Romanian Leu (1952–2006) + * `FIM` - Finnish Markka - * `RUB` - Russian Ruble + * `FRF` - French Franc - * `RUR` - Russian Ruble (1991–1998) + * `XFO` - French Gold Franc - * `RWF` - Rwandan Franc + * `XFU` - French UIC-Franc - * `SVC` - Salvadoran Colón + * `GMD` - Gambian Dalasi - * `WST` - Samoan Tala + * `GEK` - Georgian Kupon Larit - * `SAR` - Saudi Riyal + * `GEL` - Georgian Lari - * `RSD` - Serbian Dinar + * `DEM` - German Mark - * `CSD` - Serbian Dinar (2002–2006) + * `GHS` - Ghanaian Cedi - * `SCR` - Seychellois Rupee + * `GHC` - Ghanaian Cedi (1979–2007) - * `SLL` - Sierra Leonean Leone + * `GIP` - Gibraltar Pound - * `XAG` - Silver + * `XAU` - Gold - * `SGD` - Singapore Dollar + * `GRD` - Greek Drachma - * `SKK` - Slovak Koruna + * `GTQ` - Guatemalan Quetzal - * `SIT` - Slovenian Tolar + * `GWP` - Guinea-Bissau Peso - * `SBD` - Solomon Islands Dollar + * `GNF` - Guinean Franc - * `SOS` - Somali Shilling + * `GNS` - Guinean Syli - * `ZAR` - South African Rand + * `GYD` - Guyanaese Dollar - * `ZAL` - South African Rand (financial) + * `HTG` - Haitian Gourde - * `KRH` - South Korean Hwan (1953–1962) + * `HNL` - Honduran Lempira - * `KRW` - South Korean Won + * `HKD` - Hong Kong Dollar - * `KRO` - South Korean Won (1945–1953) + * `HUF` - Hungarian Forint - * `SSP` - South Sudanese Pound + * `IMP` - IMP - * `SUR` - Soviet Rouble + * `ISK` - Icelandic Króna - * `ESP` - Spanish Peseta + * `ISJ` - Icelandic Króna (1918–1981) - * `ESA` - Spanish Peseta (A account) + * `INR` - Indian Rupee - * `ESB` - Spanish Peseta (convertible account) + * `IDR` - Indonesian Rupiah - * `XDR` - Special Drawing Rights + * `IRR` - Iranian Rial - * `LKR` - Sri Lankan Rupee + * `IQD` - Iraqi Dinar - * `SHP` - St. Helena Pound + * `IEP` - Irish Pound - * `XSU` - Sucre + * `ILS` - Israeli New Shekel - * `SDD` - Sudanese Dinar (1992–2007) + * `ILP` - Israeli Pound - * `SDG` - Sudanese Pound + * `ILR` - Israeli Shekel (1980–1985) - * `SDP` - Sudanese Pound (1957–1998) + * `ITL` - Italian Lira - * `SRD` - Surinamese Dollar + * `JMD` - Jamaican Dollar - * `SRG` - Surinamese Guilder + * `JPY` - Japanese Yen - * `SZL` - Swazi Lilangeni + * `JOD` - Jordanian Dinar - * `SEK` - Swedish Krona + * `KZT` - Kazakhstani Tenge - * `CHF` - Swiss Franc + * `KES` - Kenyan Shilling - * `SYP` - Syrian Pound + * `KWD` - Kuwaiti Dinar - * `STN` - São Tomé & Príncipe Dobra + * `KGS` - Kyrgystani Som - * `STD` - São Tomé & Príncipe Dobra (1977–2017) + * `LAK` - Laotian Kip - * `TVD` - TVD + * `LVL` - Latvian Lats - * `TJR` - Tajikistani Ruble + * `LVR` - Latvian Ruble - * `TJS` - Tajikistani Somoni + * `LBP` - Lebanese Pound - * `TZS` - Tanzanian Shilling + * `LSL` - Lesotho Loti - * `XTS` - Testing Currency Code + * `LRD` - Liberian Dollar - * `THB` - Thai Baht + * `LYD` - Libyan Dinar - * `XXX` - The codes assigned for transactions where no currency is - involved + * `LTL` - Lithuanian Litas - * `TPE` - Timorese Escudo + * `LTT` - Lithuanian Talonas - * `TOP` - Tongan Paʻanga + * `LUL` - Luxembourg Financial Franc - * `TTD` - Trinidad & Tobago Dollar + * `LUC` - Luxembourgian Convertible Franc - * `TND` - Tunisian Dinar + * `LUF` - Luxembourgian Franc - * `TRY` - Turkish Lira + * `MOP` - Macanese Pataca - * `TRL` - Turkish Lira (1922–2005) + * `MKD` - Macedonian Denar - * `TMT` - Turkmenistani Manat + * `MKN` - Macedonian Denar (1992–1993) - * `TMM` - Turkmenistani Manat (1993–2009) + * `MGA` - Malagasy Ariary - * `USD` - US Dollar + * `MGF` - Malagasy Franc - * `USN` - US Dollar (Next day) + * `MWK` - Malawian Kwacha - * `USS` - US Dollar (Same day) + * `MYR` - Malaysian Ringgit - * `UGX` - Ugandan Shilling + * `MVR` - Maldivian Rufiyaa - * `UGS` - Ugandan Shilling (1966–1987) + * `MVP` - Maldivian Rupee (1947–1981) - * `UAH` - Ukrainian Hryvnia + * `MLF` - Malian Franc - * `UAK` - Ukrainian Karbovanets + * `MTL` - Maltese Lira - * `AED` - United Arab Emirates Dirham + * `MTP` - Maltese Pound - * `UYW` - Uruguayan Nominal Wage Index Unit + * `MRU` - Mauritanian Ouguiya - * `UYU` - Uruguayan Peso + * `MRO` - Mauritanian Ouguiya (1973–2017) - * `UYP` - Uruguayan Peso (1975–1993) + * `MUR` - Mauritian Rupee - * `UYI` - Uruguayan Peso (Indexed Units) + * `MXV` - Mexican Investment Unit - * `UZS` - Uzbekistani Som + * `MXN` - Mexican Peso - * `VUV` - Vanuatu Vatu + * `MXP` - Mexican Silver Peso (1861–1992) - * `VES` - Venezuelan Bolívar + * `MDC` - Moldovan Cupon - * `VEB` - Venezuelan Bolívar (1871–2008) + * `MDL` - Moldovan Leu - * `VEF` - Venezuelan Bolívar (2008–2018) + * `MCF` - Monegasque Franc - * `VND` - Vietnamese Dong + * `MNT` - Mongolian Tugrik - * `VNN` - Vietnamese Dong (1978–1985) + * `MAD` - Moroccan Dirham - * `CHE` - WIR Euro + * `MAF` - Moroccan Franc - * `CHW` - WIR Franc + * `MZE` - Mozambican Escudo - * `XOF` - West African CFA Franc + * `MZN` - Mozambican Metical - * `YDD` - Yemeni Dinar + * `MZM` - Mozambican Metical (1980–2006) - * `YER` - Yemeni Rial + * `MMK` - Myanmar Kyat - * `YUN` - Yugoslavian Convertible Dinar (1990–1992) + * `NAD` - Namibian Dollar - * `YUD` - Yugoslavian Hard Dinar (1966–1990) + * `NPR` - Nepalese Rupee - * `YUM` - Yugoslavian New Dinar (1994–2002) + * `ANG` - Netherlands Antillean Guilder - * `YUR` - Yugoslavian Reformed Dinar (1992–1993) + * `TWD` - New Taiwan Dollar - * `ZWN` - ZWN + * `NZD` - New Zealand Dollar - * `ZRN` - Zairean New Zaire (1993–1998) + * `NIO` - Nicaraguan Córdoba - * `ZRZ` - Zairean Zaire (1971–1993) + * `NIC` - Nicaraguan Córdoba (1988–1991) - * `ZMW` - Zambian Kwacha + * `NGN` - Nigerian Naira - * `ZMK` - Zambian Kwacha (1968–2012) + * `KPW` - North Korean Won - * `ZWD` - Zimbabwean Dollar (1980–2008) + * `NOK` - Norwegian Krone - * `ZWR` - Zimbabwean Dollar (2008) + * `OMR` - Omani Rial - * `ZWL` - Zimbabwean Dollar (2009) - description: - type: optional - docs: A brief description or purpose for the expense report - validation: - maxLength: 1024 - accounting_period: - type: optional - docs: The accounting period the report was posted in - validation: - format: uuid - company: - type: optional - docs: The subsidiary that the expense report is created in - tracking_categories: - docs: The related tracking categories associated with the expense report - type: list - remote_was_deleted: - type: optional - docs: >- - Indicates whether or not this object has been deleted in the third - party platform. Full coverage deletion detection is a premium add-on. - Native deletion detection is offered for free with limited coverage. - [Learn - more](https://docs.merge.dev/integrations/hris/supported-features/). - access: read-only - field_mappings: - type: optional> - access: read-only - remote_data: - type: optional> - access: read-only - remote_fields: - type: optional> - access: read-only - source: - openapi: openapi/openapi.yml - ExpenseReportLineAccount: - discriminated: false + * `PKR` - Pakistani Rupee + + * `XPD` - Palladium + + * `PAB` - Panamanian Balboa + + * `PGK` - Papua New Guinean Kina + + * `PYG` - Paraguayan Guarani + + * `PEI` - Peruvian Inti + + * `PEN` - Peruvian Sol + + * `PES` - Peruvian Sol (1863–1965) + + * `PHP` - Philippine Peso + + * `XPT` - Platinum + + * `PLN` - Polish Zloty + + * `PLZ` - Polish Zloty (1950–1995) + + * `PTE` - Portuguese Escudo + + * `GWE` - Portuguese Guinea Escudo + + * `QAR` - Qatari Rial + + * `XRE` - RINET Funds + + * `RHD` - Rhodesian Dollar + + * `RON` - Romanian Leu + + * `ROL` - Romanian Leu (1952–2006) + + * `RUB` - Russian Ruble + + * `RUR` - Russian Ruble (1991–1998) + + * `RWF` - Rwandan Franc + + * `SVC` - Salvadoran Colón + + * `WST` - Samoan Tala + + * `SAR` - Saudi Riyal + + * `RSD` - Serbian Dinar + + * `CSD` - Serbian Dinar (2002–2006) + + * `SCR` - Seychellois Rupee + + * `SLL` - Sierra Leonean Leone + + * `XAG` - Silver + + * `SGD` - Singapore Dollar + + * `SKK` - Slovak Koruna + + * `SIT` - Slovenian Tolar + + * `SBD` - Solomon Islands Dollar + + * `SOS` - Somali Shilling + + * `ZAR` - South African Rand + + * `ZAL` - South African Rand (financial) + + * `KRH` - South Korean Hwan (1953–1962) + + * `KRW` - South Korean Won + + * `KRO` - South Korean Won (1945–1953) + + * `SSP` - South Sudanese Pound + + * `SUR` - Soviet Rouble + + * `ESP` - Spanish Peseta + + * `ESA` - Spanish Peseta (A account) + + * `ESB` - Spanish Peseta (convertible account) + + * `XDR` - Special Drawing Rights + + * `LKR` - Sri Lankan Rupee + + * `SHP` - St. Helena Pound + + * `XSU` - Sucre + + * `SDD` - Sudanese Dinar (1992–2007) + + * `SDG` - Sudanese Pound + + * `SDP` - Sudanese Pound (1957–1998) + + * `SRD` - Surinamese Dollar + + * `SRG` - Surinamese Guilder + + * `SZL` - Swazi Lilangeni + + * `SEK` - Swedish Krona + + * `CHF` - Swiss Franc + + * `SYP` - Syrian Pound + + * `STN` - São Tomé & Príncipe Dobra + + * `STD` - São Tomé & Príncipe Dobra (1977–2017) + + * `TVD` - TVD + + * `TJR` - Tajikistani Ruble + + * `TJS` - Tajikistani Somoni + + * `TZS` - Tanzanian Shilling + + * `XTS` - Testing Currency Code + + * `THB` - Thai Baht + + * `XXX` - The codes assigned for transactions where no currency is + involved + + * `TPE` - Timorese Escudo + + * `TOP` - Tongan Paʻanga + + * `TTD` - Trinidad & Tobago Dollar + + * `TND` - Tunisian Dinar + + * `TRY` - Turkish Lira + + * `TRL` - Turkish Lira (1922–2005) + + * `TMT` - Turkmenistani Manat + + * `TMM` - Turkmenistani Manat (1993–2009) + + * `USD` - US Dollar + + * `USN` - US Dollar (Next day) + + * `USS` - US Dollar (Same day) + + * `UGX` - Ugandan Shilling + + * `UGS` - Ugandan Shilling (1966–1987) + + * `UAH` - Ukrainian Hryvnia + + * `UAK` - Ukrainian Karbovanets + + * `AED` - United Arab Emirates Dirham + + * `UYW` - Uruguayan Nominal Wage Index Unit + + * `UYU` - Uruguayan Peso + + * `UYP` - Uruguayan Peso (1975–1993) + + * `UYI` - Uruguayan Peso (Indexed Units) + + * `UZS` - Uzbekistani Som + + * `VUV` - Vanuatu Vatu + + * `VES` - Venezuelan Bolívar + + * `VEB` - Venezuelan Bolívar (1871–2008) + + * `VEF` - Venezuelan Bolívar (2008–2018) + + * `VND` - Vietnamese Dong + + * `VNN` - Vietnamese Dong (1978–1985) + + * `CHE` - WIR Euro + + * `CHW` - WIR Franc + + * `XOF` - West African CFA Franc + + * `YDD` - Yemeni Dinar + + * `YER` - Yemeni Rial + + * `YUN` - Yugoslavian Convertible Dinar (1990–1992) + + * `YUD` - Yugoslavian Hard Dinar (1966–1990) + + * `YUM` - Yugoslavian New Dinar (1994–2002) + + * `YUR` - Yugoslavian Reformed Dinar (1992–1993) + + * `ZWN` - ZWN + + * `ZRN` - Zairean New Zaire (1993–1998) + + * `ZRZ` - Zairean Zaire (1971–1993) + + * `ZMW` - Zambian Kwacha + + * `ZMK` - Zambian Kwacha (1968–2012) + + * `ZWD` - Zimbabwean Dollar (1980–2008) + + * `ZWR` - Zimbabwean Dollar (2008) + + * `ZWL` - Zimbabwean Dollar (2009) union: - - type: string - validation: - format: uuid - - Account + - TransactionCurrencyEnum + - string source: openapi: openapi/openapi.yml inline: true - ExpenseReportLineEmployee: + ExpenseReportLineRequestEmployee: discriminated: false docs: >- Identifier for the employee who submitted or is associated with the @@ -21200,7 +23902,7 @@ types: source: openapi: openapi/openapi.yml inline: true - ExpenseReportLineProject: + ExpenseReportLineRequestProject: discriminated: false union: - type: string @@ -21210,7 +23912,7 @@ types: source: openapi: openapi/openapi.yml inline: true - ExpenseReportLineCompany: + ExpenseReportLineRequestCompany: discriminated: false docs: The subsidiary that the expense report is created in union: @@ -21221,7 +23923,7 @@ types: source: openapi: openapi/openapi.yml inline: true - ExpenseReportLineContact: + ExpenseReportLineRequestContact: discriminated: false union: - type: string @@ -21231,7 +23933,7 @@ types: source: openapi: openapi/openapi.yml inline: true - ExpenseReportLineTaxRate: + ExpenseReportLineRequestTaxRate: discriminated: false union: - type: string @@ -21241,7 +23943,7 @@ types: source: openapi: openapi/openapi.yml inline: true - ExpenseReportLine: + ExpenseReportLineRequest: docs: >- # The ExpenseReportLine Object @@ -21258,23 +23960,10 @@ types: Fetch from the `GET ExpenseReport` endpoint and expand the lines field to view all line items in the expense report. properties: - id: - type: optional - validation: - format: uuid - access: read-only remote_id: type: optional docs: The third-party API ID of the matching object. - created_at: - type: optional - docs: The datetime that this object was created by Merge. - access: read-only - modified_at: - type: optional - docs: The datetime that this object was modified by Merge. - access: read-only - account: optional + account: optional description: type: optional docs: Description of the individual expense. @@ -21287,7 +23976,7 @@ types: type: optional docs: The amount of the expense for the line item. currency: - type: optional + type: optional docs: >- Currency of the expense line (if different from the report currency). @@ -21918,15 +24607,15 @@ types: (Department, Location, Class, Expense Category) type: list employee: - type: optional + type: optional docs: >- Identifier for the employee who submitted or is associated with the expense report - project: optional + project: optional company: - type: optional + type: optional docs: The subsidiary that the expense report is created in - contact: optional + contact: optional quantity: type: optional docs: Quantity for the expense line (e.g., miles driven, items purchased). @@ -21944,32 +24633,19 @@ types: inclusive_of_tax: type: optional docs: Whether the amount is inclusive of tax. - tax_rate: optional - remote_was_deleted: - type: optional - docs: >- - Indicates whether or not this object has been deleted in the third - party platform. Full coverage deletion detection is a premium add-on. - Native deletion detection is offered for free with limited coverage. - [Learn - more](https://docs.merge.dev/integrations/hris/supported-features/). - access: read-only + tax_rate: optional + integration_params: + type: optional> + access: write-only + linked_account_params: + type: optional> + access: write-only remote_fields: - type: optional> - access: read-only - source: - openapi: openapi/openapi.yml - ExpenseReportLineRequestAccount: - discriminated: false - union: - - type: string - validation: - format: uuid - - Account + type: optional> + access: write-only source: openapi: openapi/openapi.yml - inline: true - ExpenseReportLineRequestEmployee: + ExpenseReportRequestEmployee: discriminated: false docs: >- Identifier for the employee who submitted or is associated with the @@ -21982,759 +24658,627 @@ types: source: openapi: openapi/openapi.yml inline: true - ExpenseReportLineRequestProject: - discriminated: false - union: - - type: string - validation: - format: uuid - - Project - source: - openapi: openapi/openapi.yml - inline: true - ExpenseReportLineRequestCompany: - discriminated: false - docs: The subsidiary that the expense report is created in - union: - - type: string - validation: - format: uuid - - CompanyInfo - source: - openapi: openapi/openapi.yml - inline: true - ExpenseReportLineRequestContact: - discriminated: false - union: - - type: string - validation: - format: uuid - - Contact - source: - openapi: openapi/openapi.yml - inline: true - ExpenseReportLineRequestTaxRate: + ExpenseReportRequestCurrency: discriminated: false - union: - - type: string - validation: - format: uuid - - TaxRate - source: - openapi: openapi/openapi.yml - inline: true - ExpenseReportLineRequest: docs: >- - # The ExpenseReportLine Object - - ### Description - - The `ExpenseReportLine` object represents an individual line item within - an expense report, containing details about - - a specific expense such as amount, description, and associated metadata. - - - ### Usage Example - - Fetch from the `GET ExpenseReport` endpoint and expand the lines field to - view all line items in the expense report. - properties: - remote_id: - type: optional - docs: The third-party API ID of the matching object. - account: optional - description: - type: optional - docs: Description of the individual expense. - validation: - maxLength: 1024 - expense_date: - type: optional - docs: The date the individual expense was incurred. - amount: - type: optional - docs: The amount of the expense for the line item. - currency: - type: optional - docs: >- - Currency of the expense line (if different from the report currency). + Currency code for the expense report - * `XUA` - ADB Unit of Account + * `XUA` - ADB Unit of Account - * `AFN` - Afghan Afghani + * `AFN` - Afghan Afghani - * `AFA` - Afghan Afghani (1927–2002) + * `AFA` - Afghan Afghani (1927–2002) - * `ALL` - Albanian Lek + * `ALL` - Albanian Lek - * `ALK` - Albanian Lek (1946–1965) + * `ALK` - Albanian Lek (1946–1965) - * `DZD` - Algerian Dinar + * `DZD` - Algerian Dinar - * `ADP` - Andorran Peseta + * `ADP` - Andorran Peseta - * `AOA` - Angolan Kwanza + * `AOA` - Angolan Kwanza - * `AOK` - Angolan Kwanza (1977–1991) + * `AOK` - Angolan Kwanza (1977–1991) - * `AON` - Angolan New Kwanza (1990–2000) + * `AON` - Angolan New Kwanza (1990–2000) - * `AOR` - Angolan Readjusted Kwanza (1995–1999) + * `AOR` - Angolan Readjusted Kwanza (1995–1999) - * `ARA` - Argentine Austral + * `ARA` - Argentine Austral - * `ARS` - Argentine Peso + * `ARS` - Argentine Peso - * `ARM` - Argentine Peso (1881–1970) + * `ARM` - Argentine Peso (1881–1970) - * `ARP` - Argentine Peso (1983–1985) + * `ARP` - Argentine Peso (1983–1985) - * `ARL` - Argentine Peso Ley (1970–1983) + * `ARL` - Argentine Peso Ley (1970–1983) - * `AMD` - Armenian Dram + * `AMD` - Armenian Dram - * `AWG` - Aruban Florin + * `AWG` - Aruban Florin - * `AUD` - Australian Dollar + * `AUD` - Australian Dollar - * `ATS` - Austrian Schilling + * `ATS` - Austrian Schilling - * `AZN` - Azerbaijani Manat + * `AZN` - Azerbaijani Manat - * `AZM` - Azerbaijani Manat (1993–2006) + * `AZM` - Azerbaijani Manat (1993–2006) - * `BSD` - Bahamian Dollar + * `BSD` - Bahamian Dollar - * `BHD` - Bahraini Dinar + * `BHD` - Bahraini Dinar - * `BDT` - Bangladeshi Taka + * `BDT` - Bangladeshi Taka - * `BBD` - Barbadian Dollar + * `BBD` - Barbadian Dollar - * `BYN` - Belarusian Ruble + * `BYN` - Belarusian Ruble - * `BYB` - Belarusian Ruble (1994–1999) + * `BYB` - Belarusian Ruble (1994–1999) - * `BYR` - Belarusian Ruble (2000–2016) + * `BYR` - Belarusian Ruble (2000–2016) - * `BEF` - Belgian Franc + * `BEF` - Belgian Franc - * `BEC` - Belgian Franc (convertible) + * `BEC` - Belgian Franc (convertible) - * `BEL` - Belgian Franc (financial) + * `BEL` - Belgian Franc (financial) - * `BZD` - Belize Dollar + * `BZD` - Belize Dollar - * `BMD` - Bermudan Dollar + * `BMD` - Bermudan Dollar - * `BTN` - Bhutanese Ngultrum + * `BTN` - Bhutanese Ngultrum - * `BOB` - Bolivian Boliviano + * `BOB` - Bolivian Boliviano - * `BOL` - Bolivian Boliviano (1863–1963) + * `BOL` - Bolivian Boliviano (1863–1963) - * `BOV` - Bolivian Mvdol + * `BOV` - Bolivian Mvdol - * `BOP` - Bolivian Peso + * `BOP` - Bolivian Peso - * `BAM` - Bosnia-Herzegovina Convertible Mark + * `BAM` - Bosnia-Herzegovina Convertible Mark - * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) + * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) - * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) + * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) - * `BWP` - Botswanan Pula + * `BWP` - Botswanan Pula - * `BRC` - Brazilian Cruzado (1986–1989) + * `BRC` - Brazilian Cruzado (1986–1989) - * `BRZ` - Brazilian Cruzeiro (1942–1967) + * `BRZ` - Brazilian Cruzeiro (1942–1967) - * `BRE` - Brazilian Cruzeiro (1990–1993) + * `BRE` - Brazilian Cruzeiro (1990–1993) - * `BRR` - Brazilian Cruzeiro (1993–1994) + * `BRR` - Brazilian Cruzeiro (1993–1994) - * `BRN` - Brazilian New Cruzado (1989–1990) + * `BRN` - Brazilian New Cruzado (1989–1990) - * `BRB` - Brazilian New Cruzeiro (1967–1986) + * `BRB` - Brazilian New Cruzeiro (1967–1986) - * `BRL` - Brazilian Real + * `BRL` - Brazilian Real - * `GBP` - British Pound + * `GBP` - British Pound - * `BND` - Brunei Dollar + * `BND` - Brunei Dollar - * `BGL` - Bulgarian Hard Lev + * `BGL` - Bulgarian Hard Lev - * `BGN` - Bulgarian Lev + * `BGN` - Bulgarian Lev - * `BGO` - Bulgarian Lev (1879–1952) + * `BGO` - Bulgarian Lev (1879–1952) - * `BGM` - Bulgarian Socialist Lev + * `BGM` - Bulgarian Socialist Lev - * `BUK` - Burmese Kyat + * `BUK` - Burmese Kyat - * `BIF` - Burundian Franc + * `BIF` - Burundian Franc - * `XPF` - CFP Franc + * `XPF` - CFP Franc - * `KHR` - Cambodian Riel + * `KHR` - Cambodian Riel - * `CAD` - Canadian Dollar + * `CAD` - Canadian Dollar - * `CVE` - Cape Verdean Escudo + * `CVE` - Cape Verdean Escudo - * `KYD` - Cayman Islands Dollar + * `KYD` - Cayman Islands Dollar - * `XAF` - Central African CFA Franc + * `XAF` - Central African CFA Franc - * `CLE` - Chilean Escudo + * `CLE` - Chilean Escudo - * `CLP` - Chilean Peso + * `CLP` - Chilean Peso - * `CLF` - Chilean Unit of Account (UF) + * `CLF` - Chilean Unit of Account (UF) - * `CNX` - Chinese People’s Bank Dollar + * `CNX` - Chinese People’s Bank Dollar - * `CNY` - Chinese Yuan + * `CNY` - Chinese Yuan - * `CNH` - Chinese Yuan (offshore) + * `CNH` - Chinese Yuan (offshore) - * `COP` - Colombian Peso + * `COP` - Colombian Peso - * `COU` - Colombian Real Value Unit + * `COU` - Colombian Real Value Unit - * `KMF` - Comorian Franc + * `KMF` - Comorian Franc - * `CDF` - Congolese Franc + * `CDF` - Congolese Franc - * `CRC` - Costa Rican Colón + * `CRC` - Costa Rican Colón - * `HRD` - Croatian Dinar + * `HRD` - Croatian Dinar - * `HRK` - Croatian Kuna + * `HRK` - Croatian Kuna - * `CUC` - Cuban Convertible Peso + * `CUC` - Cuban Convertible Peso - * `CUP` - Cuban Peso + * `CUP` - Cuban Peso - * `CYP` - Cypriot Pound + * `CYP` - Cypriot Pound - * `CZK` - Czech Koruna + * `CZK` - Czech Koruna - * `CSK` - Czechoslovak Hard Koruna + * `CSK` - Czechoslovak Hard Koruna - * `DKK` - Danish Krone + * `DKK` - Danish Krone - * `DJF` - Djiboutian Franc + * `DJF` - Djiboutian Franc - * `DOP` - Dominican Peso + * `DOP` - Dominican Peso - * `NLG` - Dutch Guilder + * `NLG` - Dutch Guilder - * `XCD` - East Caribbean Dollar + * `XCD` - East Caribbean Dollar - * `DDM` - East German Mark + * `DDM` - East German Mark - * `ECS` - Ecuadorian Sucre + * `ECS` - Ecuadorian Sucre - * `ECV` - Ecuadorian Unit of Constant Value + * `ECV` - Ecuadorian Unit of Constant Value - * `EGP` - Egyptian Pound + * `EGP` - Egyptian Pound - * `GQE` - Equatorial Guinean Ekwele + * `GQE` - Equatorial Guinean Ekwele - * `ERN` - Eritrean Nakfa + * `ERN` - Eritrean Nakfa - * `EEK` - Estonian Kroon + * `EEK` - Estonian Kroon - * `ETB` - Ethiopian Birr + * `ETB` - Ethiopian Birr - * `EUR` - Euro + * `EUR` - Euro - * `XBA` - European Composite Unit + * `XBA` - European Composite Unit - * `XEU` - European Currency Unit + * `XEU` - European Currency Unit - * `XBB` - European Monetary Unit + * `XBB` - European Monetary Unit - * `XBC` - European Unit of Account (XBC) + * `XBC` - European Unit of Account (XBC) - * `XBD` - European Unit of Account (XBD) + * `XBD` - European Unit of Account (XBD) - * `FKP` - Falkland Islands Pound + * `FKP` - Falkland Islands Pound - * `FJD` - Fijian Dollar + * `FJD` - Fijian Dollar - * `FIM` - Finnish Markka + * `FIM` - Finnish Markka - * `FRF` - French Franc + * `FRF` - French Franc - * `XFO` - French Gold Franc + * `XFO` - French Gold Franc - * `XFU` - French UIC-Franc + * `XFU` - French UIC-Franc - * `GMD` - Gambian Dalasi + * `GMD` - Gambian Dalasi - * `GEK` - Georgian Kupon Larit + * `GEK` - Georgian Kupon Larit - * `GEL` - Georgian Lari + * `GEL` - Georgian Lari - * `DEM` - German Mark + * `DEM` - German Mark - * `GHS` - Ghanaian Cedi + * `GHS` - Ghanaian Cedi - * `GHC` - Ghanaian Cedi (1979–2007) + * `GHC` - Ghanaian Cedi (1979–2007) - * `GIP` - Gibraltar Pound + * `GIP` - Gibraltar Pound - * `XAU` - Gold + * `XAU` - Gold - * `GRD` - Greek Drachma + * `GRD` - Greek Drachma - * `GTQ` - Guatemalan Quetzal + * `GTQ` - Guatemalan Quetzal - * `GWP` - Guinea-Bissau Peso + * `GWP` - Guinea-Bissau Peso - * `GNF` - Guinean Franc + * `GNF` - Guinean Franc - * `GNS` - Guinean Syli + * `GNS` - Guinean Syli - * `GYD` - Guyanaese Dollar + * `GYD` - Guyanaese Dollar - * `HTG` - Haitian Gourde + * `HTG` - Haitian Gourde - * `HNL` - Honduran Lempira + * `HNL` - Honduran Lempira - * `HKD` - Hong Kong Dollar + * `HKD` - Hong Kong Dollar - * `HUF` - Hungarian Forint + * `HUF` - Hungarian Forint - * `IMP` - IMP + * `IMP` - IMP - * `ISK` - Icelandic Króna + * `ISK` - Icelandic Króna - * `ISJ` - Icelandic Króna (1918–1981) + * `ISJ` - Icelandic Króna (1918–1981) - * `INR` - Indian Rupee + * `INR` - Indian Rupee - * `IDR` - Indonesian Rupiah + * `IDR` - Indonesian Rupiah - * `IRR` - Iranian Rial + * `IRR` - Iranian Rial - * `IQD` - Iraqi Dinar + * `IQD` - Iraqi Dinar - * `IEP` - Irish Pound + * `IEP` - Irish Pound - * `ILS` - Israeli New Shekel + * `ILS` - Israeli New Shekel - * `ILP` - Israeli Pound + * `ILP` - Israeli Pound - * `ILR` - Israeli Shekel (1980–1985) + * `ILR` - Israeli Shekel (1980–1985) - * `ITL` - Italian Lira + * `ITL` - Italian Lira - * `JMD` - Jamaican Dollar + * `JMD` - Jamaican Dollar - * `JPY` - Japanese Yen + * `JPY` - Japanese Yen - * `JOD` - Jordanian Dinar + * `JOD` - Jordanian Dinar - * `KZT` - Kazakhstani Tenge + * `KZT` - Kazakhstani Tenge - * `KES` - Kenyan Shilling + * `KES` - Kenyan Shilling - * `KWD` - Kuwaiti Dinar + * `KWD` - Kuwaiti Dinar - * `KGS` - Kyrgystani Som + * `KGS` - Kyrgystani Som - * `LAK` - Laotian Kip + * `LAK` - Laotian Kip - * `LVL` - Latvian Lats + * `LVL` - Latvian Lats - * `LVR` - Latvian Ruble + * `LVR` - Latvian Ruble - * `LBP` - Lebanese Pound + * `LBP` - Lebanese Pound - * `LSL` - Lesotho Loti + * `LSL` - Lesotho Loti - * `LRD` - Liberian Dollar + * `LRD` - Liberian Dollar - * `LYD` - Libyan Dinar + * `LYD` - Libyan Dinar - * `LTL` - Lithuanian Litas + * `LTL` - Lithuanian Litas - * `LTT` - Lithuanian Talonas + * `LTT` - Lithuanian Talonas - * `LUL` - Luxembourg Financial Franc + * `LUL` - Luxembourg Financial Franc - * `LUC` - Luxembourgian Convertible Franc + * `LUC` - Luxembourgian Convertible Franc - * `LUF` - Luxembourgian Franc + * `LUF` - Luxembourgian Franc - * `MOP` - Macanese Pataca + * `MOP` - Macanese Pataca - * `MKD` - Macedonian Denar + * `MKD` - Macedonian Denar - * `MKN` - Macedonian Denar (1992–1993) + * `MKN` - Macedonian Denar (1992–1993) - * `MGA` - Malagasy Ariary + * `MGA` - Malagasy Ariary - * `MGF` - Malagasy Franc + * `MGF` - Malagasy Franc - * `MWK` - Malawian Kwacha + * `MWK` - Malawian Kwacha - * `MYR` - Malaysian Ringgit + * `MYR` - Malaysian Ringgit - * `MVR` - Maldivian Rufiyaa + * `MVR` - Maldivian Rufiyaa - * `MVP` - Maldivian Rupee (1947–1981) + * `MVP` - Maldivian Rupee (1947–1981) - * `MLF` - Malian Franc + * `MLF` - Malian Franc - * `MTL` - Maltese Lira + * `MTL` - Maltese Lira - * `MTP` - Maltese Pound + * `MTP` - Maltese Pound - * `MRU` - Mauritanian Ouguiya + * `MRU` - Mauritanian Ouguiya - * `MRO` - Mauritanian Ouguiya (1973–2017) + * `MRO` - Mauritanian Ouguiya (1973–2017) - * `MUR` - Mauritian Rupee + * `MUR` - Mauritian Rupee - * `MXV` - Mexican Investment Unit + * `MXV` - Mexican Investment Unit - * `MXN` - Mexican Peso + * `MXN` - Mexican Peso - * `MXP` - Mexican Silver Peso (1861–1992) + * `MXP` - Mexican Silver Peso (1861–1992) - * `MDC` - Moldovan Cupon + * `MDC` - Moldovan Cupon - * `MDL` - Moldovan Leu + * `MDL` - Moldovan Leu - * `MCF` - Monegasque Franc + * `MCF` - Monegasque Franc - * `MNT` - Mongolian Tugrik + * `MNT` - Mongolian Tugrik - * `MAD` - Moroccan Dirham + * `MAD` - Moroccan Dirham - * `MAF` - Moroccan Franc + * `MAF` - Moroccan Franc - * `MZE` - Mozambican Escudo + * `MZE` - Mozambican Escudo - * `MZN` - Mozambican Metical + * `MZN` - Mozambican Metical - * `MZM` - Mozambican Metical (1980–2006) + * `MZM` - Mozambican Metical (1980–2006) - * `MMK` - Myanmar Kyat + * `MMK` - Myanmar Kyat - * `NAD` - Namibian Dollar + * `NAD` - Namibian Dollar - * `NPR` - Nepalese Rupee + * `NPR` - Nepalese Rupee - * `ANG` - Netherlands Antillean Guilder + * `ANG` - Netherlands Antillean Guilder - * `TWD` - New Taiwan Dollar + * `TWD` - New Taiwan Dollar - * `NZD` - New Zealand Dollar + * `NZD` - New Zealand Dollar - * `NIO` - Nicaraguan Córdoba + * `NIO` - Nicaraguan Córdoba - * `NIC` - Nicaraguan Córdoba (1988–1991) + * `NIC` - Nicaraguan Córdoba (1988–1991) - * `NGN` - Nigerian Naira + * `NGN` - Nigerian Naira - * `KPW` - North Korean Won + * `KPW` - North Korean Won - * `NOK` - Norwegian Krone + * `NOK` - Norwegian Krone - * `OMR` - Omani Rial + * `OMR` - Omani Rial - * `PKR` - Pakistani Rupee + * `PKR` - Pakistani Rupee - * `XPD` - Palladium + * `XPD` - Palladium - * `PAB` - Panamanian Balboa + * `PAB` - Panamanian Balboa - * `PGK` - Papua New Guinean Kina + * `PGK` - Papua New Guinean Kina - * `PYG` - Paraguayan Guarani + * `PYG` - Paraguayan Guarani - * `PEI` - Peruvian Inti + * `PEI` - Peruvian Inti - * `PEN` - Peruvian Sol + * `PEN` - Peruvian Sol - * `PES` - Peruvian Sol (1863–1965) + * `PES` - Peruvian Sol (1863–1965) - * `PHP` - Philippine Peso + * `PHP` - Philippine Peso - * `XPT` - Platinum + * `XPT` - Platinum - * `PLN` - Polish Zloty + * `PLN` - Polish Zloty - * `PLZ` - Polish Zloty (1950–1995) + * `PLZ` - Polish Zloty (1950–1995) - * `PTE` - Portuguese Escudo + * `PTE` - Portuguese Escudo - * `GWE` - Portuguese Guinea Escudo + * `GWE` - Portuguese Guinea Escudo - * `QAR` - Qatari Rial + * `QAR` - Qatari Rial - * `XRE` - RINET Funds + * `XRE` - RINET Funds - * `RHD` - Rhodesian Dollar + * `RHD` - Rhodesian Dollar - * `RON` - Romanian Leu + * `RON` - Romanian Leu - * `ROL` - Romanian Leu (1952–2006) + * `ROL` - Romanian Leu (1952–2006) - * `RUB` - Russian Ruble + * `RUB` - Russian Ruble - * `RUR` - Russian Ruble (1991–1998) + * `RUR` - Russian Ruble (1991–1998) - * `RWF` - Rwandan Franc + * `RWF` - Rwandan Franc - * `SVC` - Salvadoran Colón + * `SVC` - Salvadoran Colón - * `WST` - Samoan Tala + * `WST` - Samoan Tala - * `SAR` - Saudi Riyal + * `SAR` - Saudi Riyal - * `RSD` - Serbian Dinar + * `RSD` - Serbian Dinar - * `CSD` - Serbian Dinar (2002–2006) + * `CSD` - Serbian Dinar (2002–2006) - * `SCR` - Seychellois Rupee + * `SCR` - Seychellois Rupee - * `SLL` - Sierra Leonean Leone + * `SLL` - Sierra Leonean Leone - * `XAG` - Silver + * `XAG` - Silver - * `SGD` - Singapore Dollar + * `SGD` - Singapore Dollar - * `SKK` - Slovak Koruna + * `SKK` - Slovak Koruna - * `SIT` - Slovenian Tolar + * `SIT` - Slovenian Tolar - * `SBD` - Solomon Islands Dollar + * `SBD` - Solomon Islands Dollar - * `SOS` - Somali Shilling + * `SOS` - Somali Shilling - * `ZAR` - South African Rand + * `ZAR` - South African Rand - * `ZAL` - South African Rand (financial) + * `ZAL` - South African Rand (financial) - * `KRH` - South Korean Hwan (1953–1962) + * `KRH` - South Korean Hwan (1953–1962) - * `KRW` - South Korean Won + * `KRW` - South Korean Won - * `KRO` - South Korean Won (1945–1953) + * `KRO` - South Korean Won (1945–1953) - * `SSP` - South Sudanese Pound + * `SSP` - South Sudanese Pound - * `SUR` - Soviet Rouble + * `SUR` - Soviet Rouble - * `ESP` - Spanish Peseta + * `ESP` - Spanish Peseta - * `ESA` - Spanish Peseta (A account) + * `ESA` - Spanish Peseta (A account) - * `ESB` - Spanish Peseta (convertible account) + * `ESB` - Spanish Peseta (convertible account) - * `XDR` - Special Drawing Rights + * `XDR` - Special Drawing Rights - * `LKR` - Sri Lankan Rupee + * `LKR` - Sri Lankan Rupee - * `SHP` - St. Helena Pound + * `SHP` - St. Helena Pound - * `XSU` - Sucre + * `XSU` - Sucre - * `SDD` - Sudanese Dinar (1992–2007) + * `SDD` - Sudanese Dinar (1992–2007) - * `SDG` - Sudanese Pound + * `SDG` - Sudanese Pound - * `SDP` - Sudanese Pound (1957–1998) + * `SDP` - Sudanese Pound (1957–1998) - * `SRD` - Surinamese Dollar + * `SRD` - Surinamese Dollar - * `SRG` - Surinamese Guilder + * `SRG` - Surinamese Guilder - * `SZL` - Swazi Lilangeni + * `SZL` - Swazi Lilangeni - * `SEK` - Swedish Krona + * `SEK` - Swedish Krona - * `CHF` - Swiss Franc + * `CHF` - Swiss Franc - * `SYP` - Syrian Pound + * `SYP` - Syrian Pound - * `STN` - São Tomé & Príncipe Dobra + * `STN` - São Tomé & Príncipe Dobra - * `STD` - São Tomé & Príncipe Dobra (1977–2017) + * `STD` - São Tomé & Príncipe Dobra (1977–2017) - * `TVD` - TVD + * `TVD` - TVD - * `TJR` - Tajikistani Ruble + * `TJR` - Tajikistani Ruble - * `TJS` - Tajikistani Somoni + * `TJS` - Tajikistani Somoni - * `TZS` - Tanzanian Shilling + * `TZS` - Tanzanian Shilling - * `XTS` - Testing Currency Code + * `XTS` - Testing Currency Code - * `THB` - Thai Baht + * `THB` - Thai Baht - * `XXX` - The codes assigned for transactions where no currency is - involved + * `XXX` - The codes assigned for transactions where no currency is + involved - * `TPE` - Timorese Escudo + * `TPE` - Timorese Escudo - * `TOP` - Tongan Paʻanga + * `TOP` - Tongan Paʻanga - * `TTD` - Trinidad & Tobago Dollar + * `TTD` - Trinidad & Tobago Dollar - * `TND` - Tunisian Dinar + * `TND` - Tunisian Dinar - * `TRY` - Turkish Lira + * `TRY` - Turkish Lira - * `TRL` - Turkish Lira (1922–2005) + * `TRL` - Turkish Lira (1922–2005) - * `TMT` - Turkmenistani Manat + * `TMT` - Turkmenistani Manat - * `TMM` - Turkmenistani Manat (1993–2009) + * `TMM` - Turkmenistani Manat (1993–2009) - * `USD` - US Dollar + * `USD` - US Dollar - * `USN` - US Dollar (Next day) + * `USN` - US Dollar (Next day) - * `USS` - US Dollar (Same day) + * `USS` - US Dollar (Same day) - * `UGX` - Ugandan Shilling + * `UGX` - Ugandan Shilling - * `UGS` - Ugandan Shilling (1966–1987) + * `UGS` - Ugandan Shilling (1966–1987) - * `UAH` - Ukrainian Hryvnia + * `UAH` - Ukrainian Hryvnia - * `UAK` - Ukrainian Karbovanets + * `UAK` - Ukrainian Karbovanets - * `AED` - United Arab Emirates Dirham + * `AED` - United Arab Emirates Dirham - * `UYW` - Uruguayan Nominal Wage Index Unit + * `UYW` - Uruguayan Nominal Wage Index Unit - * `UYU` - Uruguayan Peso + * `UYU` - Uruguayan Peso - * `UYP` - Uruguayan Peso (1975–1993) + * `UYP` - Uruguayan Peso (1975–1993) - * `UYI` - Uruguayan Peso (Indexed Units) + * `UYI` - Uruguayan Peso (Indexed Units) - * `UZS` - Uzbekistani Som + * `UZS` - Uzbekistani Som - * `VUV` - Vanuatu Vatu + * `VUV` - Vanuatu Vatu - * `VES` - Venezuelan Bolívar + * `VES` - Venezuelan Bolívar - * `VEB` - Venezuelan Bolívar (1871–2008) + * `VEB` - Venezuelan Bolívar (1871–2008) - * `VEF` - Venezuelan Bolívar (2008–2018) + * `VEF` - Venezuelan Bolívar (2008–2018) - * `VND` - Vietnamese Dong + * `VND` - Vietnamese Dong - * `VNN` - Vietnamese Dong (1978–1985) + * `VNN` - Vietnamese Dong (1978–1985) - * `CHE` - WIR Euro + * `CHE` - WIR Euro - * `CHW` - WIR Franc + * `CHW` - WIR Franc - * `XOF` - West African CFA Franc + * `XOF` - West African CFA Franc - * `YDD` - Yemeni Dinar + * `YDD` - Yemeni Dinar - * `YER` - Yemeni Rial + * `YER` - Yemeni Rial - * `YUN` - Yugoslavian Convertible Dinar (1990–1992) + * `YUN` - Yugoslavian Convertible Dinar (1990–1992) - * `YUD` - Yugoslavian Hard Dinar (1966–1990) + * `YUD` - Yugoslavian Hard Dinar (1966–1990) - * `YUM` - Yugoslavian New Dinar (1994–2002) + * `YUM` - Yugoslavian New Dinar (1994–2002) - * `YUR` - Yugoslavian Reformed Dinar (1992–1993) + * `YUR` - Yugoslavian Reformed Dinar (1992–1993) - * `ZWN` - ZWN + * `ZWN` - ZWN - * `ZRN` - Zairean New Zaire (1993–1998) + * `ZRN` - Zairean New Zaire (1993–1998) - * `ZRZ` - Zairean Zaire (1971–1993) + * `ZRZ` - Zairean Zaire (1971–1993) - * `ZMW` - Zambian Kwacha + * `ZMW` - Zambian Kwacha - * `ZMK` - Zambian Kwacha (1968–2012) + * `ZMK` - Zambian Kwacha (1968–2012) - * `ZWD` - Zimbabwean Dollar (1980–2008) + * `ZWD` - Zimbabwean Dollar (1980–2008) - * `ZWR` - Zimbabwean Dollar (2008) + * `ZWR` - Zimbabwean Dollar (2008) - * `ZWL` - Zimbabwean Dollar (2009) - exchange_rate: - type: optional - docs: Exchange rate used if the line item is in a foreign currency. - validation: - pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ - is_billable: - type: optional - docs: Whether the expense line is billable to a client or project. - tracking_categories: - docs: >- - The related tracking categories associated with the expense report - (Department, Location, Class, Expense Category) - type: list - employee: - type: optional - docs: >- - Identifier for the employee who submitted or is associated with the - expense report - project: optional - company: - type: optional - docs: The subsidiary that the expense report is created in - contact: optional - quantity: - type: optional - docs: Quantity for the expense line (e.g., miles driven, items purchased). - unit_price: - type: optional - docs: Price per unit for the expense line (if applicable). - non_reimbursable: - type: optional - docs: >- - Whether the expense line is non-reimbursable (e.g., paid via company - card). - tax_amount: - type: optional - docs: Tax amount applicable for the line item. - inclusive_of_tax: - type: optional - docs: Whether the amount is inclusive of tax. - tax_rate: optional - integration_params: - type: optional> - access: write-only - linked_account_params: - type: optional> - access: write-only - remote_fields: - type: optional> - access: write-only - source: - openapi: openapi/openapi.yml - ExpenseReportRequestEmployee: - discriminated: false - docs: >- - Identifier for the employee who submitted or is associated with the - expense report + * `ZWL` - Zimbabwean Dollar (2009) union: - - type: string - validation: - format: uuid - - Employee + - TransactionCurrencyEnum + - string source: openapi: openapi/openapi.yml inline: true @@ -22809,7 +25353,7 @@ types: type: optional docs: Total amount of the expense report currency: - type: optional + type: optional docs: >- Currency code for the expense report @@ -30696,11 +33240,9 @@ types: applied_credit_notes: type: optional> docs: '`CreditNoteApplyLines` applied to the Invoice.' - access: read-only applied_vendor_credits: type: optional> docs: '`VendorCreditApplyLines` applied to the Invoice.' - access: read-only inclusive_of_tax: type: optional docs: >- @@ -34235,6 +36777,16 @@ types: source: openapi: openapi/openapi.yml inline: true + InvoiceRequestLineItemsItem: + discriminated: false + union: + - type: string + validation: + format: uuid + - InvoiceLineItem + source: + openapi: openapi/openapi.yml + inline: true InvoiceRequestPurchaseOrdersItem: discriminated: false union: @@ -34960,7 +37512,7 @@ types: type: optional>> docs: Array of `Payment` object IDs. tracking_categories: optional>> - line_items: optional> + line_items: optional> purchase_orders: optional>> integration_params: type: optional> @@ -37489,6 +40041,16 @@ types: source: openapi: openapi/openapi.yml inline: true + JournalEntryRequestLinesItem: + discriminated: false + union: + - type: string + validation: + format: uuid + - JournalLine + source: + openapi: openapi/openapi.yml + inline: true JournalEntryRequestPostingStatus: discriminated: false docs: |- @@ -38159,7 +40721,7 @@ types: docs: >- If the transaction is inclusive or exclusive of tax. `True` if inclusive, `False` if exclusive. - lines: optional> + lines: optional> journal_number: type: optional docs: Reference number for identifying journal entries. @@ -41304,6 +43866,91 @@ types: results: optional> source: openapi: openapi/openapi.yml + PatchedContactEndpointRequest: + properties: + model: PatchedContactRequest + source: + openapi: openapi/openapi.yml + PatchedContactRequestStatus: + discriminated: false + docs: |- + The contact's status + + * `ACTIVE` - ACTIVE + * `ARCHIVED` - ARCHIVED + union: + - Status7D1Enum + - string + source: + openapi: openapi/openapi.yml + inline: true + PatchedContactRequest: + docs: >- + # The Contact Object + + ### Description + + A `Contact` is an individual or business entity to which products and + services are sold to or purchased from. The `Contact` model contains both + Customers, in which products and services are sold to, and Vendors (or + Suppliers), in which products and services are purchased from. + + * A `Contact` is a Vendor/Supplier if the `is_supplier` property is true. + + * A `Contact` is a customer if the `is_customer` property is true. + + + ### Usage Example + + Fetch from the `LIST Contacts` endpoint and view a company's contacts. + properties: + name: + type: optional + docs: The contact's name. + is_supplier: + type: optional + docs: Whether the contact is a supplier. + is_customer: + type: optional + docs: Whether the contact is a customer. + email_address: + type: optional + docs: The contact's email address. + tax_number: + type: optional + docs: The contact's tax number. + status: + type: optional + docs: |- + The contact's status + + * `ACTIVE` - ACTIVE + * `ARCHIVED` - ARCHIVED + currency: + type: optional + docs: The currency the contact's transactions are in. + company: + type: optional + docs: The company the contact belongs to. + validation: + format: uuid + addresses: + type: optional> + docs: '`Address` object IDs for the given `Contacts` object.' + phone_numbers: + type: optional> + docs: '`AccountingPhoneNumber` object for the given `Contacts` object.' + integration_params: + type: optional> + access: write-only + linked_account_params: + type: optional> + access: write-only + remote_fields: + type: optional> + access: write-only + source: + openapi: openapi/openapi.yml PatchedItemRequestRequestStatus: discriminated: false docs: |- @@ -42056,17 +44703,6 @@ types: source: openapi: openapi/openapi.yml inline: true - PatchedPaymentRequestCompany: - discriminated: false - docs: The company the payment belongs to. - union: - - type: string - validation: - format: uuid - - CompanyInfo - source: - openapi: openapi/openapi.yml - inline: true PatchedPaymentRequestType: discriminated: false docs: |- @@ -42761,8 +45397,10 @@ types: validation: pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ company: - type: optional + type: optional docs: The company the payment belongs to. + validation: + format: uuid total_amount: type: optional docs: >- @@ -44369,7 +47007,7 @@ types: docs: The datetime that this object was modified by Merge. access: read-only method_type: - type: PaymentMethodMethodType + type: optional docs: |- The type of the payment method. @@ -51585,6 +54223,7 @@ types: CreditNote: optional> Item: optional> PurchaseOrder: optional> + ExpenseReport: optional> TrackingCategory: optional> JournalEntry: optional> TaxRate: optional> @@ -51609,6 +54248,7 @@ types: remote_key_name: optional description: optional is_custom: optional + is_common_model_field: optional is_required: optional field_type: optional field_format: optional @@ -51650,6 +54290,14 @@ types: key: string source: openapi: openapi/openapi.yml + RemoteResponseResponseType: + discriminated: false + union: + - ResponseTypeEnum + - string + source: + openapi: openapi/openapi.yml + inline: true RemoteResponse: docs: >- # The RemoteResponse Object @@ -51669,7 +54317,7 @@ types: status: integer response: unknown response_headers: optional> - response_type: optional + response_type: optional headers: optional> source: openapi: openapi/openapi.yml @@ -52805,6 +55453,17 @@ types: source: openapi: openapi/openapi.yml inline: true + TransactionCompany: + discriminated: false + docs: The company the transaction belongs to. + union: + - type: string + validation: + format: uuid + - CompanyInfo + source: + openapi: openapi/openapi.yml + inline: true TransactionTrackingCategoriesItem: discriminated: false union: @@ -53524,10 +56183,8 @@ types: validation: pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ company: - type: optional + type: optional docs: The company the transaction belongs to. - validation: - format: uuid tracking_categories: optional>> line_items: type: optional> @@ -56502,6 +59159,16 @@ types: source: openapi: openapi/openapi.yml inline: true + VendorCreditLinesItem: + discriminated: false + union: + - type: string + validation: + format: uuid + - VendorCreditLine + source: + openapi: openapi/openapi.yml + inline: true VendorCreditTrackingCategoriesItem: discriminated: false union: @@ -57202,7 +59869,7 @@ types: type: optional docs: The company the vendor credit belongs to. lines: - type: optional> + type: optional> access: read-only tracking_categories: optional>> applied_to_lines: diff --git a/.mock/definition/accounting/accountDetails.yml b/.mock/definition/accounting/accountDetails.yml index a9e9606f..300d24e0 100644 --- a/.mock/definition/accounting/accountDetails.yml +++ b/.mock/definition/accounting/accountDetails.yml @@ -16,7 +16,8 @@ service: type: root.AccountDetails status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: id: 0496d4c2-42e6-4072-80b3-7b69bfdc76fd diff --git a/.mock/definition/accounting/accountToken.yml b/.mock/definition/accounting/accountToken.yml index e5fa0475..0f3134f8 100644 --- a/.mock/definition/accounting/accountToken.yml +++ b/.mock/definition/accounting/accountToken.yml @@ -22,6 +22,8 @@ service: examples: - path-parameters: public_token: public_token + headers: + X-Account-Token: '[object Object]' response: body: account_token: T9klMDQrcHdm9jrtHuOS2Nf06BIHwMNjpPXPMB diff --git a/.mock/definition/accounting/accountingPeriods.yml b/.mock/definition/accounting/accountingPeriods.yml index d6fc7c6b..4adc5e1b 100644 --- a/.mock/definition/accounting/accountingPeriods.yml +++ b/.mock/definition/accounting/accountingPeriods.yml @@ -43,7 +43,10 @@ service: type: root.PaginatedAccountingPeriodList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -95,7 +98,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 3015f7b1-4d01-460d-bfab-02a52d16cbd0 diff --git a/.mock/definition/accounting/accounts.yml b/.mock/definition/accounting/accounts.yml index c6746098..7f5c1aac 100644 --- a/.mock/definition/accounting/accounts.yml +++ b/.mock/definition/accounting/accounts.yml @@ -127,7 +127,10 @@ service: type: root.PaginatedAccountList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -185,7 +188,8 @@ service: type: root.AccountResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -280,7 +284,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: ecbe05ac-62a3-46c5-ab31-4b478b37d1b4 @@ -320,7 +325,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/accounting/addresses.yml b/.mock/definition/accounting/addresses.yml index 989f0df1..c8ae7626 100644 --- a/.mock/definition/accounting/addresses.yml +++ b/.mock/definition/accounting/addresses.yml @@ -43,7 +43,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: created_at: '2021-09-15T00:00:00Z' diff --git a/.mock/definition/accounting/asyncPassthrough.yml b/.mock/definition/accounting/asyncPassthrough.yml index da15bafd..2a665ed2 100644 --- a/.mock/definition/accounting/asyncPassthrough.yml +++ b/.mock/definition/accounting/asyncPassthrough.yml @@ -21,7 +21,8 @@ service: type: root.AsyncPassthroughReciept status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: method: GET path: /scooters @@ -44,7 +45,8 @@ service: examples: - path-parameters: async_passthrough_receipt_id: async_passthrough_receipt_id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: method: GET diff --git a/.mock/definition/accounting/asyncTasks.yml b/.mock/definition/accounting/asyncTasks.yml index 6365c3ab..ae58d998 100644 --- a/.mock/definition/accounting/asyncTasks.yml +++ b/.mock/definition/accounting/asyncTasks.yml @@ -20,7 +20,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: status: QUEUED diff --git a/.mock/definition/accounting/attachments.yml b/.mock/definition/accounting/attachments.yml index cae3762b..2487a3cf 100644 --- a/.mock/definition/accounting/attachments.yml +++ b/.mock/definition/accounting/attachments.yml @@ -69,7 +69,10 @@ service: type: root.PaginatedAccountingAttachmentList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -120,7 +123,8 @@ service: type: root.AccountingAttachmentResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -193,7 +197,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: ecbe05ac-62a3-46c5-ab31-4b478b37d1b4 @@ -226,7 +231,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/accounting/auditTrail.yml b/.mock/definition/accounting/auditTrail.yml index 6e1b8672..0dcfb086 100644 --- a/.mock/definition/accounting/auditTrail.yml +++ b/.mock/definition/accounting/auditTrail.yml @@ -75,7 +75,11 @@ service: type: root.PaginatedAuditLogEventList status-code: 200 examples: - - response: + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: '[object Object]' + response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ diff --git a/.mock/definition/accounting/availableActions.yml b/.mock/definition/accounting/availableActions.yml index 35fca3fa..e7a930de 100644 --- a/.mock/definition/accounting/availableActions.yml +++ b/.mock/definition/accounting/availableActions.yml @@ -16,7 +16,8 @@ service: type: root.AvailableActions status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: integration: diff --git a/.mock/definition/accounting/balanceSheets.yml b/.mock/definition/accounting/balanceSheets.yml index dde810e4..28152b37 100644 --- a/.mock/definition/accounting/balanceSheets.yml +++ b/.mock/definition/accounting/balanceSheets.yml @@ -72,7 +72,10 @@ service: type: root.PaginatedBalanceSheetList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -169,7 +172,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 9871b4a9-f5d2-4f3b-a66b-dfedbed42c46 diff --git a/.mock/definition/accounting/bankFeedAccounts.yml b/.mock/definition/accounting/bankFeedAccounts.yml index 2e64d197..a5d6ed06 100644 --- a/.mock/definition/accounting/bankFeedAccounts.yml +++ b/.mock/definition/accounting/bankFeedAccounts.yml @@ -43,7 +43,10 @@ service: type: root.PaginatedBankFeedAccountList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -96,7 +99,8 @@ service: type: root.BankFeedAccountResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -173,7 +177,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: b26fd49a-cbae-470a-a8f8-bcbc119e0390 @@ -210,7 +215,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/accounting/bankFeedTransactions.yml b/.mock/definition/accounting/bankFeedTransactions.yml index 682615d0..7a1d41c9 100644 --- a/.mock/definition/accounting/bankFeedTransactions.yml +++ b/.mock/definition/accounting/bankFeedTransactions.yml @@ -74,7 +74,10 @@ service: type: root.PaginatedBankFeedTransactionList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -122,7 +125,8 @@ service: type: root.BankFeedTransactionResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -197,7 +201,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: b26fd49a-cbae-470a-a8f8-bcbc119e0390 @@ -227,7 +232,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/accounting/cashFlowStatements.yml b/.mock/definition/accounting/cashFlowStatements.yml index 179afb9c..2db3914f 100644 --- a/.mock/definition/accounting/cashFlowStatements.yml +++ b/.mock/definition/accounting/cashFlowStatements.yml @@ -74,7 +74,10 @@ service: type: root.PaginatedCashFlowStatementList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -170,7 +173,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 5b3c1341-a20f-4e51-b72c-f3830a16c97b diff --git a/.mock/definition/accounting/companyInfo.yml b/.mock/definition/accounting/companyInfo.yml index 488a4308..3afdeade 100644 --- a/.mock/definition/accounting/companyInfo.yml +++ b/.mock/definition/accounting/companyInfo.yml @@ -86,7 +86,10 @@ service: type: root.PaginatedCompanyInfoList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -113,8 +116,7 @@ service: country: US zip_code: '10027' phone_numbers: - - created_at: '2021-09-15T00:00:00Z' - modified_at: '2021-10-16T00:00:00Z' + - phone_numbers remote_was_deleted: true field_mappings: organization_defined_targets: @@ -159,7 +161,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 65d8ffd0-211b-4ba4-b85a-fbe2ce220982 @@ -187,10 +190,7 @@ service: country: US zip_code: '10027' phone_numbers: - - created_at: '2021-09-15T00:00:00Z' - modified_at: '2021-10-16T00:00:00Z' - number: '+3198675309' - type: Mobile + - phone_numbers remote_was_deleted: true field_mappings: organization_defined_targets: diff --git a/.mock/definition/accounting/contacts.yml b/.mock/definition/accounting/contacts.yml index ba75cfb4..c809b0ff 100644 --- a/.mock/definition/accounting/contacts.yml +++ b/.mock/definition/accounting/contacts.yml @@ -137,7 +137,10 @@ service: type: root.PaginatedContactList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -203,7 +206,8 @@ service: type: root.ContactResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -311,7 +315,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: c640b80b-fac9-409f-aa19-1f9221aec445 @@ -361,7 +366,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -582,7 +588,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -593,6 +602,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/accounting/creditNotes.yml b/.mock/definition/accounting/creditNotes.yml index edd13752..880ab247 100644 --- a/.mock/definition/accounting/creditNotes.yml +++ b/.mock/definition/accounting/creditNotes.yml @@ -659,7 +659,10 @@ service: type: root.PaginatedCreditNoteList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -755,7 +758,8 @@ service: type: root.CreditNoteResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -888,7 +892,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 8d9fd929-436c-4fd4-a48b-0c61f68d6178 @@ -917,7 +922,6 @@ service: unit_price: '5.0' tax_rate: 8d9fd929-436c-4fd4-a48b-0c61f68d6178 total_line_amount: '5.0' - tracking_category: tracking_category tracking_categories: - 8d9fd929-436c-4fd4-a48b-0c61f68d6178 - 9b840d2-686a-465a-8a8e-7b028498f8e4 @@ -969,7 +973,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/accounting/deleteAccount.yml b/.mock/definition/accounting/deleteAccount.yml index 402b4e72..dd6432e8 100644 --- a/.mock/definition/accounting/deleteAccount.yml +++ b/.mock/definition/accounting/deleteAccount.yml @@ -10,6 +10,7 @@ service: source: openapi: openapi/openapi.yml examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token source: openapi: openapi/openapi.yml diff --git a/.mock/definition/accounting/employees.yml b/.mock/definition/accounting/employees.yml index bc9f9fdb..d77b43e3 100644 --- a/.mock/definition/accounting/employees.yml +++ b/.mock/definition/accounting/employees.yml @@ -72,7 +72,10 @@ service: type: root.PaginatedEmployeeList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -133,7 +136,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: c640b80b-fac9-409f-aa19-1f9221aec445 diff --git a/.mock/definition/accounting/expenseReports.yml b/.mock/definition/accounting/expenseReports.yml index d8794980..5c91019f 100644 --- a/.mock/definition/accounting/expenseReports.yml +++ b/.mock/definition/accounting/expenseReports.yml @@ -262,7 +262,10 @@ service: type: root.PaginatedExpenseReportList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -274,7 +277,7 @@ service: modified_at: '2024-01-31T14:30:00Z' report_date: '2024-01-31T00:00:00Z' report_identifier: EXP-2024-001 - employee: b9a9b824-6172-4d63-9d90-1c8a86c4f3b1 + employee: employee status: DRAFT total_amount: 150 lines: @@ -305,7 +308,7 @@ service: remote_was_deleted: false currency: XUA description: January 2024 Travel Expenses - accounting_period: 7d793c67-9f72-4a6b-9256-3936f237b0d9 + accounting_period: accounting_period company: company tracking_categories: - a1b2c3d4-e5f6-4a5b-9c3d-2e1f0a9b8c7d @@ -349,7 +352,8 @@ service: type: root.ExpenseReportResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: tracking_categories: @@ -364,7 +368,7 @@ service: modified_at: '2024-01-31T14:30:00Z' report_date: '2024-01-31T00:00:00Z' report_identifier: EXP-2024-001 - employee: b9a9b824-6172-4d63-9d90-1c8a86c4f3b1 + employee: employee status: DRAFT total_amount: 150 lines: @@ -395,7 +399,7 @@ service: remote_was_deleted: false currency: XUA description: January 2024 Travel Expenses - accounting_period: 7d793c67-9f72-4a6b-9256-3936f237b0d9 + accounting_period: accounting_period company: company tracking_categories: - a1b2c3d4-e5f6-4a5b-9c3d-2e1f0a9b8c7d @@ -487,7 +491,10 @@ service: examples: - path-parameters: expense_report_id: expense_report_id - headers: {} + query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -559,7 +566,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 123e4567-e89b-12d3-a456-426614174000 @@ -568,7 +576,7 @@ service: modified_at: '2024-01-31T14:30:00Z' report_date: '2024-01-31T00:00:00Z' report_identifier: EXP-2024-001 - employee: b9a9b824-6172-4d63-9d90-1c8a86c4f3b1 + employee: employee status: DRAFT total_amount: 150 lines: @@ -601,7 +609,7 @@ service: - remote_field_class: remote_field_class currency: XUA description: January 2024 Travel Expenses - accounting_period: 7d793c67-9f72-4a6b-9256-3936f237b0d9 + accounting_period: accounting_period company: company tracking_categories: - a1b2c3d4-e5f6-4a5b-9c3d-2e1f0a9b8c7d @@ -669,7 +677,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -680,6 +691,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string @@ -697,7 +709,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -918,7 +931,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -929,6 +945,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/accounting/expenses.yml b/.mock/definition/accounting/expenses.yml index 98c48edf..4a409f71 100644 --- a/.mock/definition/accounting/expenses.yml +++ b/.mock/definition/accounting/expenses.yml @@ -334,7 +334,10 @@ service: type: root.PaginatedExpenseList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -433,7 +436,8 @@ service: type: root.ExpenseResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -564,7 +568,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: ecbe05ac-62a3-46c5-ab31-4b478b37d1b4 @@ -591,7 +596,6 @@ service: modified_at: '2021-10-16T00:00:00Z' item: b38c59b0-a9d7-4740-b1ee-5436c6751e3d net_amount: 25.54 - tracking_category: tracking_category tracking_categories: - b38c59b0-a9d7-4740-b1ee-5436c6751e3d - 9b840d2-686a-465a-8a8e-7b028498f8e4 @@ -612,7 +616,6 @@ service: modified_at: '2021-10-16T00:00:00Z' item: b38c59b0-a9d7-4740-b1ee-5436c6751e3d net_amount: 10 - tracking_category: tracking_category tracking_categories: - b38c59b0-a9d7-4740-b1ee-5436c6751e3d - 9b840d2-686a-465a-8a8e-7b028498f8e4 @@ -695,7 +698,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -706,6 +712,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string @@ -723,7 +730,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -944,7 +952,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -955,6 +966,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/accounting/fieldMapping.yml b/.mock/definition/accounting/fieldMapping.yml index 66389088..80824f25 100644 --- a/.mock/definition/accounting/fieldMapping.yml +++ b/.mock/definition/accounting/fieldMapping.yml @@ -30,7 +30,8 @@ service: type: root.FieldMappingApiInstanceResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: Account: @@ -517,7 +518,8 @@ service: type: root.FieldMappingInstanceResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: target_field_name: example_target_field_name target_field_description: this is a example description of the target field @@ -584,7 +586,8 @@ service: examples: - path-parameters: field_mapping_id: field_mapping_id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: model: @@ -666,7 +669,8 @@ service: examples: - path-parameters: field_mapping_id: field_mapping_id - headers: {} + headers: + X-Account-Token: X-Account-Token request: {} response: body: @@ -737,7 +741,8 @@ service: type: root.RemoteFieldApiResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: Account: @@ -880,6 +885,20 @@ service: advanced_metadata: id: id coverage: 1 + ExpenseReport: + - schema: + type: string + remote_key_name: example_remote_key_name + remote_endpoint_info: + method: GET + url_path: /example-url-path + field_traversal_path: + - example_key_name + example_values: + - example + advanced_metadata: + id: id + coverage: 1 TrackingCategory: - schema: type: string @@ -1107,7 +1126,8 @@ service: type: root.ExternalTargetFieldApiResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: Account: diff --git a/.mock/definition/accounting/forceResync.yml b/.mock/definition/accounting/forceResync.yml index 8e7e969a..23d80d64 100644 --- a/.mock/definition/accounting/forceResync.yml +++ b/.mock/definition/accounting/forceResync.yml @@ -21,7 +21,8 @@ service: type: list status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: - model_name: Invoice diff --git a/.mock/definition/accounting/generalLedgerTransactions.yml b/.mock/definition/accounting/generalLedgerTransactions.yml index 38fe7292..5e43d543 100644 --- a/.mock/definition/accounting/generalLedgerTransactions.yml +++ b/.mock/definition/accounting/generalLedgerTransactions.yml @@ -143,7 +143,10 @@ service: type: root.PaginatedGeneralLedgerTransactionList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -228,7 +231,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: b26fd49a-cbae-470a-a8f8-bcbc119e0390 diff --git a/.mock/definition/accounting/generateKey.yml b/.mock/definition/accounting/generateKey.yml index 4d79b8ce..7ec4bf68 100644 --- a/.mock/definition/accounting/generateKey.yml +++ b/.mock/definition/accounting/generateKey.yml @@ -26,7 +26,9 @@ service: type: root.RemoteKey status-code: 200 examples: - - request: + - headers: + X-Account-Token: '[object Object]' + request: name: Remote Deployment Key 1 response: body: diff --git a/.mock/definition/accounting/incomeStatements.yml b/.mock/definition/accounting/incomeStatements.yml index 92f62e77..f1da1a7b 100644 --- a/.mock/definition/accounting/incomeStatements.yml +++ b/.mock/definition/accounting/incomeStatements.yml @@ -72,7 +72,10 @@ service: type: root.PaginatedIncomeStatementList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -183,7 +186,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 0958cbc6-6040-430a-848e-aafacbadf4ae diff --git a/.mock/definition/accounting/invoices.yml b/.mock/definition/accounting/invoices.yml index a3d88012..963f67bb 100644 --- a/.mock/definition/accounting/invoices.yml +++ b/.mock/definition/accounting/invoices.yml @@ -27076,7 +27076,10 @@ service: type: root.PaginatedInvoiceList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -27195,7 +27198,8 @@ service: type: root.InvoiceResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -27353,7 +27357,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 9871b4a9-f5d2-4f3b-a66b-dfedbed42c46 @@ -27409,7 +27414,6 @@ service: item: 5b3c1341-a20f-4e51-b72c-f3830a16c97b account: cd0f32d4-a493-11ec-b909-0242ac120002 tax_rate: a12e7c20-1922-9df7-s75n-edfeewnn7384 - tracking_category: tracking_category tracking_categories: - b38c59b0-a9d7-4740-b1ee-5436c6751e3d - 9b840d2-686a-465a-8a8e-7b028498f8e4 @@ -27485,7 +27489,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -27643,7 +27648,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -27654,6 +27662,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string @@ -27675,7 +27684,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -27859,7 +27869,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -28080,7 +28091,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -28091,6 +28105,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/accounting/issues.yml b/.mock/definition/accounting/issues.yml index 58c4f3b1..f7568739 100644 --- a/.mock/definition/accounting/issues.yml +++ b/.mock/definition/accounting/issues.yml @@ -80,7 +80,11 @@ service: type: root.PaginatedIssueList status-code: 200 examples: - - response: + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: '[object Object]' + response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ @@ -112,6 +116,8 @@ service: examples: - path-parameters: id: id + headers: + X-Account-Token: '[object Object]' response: body: id: 3fa85f64-5717-4562-b3fc-2c963f66afa6 diff --git a/.mock/definition/accounting/items.yml b/.mock/definition/accounting/items.yml index 29a34438..67a784e9 100644 --- a/.mock/definition/accounting/items.yml +++ b/.mock/definition/accounting/items.yml @@ -207,7 +207,10 @@ service: type: root.PaginatedItemList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -265,7 +268,8 @@ service: type: root.ItemResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -360,7 +364,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: d2f972d0-2526-434b-9409-4c3b468e08f0 @@ -419,7 +424,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -486,7 +492,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -670,7 +677,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/accounting/journalEntries.yml b/.mock/definition/accounting/journalEntries.yml index feb7bad3..e471027d 100644 --- a/.mock/definition/accounting/journalEntries.yml +++ b/.mock/definition/accounting/journalEntries.yml @@ -338,7 +338,10 @@ service: type: root.PaginatedJournalEntryList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -431,7 +434,8 @@ service: type: root.JournalEntryResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -556,7 +560,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: ecbe05ac-62a3-46c5-ab31-4b478b37d1b4 @@ -580,7 +585,6 @@ service: modified_at: '2021-10-16T00:00:00Z' account: 9d892439-5fab-4dbb-8bd8-34f7f96c7912 net_amount: 25.54 - tracking_category: tracking_category tracking_categories: - d25d609b-945f-4762-b55a-1c8fb220c43c - 9b840d2-686a-465a-8a8e-7b028498f8e4 @@ -602,7 +606,6 @@ service: modified_at: '2021-10-16T00:00:00Z' account: f963f34d-3d2f-4f77-b557-cf36bc7e6498 net_amount: 10 - tracking_category: tracking_category tracking_categories: - d25d609b-945f-4762-b55a-1c8fb220c43c - 9b840d2-686a-465a-8a8e-7b028498f8e4 @@ -690,7 +693,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -701,6 +707,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string @@ -718,7 +725,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -939,7 +947,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -950,6 +961,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/accounting/linkToken.yml b/.mock/definition/accounting/linkToken.yml index 5a2f0a6f..1d7aa0a0 100644 --- a/.mock/definition/accounting/linkToken.yml +++ b/.mock/definition/accounting/linkToken.yml @@ -136,7 +136,9 @@ service: type: root.LinkToken status-code: 200 examples: - - request: + - headers: + X-Account-Token: '[object Object]' + request: end_user_email_address: example@gmail.com end_user_organization_name: Test Organization end_user_origin_id: '12345' diff --git a/.mock/definition/accounting/linkedAccounts.yml b/.mock/definition/accounting/linkedAccounts.yml index aa8806e8..a831126a 100644 --- a/.mock/definition/accounting/linkedAccounts.yml +++ b/.mock/definition/accounting/linkedAccounts.yml @@ -107,7 +107,11 @@ service: type: root.PaginatedAccountDetailsAndActionsList status-code: 200 examples: - - response: + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: '[object Object]' + response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ diff --git a/.mock/definition/accounting/passthrough.yml b/.mock/definition/accounting/passthrough.yml index 25ab767c..db79aa9e 100644 --- a/.mock/definition/accounting/passthrough.yml +++ b/.mock/definition/accounting/passthrough.yml @@ -19,7 +19,8 @@ service: type: root.RemoteResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: method: GET path: /scooters diff --git a/.mock/definition/accounting/paymentMethods.yml b/.mock/definition/accounting/paymentMethods.yml index c53c952c..844d0b85 100644 --- a/.mock/definition/accounting/paymentMethods.yml +++ b/.mock/definition/accounting/paymentMethods.yml @@ -43,7 +43,10 @@ service: type: root.PaginatedPaymentMethodList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -95,7 +98,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: ecbe05ac-62a3-46c5-ab31-4b478b37d1b4 diff --git a/.mock/definition/accounting/paymentTerms.yml b/.mock/definition/accounting/paymentTerms.yml index 688ed9c3..edf23455 100644 --- a/.mock/definition/accounting/paymentTerms.yml +++ b/.mock/definition/accounting/paymentTerms.yml @@ -48,7 +48,10 @@ service: type: root.PaginatedPaymentTermList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -107,7 +110,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: ecbe05ac-62a3-46c5-ab31-4b478b37d1b4 diff --git a/.mock/definition/accounting/payments.yml b/.mock/definition/accounting/payments.yml index be829a43..8a628d65 100644 --- a/.mock/definition/accounting/payments.yml +++ b/.mock/definition/accounting/payments.yml @@ -624,7 +624,10 @@ service: type: root.PaginatedPaymentList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -705,7 +708,8 @@ service: type: root.PaymentResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -818,7 +822,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: b26fd49a-cbae-470a-a8f8-bcbc119e0390 @@ -902,7 +907,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -1025,7 +1031,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -1036,6 +1045,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string @@ -1057,7 +1067,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -1241,7 +1252,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -1462,7 +1474,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -1473,6 +1488,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/accounting/phoneNumbers.yml b/.mock/definition/accounting/phoneNumbers.yml index b6732385..75ad3e16 100644 --- a/.mock/definition/accounting/phoneNumbers.yml +++ b/.mock/definition/accounting/phoneNumbers.yml @@ -33,7 +33,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: created_at: '2021-09-15T00:00:00Z' diff --git a/.mock/definition/accounting/projects.yml b/.mock/definition/accounting/projects.yml index c83c6626..add59523 100644 --- a/.mock/definition/accounting/projects.yml +++ b/.mock/definition/accounting/projects.yml @@ -89,7 +89,10 @@ service: type: root.PaginatedProjectList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -146,7 +149,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: ecbe05ac-62a3-46c5-ab31-4b478b37d1b4 diff --git a/.mock/definition/accounting/purchaseOrders.yml b/.mock/definition/accounting/purchaseOrders.yml index e0157639..bc57e698 100644 --- a/.mock/definition/accounting/purchaseOrders.yml +++ b/.mock/definition/accounting/purchaseOrders.yml @@ -634,7 +634,10 @@ service: type: root.PaginatedPurchaseOrderList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -737,7 +740,8 @@ service: type: root.PurchaseOrderResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -882,7 +886,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 0048ea5b-911e-4dff-9364-92070dea62ff @@ -912,7 +917,6 @@ service: quantity: 10 item: 0958cbc6-6040-430a-848e-aafacbadf4ae account: account - tracking_category: tracking_category tracking_categories: - f1214c24-2702-4617-b74b-3ddecfc0d384 - 9b840d2-686a-465a-8a8e-7b028498f8e4 @@ -935,7 +939,6 @@ service: quantity: 10 item: 249c9faa-3045-4a31-953b-8f22d3613301 account: account - tracking_category: tracking_category tracking_categories: - f1214c24-2702-4617-b74b-3ddecfc0d384 - 9b840d2-686a-465a-8a8e-7b028498f8e4 @@ -1020,7 +1023,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -1031,6 +1037,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string @@ -1048,7 +1055,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -1269,7 +1277,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -1280,6 +1291,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/accounting/regenerateKey.yml b/.mock/definition/accounting/regenerateKey.yml index 39fe26f9..fa714152 100644 --- a/.mock/definition/accounting/regenerateKey.yml +++ b/.mock/definition/accounting/regenerateKey.yml @@ -26,7 +26,9 @@ service: type: root.RemoteKey status-code: 200 examples: - - request: + - headers: + X-Account-Token: '[object Object]' + request: name: Remote Deployment Key 1 response: body: diff --git a/.mock/definition/accounting/scopes.yml b/.mock/definition/accounting/scopes.yml index ab81c591..4c990463 100644 --- a/.mock/definition/accounting/scopes.yml +++ b/.mock/definition/accounting/scopes.yml @@ -19,7 +19,9 @@ service: type: root.CommonModelScopeApi status-code: 200 examples: - - response: + - headers: + X-Account-Token: '[object Object]' + response: body: common_models: - model_name: Employee @@ -60,7 +62,8 @@ service: type: root.CommonModelScopeApi status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: common_models: @@ -111,7 +114,8 @@ service: type: root.CommonModelScopeApi status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: common_models: - model_name: Employee diff --git a/.mock/definition/accounting/syncStatus.yml b/.mock/definition/accounting/syncStatus.yml index 38dcf2ce..2a5e4eb4 100644 --- a/.mock/definition/accounting/syncStatus.yml +++ b/.mock/definition/accounting/syncStatus.yml @@ -36,7 +36,10 @@ service: type: root.PaginatedSyncStatusList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw diff --git a/.mock/definition/accounting/taxRates.yml b/.mock/definition/accounting/taxRates.yml index 3ff15195..c2695fb6 100644 --- a/.mock/definition/accounting/taxRates.yml +++ b/.mock/definition/accounting/taxRates.yml @@ -75,7 +75,10 @@ service: type: root.PaginatedTaxRateList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -146,7 +149,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: b82302de-852e-4e60-b050-edf9da3b7c02 diff --git a/.mock/definition/accounting/trackingCategories.yml b/.mock/definition/accounting/trackingCategories.yml index 2e3f062f..b63996f9 100644 --- a/.mock/definition/accounting/trackingCategories.yml +++ b/.mock/definition/accounting/trackingCategories.yml @@ -95,7 +95,10 @@ service: type: root.PaginatedTrackingCategoryList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -160,7 +163,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: ecbe05ac-62a3-46c5-ab31-4b478b37d1b4 diff --git a/.mock/definition/accounting/transactions.yml b/.mock/definition/accounting/transactions.yml index 94a999db..aeb5de3d 100644 --- a/.mock/definition/accounting/transactions.yml +++ b/.mock/definition/accounting/transactions.yml @@ -4,60 +4,124 @@ types: - account - value: account,accounting_period name: AccountAccountingPeriod + - value: account,company + name: AccountCompany + - value: account,company,accounting_period + name: AccountCompanyAccountingPeriod - accounting_period + - company + - value: company,accounting_period + name: CompanyAccountingPeriod - contact - value: contact,account name: ContactAccount - value: contact,account,accounting_period name: ContactAccountAccountingPeriod + - value: contact,account,company + name: ContactAccountCompany + - value: contact,account,company,accounting_period + name: ContactAccountCompanyAccountingPeriod - value: contact,accounting_period name: ContactAccountingPeriod + - value: contact,company + name: ContactCompany + - value: contact,company,accounting_period + name: ContactCompanyAccountingPeriod - line_items - value: line_items,account name: LineItemsAccount - value: line_items,account,accounting_period name: LineItemsAccountAccountingPeriod + - value: line_items,account,company + name: LineItemsAccountCompany + - value: line_items,account,company,accounting_period + name: LineItemsAccountCompanyAccountingPeriod - value: line_items,accounting_period name: LineItemsAccountingPeriod + - value: line_items,company + name: LineItemsCompany + - value: line_items,company,accounting_period + name: LineItemsCompanyAccountingPeriod - value: line_items,contact name: LineItemsContact - value: line_items,contact,account name: LineItemsContactAccount - value: line_items,contact,account,accounting_period name: LineItemsContactAccountAccountingPeriod + - value: line_items,contact,account,company + name: LineItemsContactAccountCompany + - value: line_items,contact,account,company,accounting_period + name: LineItemsContactAccountCompanyAccountingPeriod - value: line_items,contact,accounting_period name: LineItemsContactAccountingPeriod + - value: line_items,contact,company + name: LineItemsContactCompany + - value: line_items,contact,company,accounting_period + name: LineItemsContactCompanyAccountingPeriod - value: line_items,tracking_categories name: LineItemsTrackingCategories - value: line_items,tracking_categories,account name: LineItemsTrackingCategoriesAccount - value: line_items,tracking_categories,account,accounting_period name: LineItemsTrackingCategoriesAccountAccountingPeriod + - value: line_items,tracking_categories,account,company + name: LineItemsTrackingCategoriesAccountCompany + - value: line_items,tracking_categories,account,company,accounting_period + name: LineItemsTrackingCategoriesAccountCompanyAccountingPeriod - value: line_items,tracking_categories,accounting_period name: LineItemsTrackingCategoriesAccountingPeriod + - value: line_items,tracking_categories,company + name: LineItemsTrackingCategoriesCompany + - value: line_items,tracking_categories,company,accounting_period + name: LineItemsTrackingCategoriesCompanyAccountingPeriod - value: line_items,tracking_categories,contact name: LineItemsTrackingCategoriesContact - value: line_items,tracking_categories,contact,account name: LineItemsTrackingCategoriesContactAccount - value: line_items,tracking_categories,contact,account,accounting_period name: LineItemsTrackingCategoriesContactAccountAccountingPeriod + - value: line_items,tracking_categories,contact,account,company + name: LineItemsTrackingCategoriesContactAccountCompany + - value: >- + line_items,tracking_categories,contact,account,company,accounting_period + name: LineItemsTrackingCategoriesContactAccountCompanyAccountingPeriod - value: line_items,tracking_categories,contact,accounting_period name: LineItemsTrackingCategoriesContactAccountingPeriod + - value: line_items,tracking_categories,contact,company + name: LineItemsTrackingCategoriesContactCompany + - value: line_items,tracking_categories,contact,company,accounting_period + name: LineItemsTrackingCategoriesContactCompanyAccountingPeriod - tracking_categories - value: tracking_categories,account name: TrackingCategoriesAccount - value: tracking_categories,account,accounting_period name: TrackingCategoriesAccountAccountingPeriod + - value: tracking_categories,account,company + name: TrackingCategoriesAccountCompany + - value: tracking_categories,account,company,accounting_period + name: TrackingCategoriesAccountCompanyAccountingPeriod - value: tracking_categories,accounting_period name: TrackingCategoriesAccountingPeriod + - value: tracking_categories,company + name: TrackingCategoriesCompany + - value: tracking_categories,company,accounting_period + name: TrackingCategoriesCompanyAccountingPeriod - value: tracking_categories,contact name: TrackingCategoriesContact - value: tracking_categories,contact,account name: TrackingCategoriesContactAccount - value: tracking_categories,contact,account,accounting_period name: TrackingCategoriesContactAccountAccountingPeriod + - value: tracking_categories,contact,account,company + name: TrackingCategoriesContactAccountCompany + - value: tracking_categories,contact,account,company,accounting_period + name: TrackingCategoriesContactAccountCompanyAccountingPeriod - value: tracking_categories,contact,accounting_period name: TrackingCategoriesContactAccountingPeriod + - value: tracking_categories,contact,company + name: TrackingCategoriesContactCompany + - value: tracking_categories,contact,company,accounting_period + name: TrackingCategoriesContactCompanyAccountingPeriod source: openapi: openapi/openapi.yml TransactionsRetrieveRequestExpand: @@ -65,60 +129,124 @@ types: - account - value: account,accounting_period name: AccountAccountingPeriod + - value: account,company + name: AccountCompany + - value: account,company,accounting_period + name: AccountCompanyAccountingPeriod - accounting_period + - company + - value: company,accounting_period + name: CompanyAccountingPeriod - contact - value: contact,account name: ContactAccount - value: contact,account,accounting_period name: ContactAccountAccountingPeriod + - value: contact,account,company + name: ContactAccountCompany + - value: contact,account,company,accounting_period + name: ContactAccountCompanyAccountingPeriod - value: contact,accounting_period name: ContactAccountingPeriod + - value: contact,company + name: ContactCompany + - value: contact,company,accounting_period + name: ContactCompanyAccountingPeriod - line_items - value: line_items,account name: LineItemsAccount - value: line_items,account,accounting_period name: LineItemsAccountAccountingPeriod + - value: line_items,account,company + name: LineItemsAccountCompany + - value: line_items,account,company,accounting_period + name: LineItemsAccountCompanyAccountingPeriod - value: line_items,accounting_period name: LineItemsAccountingPeriod + - value: line_items,company + name: LineItemsCompany + - value: line_items,company,accounting_period + name: LineItemsCompanyAccountingPeriod - value: line_items,contact name: LineItemsContact - value: line_items,contact,account name: LineItemsContactAccount - value: line_items,contact,account,accounting_period name: LineItemsContactAccountAccountingPeriod + - value: line_items,contact,account,company + name: LineItemsContactAccountCompany + - value: line_items,contact,account,company,accounting_period + name: LineItemsContactAccountCompanyAccountingPeriod - value: line_items,contact,accounting_period name: LineItemsContactAccountingPeriod + - value: line_items,contact,company + name: LineItemsContactCompany + - value: line_items,contact,company,accounting_period + name: LineItemsContactCompanyAccountingPeriod - value: line_items,tracking_categories name: LineItemsTrackingCategories - value: line_items,tracking_categories,account name: LineItemsTrackingCategoriesAccount - value: line_items,tracking_categories,account,accounting_period name: LineItemsTrackingCategoriesAccountAccountingPeriod + - value: line_items,tracking_categories,account,company + name: LineItemsTrackingCategoriesAccountCompany + - value: line_items,tracking_categories,account,company,accounting_period + name: LineItemsTrackingCategoriesAccountCompanyAccountingPeriod - value: line_items,tracking_categories,accounting_period name: LineItemsTrackingCategoriesAccountingPeriod + - value: line_items,tracking_categories,company + name: LineItemsTrackingCategoriesCompany + - value: line_items,tracking_categories,company,accounting_period + name: LineItemsTrackingCategoriesCompanyAccountingPeriod - value: line_items,tracking_categories,contact name: LineItemsTrackingCategoriesContact - value: line_items,tracking_categories,contact,account name: LineItemsTrackingCategoriesContactAccount - value: line_items,tracking_categories,contact,account,accounting_period name: LineItemsTrackingCategoriesContactAccountAccountingPeriod + - value: line_items,tracking_categories,contact,account,company + name: LineItemsTrackingCategoriesContactAccountCompany + - value: >- + line_items,tracking_categories,contact,account,company,accounting_period + name: LineItemsTrackingCategoriesContactAccountCompanyAccountingPeriod - value: line_items,tracking_categories,contact,accounting_period name: LineItemsTrackingCategoriesContactAccountingPeriod + - value: line_items,tracking_categories,contact,company + name: LineItemsTrackingCategoriesContactCompany + - value: line_items,tracking_categories,contact,company,accounting_period + name: LineItemsTrackingCategoriesContactCompanyAccountingPeriod - tracking_categories - value: tracking_categories,account name: TrackingCategoriesAccount - value: tracking_categories,account,accounting_period name: TrackingCategoriesAccountAccountingPeriod + - value: tracking_categories,account,company + name: TrackingCategoriesAccountCompany + - value: tracking_categories,account,company,accounting_period + name: TrackingCategoriesAccountCompanyAccountingPeriod - value: tracking_categories,accounting_period name: TrackingCategoriesAccountingPeriod + - value: tracking_categories,company + name: TrackingCategoriesCompany + - value: tracking_categories,company,accounting_period + name: TrackingCategoriesCompanyAccountingPeriod - value: tracking_categories,contact name: TrackingCategoriesContact - value: tracking_categories,contact,account name: TrackingCategoriesContactAccount - value: tracking_categories,contact,account,accounting_period name: TrackingCategoriesContactAccountAccountingPeriod + - value: tracking_categories,contact,account,company + name: TrackingCategoriesContactAccountCompany + - value: tracking_categories,contact,account,company,accounting_period + name: TrackingCategoriesContactAccountCompanyAccountingPeriod - value: tracking_categories,contact,accounting_period name: TrackingCategoriesContactAccountingPeriod + - value: tracking_categories,contact,company + name: TrackingCategoriesContactCompany + - value: tracking_categories,contact,company,accounting_period + name: TrackingCategoriesContactCompanyAccountingPeriod source: openapi: openapi/openapi.yml imports: @@ -205,7 +333,10 @@ service: type: root.PaginatedTransactionList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -224,7 +355,7 @@ service: total_amount: total_amount currency: XUA exchange_rate: '2.9' - company: 595c8f97-2ac4-45b7-b000-41bdf43240b5 + company: company tracking_categories: - b38c59b0-a9d7-4740-b1ee-5436c6751e3d - 9b840d2-686a-465a-8a8e-7b028498f8e4 @@ -308,7 +439,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 0048ea5b-911e-4dff-9364-92070dea62ff @@ -324,7 +456,7 @@ service: total_amount: total_amount currency: XUA exchange_rate: '2.9' - company: 595c8f97-2ac4-45b7-b000-41bdf43240b5 + company: company tracking_categories: - b38c59b0-a9d7-4740-b1ee-5436c6751e3d - 9b840d2-686a-465a-8a8e-7b028498f8e4 @@ -339,7 +471,6 @@ service: quantity: '10.0' item: 0958cbc6-6040-430a-848e-aafacbadf4ae account: 2b38c085-2620-4269-b5ec-75dd9095ed2c - tracking_category: tracking_category tracking_categories: - f1214c24-2702-4617-b74b-3ddecfc0d384 - 9b840d2-686a-465a-8a8e-7b028498f8e4 @@ -359,7 +490,6 @@ service: quantity: '10.0' item: 249c9faa-3045-4a31-953b-8f22d3613301 account: 3e442c5d-8f51-4103-b5c9-dcee39c30a08 - tracking_category: tracking_category tracking_categories: - f1214c24-2702-4617-b74b-3ddecfc0d384 - 9b840d2-686a-465a-8a8e-7b028498f8e4 diff --git a/.mock/definition/accounting/vendorCredits.yml b/.mock/definition/accounting/vendorCredits.yml index 39b41415..b8507e7c 100644 --- a/.mock/definition/accounting/vendorCredits.yml +++ b/.mock/definition/accounting/vendorCredits.yml @@ -203,7 +203,10 @@ service: type: root.PaginatedVendorCreditList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -298,7 +301,8 @@ service: type: root.VendorCreditResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -420,7 +424,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: ecbe05ac-62a3-46c5-ab31-4b478b37d1b4 @@ -441,7 +446,6 @@ service: created_at: '2021-09-15T00:00:00Z' modified_at: '2021-10-16T00:00:00Z' net_amount: 25.54 - tracking_category: tracking_category tracking_categories: - b38c59b0-a9d7-4740-b1ee-5436c6751e3d - 9b840d2-686a-465a-8a8e-7b028498f8e4 @@ -459,7 +463,6 @@ service: created_at: '2021-09-15T00:00:00Z' modified_at: '2021-10-16T00:00:00Z' net_amount: 10 - tracking_category: tracking_category tracking_categories: - b38c59b0-a9d7-4740-b1ee-5436c6751e3d - 9b840d2-686a-465a-8a8e-7b028498f8e4 @@ -507,7 +510,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/accounting/webhookReceivers.yml b/.mock/definition/accounting/webhookReceivers.yml index 0c90c826..c7bb86ce 100644 --- a/.mock/definition/accounting/webhookReceivers.yml +++ b/.mock/definition/accounting/webhookReceivers.yml @@ -16,7 +16,8 @@ service: type: list status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: - event: event @@ -48,7 +49,8 @@ service: type: root.WebhookReceiver status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: event: event is_active: true diff --git a/.mock/definition/ats/__package__.yml b/.mock/definition/ats/__package__.yml index 8f3c7857..30c0cdb6 100644 --- a/.mock/definition/ats/__package__.yml +++ b/.mock/definition/ats/__package__.yml @@ -655,7 +655,7 @@ types: - type: string validation: format: uuid - - ScreeningQuestionAnswerRequest + - ScreeningQuestionAnswer source: openapi: openapi/openapi.yml inline: true @@ -1482,6 +1482,22 @@ types: disabled_fields: list source: openapi: openapi/openapi.yml + DataPassthroughRequestMethod: + discriminated: false + union: + - MethodEnum + - string + source: + openapi: openapi/openapi.yml + inline: true + DataPassthroughRequestRequestFormat: + discriminated: false + union: + - RequestFormatEnum + - string + source: + openapi: openapi/openapi.yml + inline: true DataPassthroughRequest: docs: >- # The DataPassthrough Object @@ -1497,7 +1513,7 @@ types: Create a `DataPassthrough` to get team hierarchies from your Rippling integration. properties: - method: MethodEnum + method: DataPassthroughRequestMethod path: type: string docs: The path of the request in the third party's platform. @@ -1527,7 +1543,7 @@ types: authorization headers). `Content-Type` header is required for passthrough. Choose content type corresponding to expected format of receiving server. - request_format: optional + request_format: optional normalize_response: type: optional docs: >- @@ -1974,6 +1990,7 @@ types: - CREATED_TEST_API_KEY - DELETED_TEST_API_KEY - REGENERATED_PRODUCTION_API_KEY + - REGENERATED_WEBHOOK_SIGNATURE - INVITED_USER - TWO_FACTOR_AUTH_ENABLED - TWO_FACTOR_AUTH_DISABLED @@ -2341,6 +2358,16 @@ types: source: openapi: openapi/openapi.yml inline: true + JobJobPostingsItem: + discriminated: false + union: + - type: string + validation: + format: uuid + - JobPosting + source: + openapi: openapi/openapi.yml + inline: true JobDepartmentsItem: discriminated: false union: @@ -2440,7 +2467,7 @@ types: * `REQUISITION` - REQUISITION * `PROFILE` - PROFILE job_postings: - type: optional>> + type: optional>> docs: IDs of `JobPosting` objects that serve as job postings for this `Job`. job_posting_urls: optional> remote_created_at: @@ -3536,6 +3563,14 @@ types: field_traversal_path: list source: openapi: openapi/openapi.yml + RemoteFieldApiAdvancedMetadata: + discriminated: false + union: + - AdvancedMetadata + - string + source: + openapi: openapi/openapi.yml + inline: true RemoteFieldApiCoverage: discriminated: false union: @@ -3550,7 +3585,7 @@ types: remote_key_name: string remote_endpoint_info: RemoteEndpointInfo example_values: optional> - advanced_metadata: optional + advanced_metadata: optional coverage: type: optional access: read-only diff --git a/.mock/definition/ats/accountDetails.yml b/.mock/definition/ats/accountDetails.yml index fe37fa60..a09c4849 100644 --- a/.mock/definition/ats/accountDetails.yml +++ b/.mock/definition/ats/accountDetails.yml @@ -16,7 +16,8 @@ service: type: root.AccountDetails status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: id: 0496d4c2-42e6-4072-80b3-7b69bfdc76fd diff --git a/.mock/definition/ats/accountToken.yml b/.mock/definition/ats/accountToken.yml index 0c372796..3c055421 100644 --- a/.mock/definition/ats/accountToken.yml +++ b/.mock/definition/ats/accountToken.yml @@ -22,6 +22,8 @@ service: examples: - path-parameters: public_token: public_token + headers: + X-Account-Token: '[object Object]' response: body: account_token: T9klMDQrcHdm9jrtHuOS2Nf06BIHwMNjpPXPMB diff --git a/.mock/definition/ats/activities.yml b/.mock/definition/ats/activities.yml index 362836ad..2ed08a54 100644 --- a/.mock/definition/ats/activities.yml +++ b/.mock/definition/ats/activities.yml @@ -115,7 +115,10 @@ service: type: root.PaginatedActivityList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -170,7 +173,8 @@ service: type: root.ActivityResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} remote_user_id: remote_user_id @@ -262,7 +266,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: ecbe05ac-62a3-46c5-ab31-4b478b37d1b4 @@ -298,7 +303,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/ats/applications.yml b/.mock/definition/ats/applications.yml index 4a5822f9..a6c86947 100644 --- a/.mock/definition/ats/applications.yml +++ b/.mock/definition/ats/applications.yml @@ -1426,7 +1426,10 @@ service: type: root.PaginatedApplicationList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -1498,7 +1501,8 @@ service: type: root.ApplicationResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} remote_user_id: remote_user_id @@ -1586,7 +1590,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 92e8a369-fffe-430d-b93a-f7e8a16563f1 @@ -1655,7 +1660,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token request: {} response: body: @@ -1727,7 +1733,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/ats/asyncPassthrough.yml b/.mock/definition/ats/asyncPassthrough.yml index 94686f10..1ab045cf 100644 --- a/.mock/definition/ats/asyncPassthrough.yml +++ b/.mock/definition/ats/asyncPassthrough.yml @@ -21,7 +21,8 @@ service: type: root.AsyncPassthroughReciept status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: method: GET path: /scooters @@ -44,7 +45,8 @@ service: examples: - path-parameters: async_passthrough_receipt_id: async_passthrough_receipt_id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: method: GET diff --git a/.mock/definition/ats/attachments.yml b/.mock/definition/ats/attachments.yml index 14b45b1b..901d2eac 100644 --- a/.mock/definition/ats/attachments.yml +++ b/.mock/definition/ats/attachments.yml @@ -82,7 +82,10 @@ service: type: root.PaginatedAttachmentList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -134,7 +137,8 @@ service: type: root.AttachmentResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} remote_user_id: remote_user_id @@ -223,7 +227,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: c640b80b-fac9-409f-aa19-1f9221aec445 @@ -256,7 +261,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/ats/auditTrail.yml b/.mock/definition/ats/auditTrail.yml index 36833ffe..d5a8c615 100644 --- a/.mock/definition/ats/auditTrail.yml +++ b/.mock/definition/ats/auditTrail.yml @@ -75,7 +75,11 @@ service: type: root.PaginatedAuditLogEventList status-code: 200 examples: - - response: + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: '[object Object]' + response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ diff --git a/.mock/definition/ats/availableActions.yml b/.mock/definition/ats/availableActions.yml index 8e529df3..2f7515df 100644 --- a/.mock/definition/ats/availableActions.yml +++ b/.mock/definition/ats/availableActions.yml @@ -16,7 +16,8 @@ service: type: root.AvailableActions status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: integration: diff --git a/.mock/definition/ats/candidates.yml b/.mock/definition/ats/candidates.yml index e5f23a79..e38f44e9 100644 --- a/.mock/definition/ats/candidates.yml +++ b/.mock/definition/ats/candidates.yml @@ -110,7 +110,10 @@ service: type: root.PaginatedCandidateList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -194,7 +197,8 @@ service: type: root.CandidateResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} remote_user_id: remote_user_id @@ -305,7 +309,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 521b18c2-4d01-4297-b451-19858d07c133 @@ -393,7 +398,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token request: model: {} remote_user_id: remote_user_id @@ -497,7 +503,8 @@ service: examples: - path-parameters: model_id: model_id - headers: {} + headers: + X-Account-Token: X-Account-Token request: reason: GENERAL_CUSTOMER_REQUEST metaPatchRetrieve: @@ -516,7 +523,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -700,7 +708,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/ats/deleteAccount.yml b/.mock/definition/ats/deleteAccount.yml index 6255a393..9ffe1a71 100644 --- a/.mock/definition/ats/deleteAccount.yml +++ b/.mock/definition/ats/deleteAccount.yml @@ -10,6 +10,7 @@ service: source: openapi: openapi/openapi.yml examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token source: openapi: openapi/openapi.yml diff --git a/.mock/definition/ats/departments.yml b/.mock/definition/ats/departments.yml index 8f001f43..ec1c4fa0 100644 --- a/.mock/definition/ats/departments.yml +++ b/.mock/definition/ats/departments.yml @@ -64,7 +64,10 @@ service: type: root.PaginatedDepartmentList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -114,7 +117,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 5b3c1341-a20f-4e51-b72c-f3830a16c97b diff --git a/.mock/definition/ats/eeocs.yml b/.mock/definition/ats/eeocs.yml index 91dbf6b9..b14f676d 100644 --- a/.mock/definition/ats/eeocs.yml +++ b/.mock/definition/ats/eeocs.yml @@ -203,7 +203,10 @@ service: type: root.PaginatedEeocList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -273,7 +276,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: f7dd7b4f-237e-4772-8bd4-3246384c6c58 diff --git a/.mock/definition/ats/fieldMapping.yml b/.mock/definition/ats/fieldMapping.yml index 9d92fea8..949a75b5 100644 --- a/.mock/definition/ats/fieldMapping.yml +++ b/.mock/definition/ats/fieldMapping.yml @@ -30,7 +30,8 @@ service: type: root.FieldMappingApiInstanceResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: Activity: @@ -357,7 +358,8 @@ service: type: root.FieldMappingInstanceResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: target_field_name: example_target_field_name target_field_description: this is a example description of the target field @@ -424,7 +426,8 @@ service: examples: - path-parameters: field_mapping_id: field_mapping_id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: model: @@ -506,7 +509,8 @@ service: examples: - path-parameters: field_mapping_id: field_mapping_id - headers: {} + headers: + X-Account-Token: X-Account-Token request: {} response: body: @@ -577,7 +581,8 @@ service: type: root.RemoteFieldApiResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: Activity: @@ -821,7 +826,8 @@ service: type: root.ExternalTargetFieldApiResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: Activity: diff --git a/.mock/definition/ats/forceResync.yml b/.mock/definition/ats/forceResync.yml index 8a603992..b939eabe 100644 --- a/.mock/definition/ats/forceResync.yml +++ b/.mock/definition/ats/forceResync.yml @@ -21,7 +21,8 @@ service: type: list status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: - model_name: Candidate diff --git a/.mock/definition/ats/generateKey.yml b/.mock/definition/ats/generateKey.yml index 40a39dcb..c7da4da8 100644 --- a/.mock/definition/ats/generateKey.yml +++ b/.mock/definition/ats/generateKey.yml @@ -26,7 +26,9 @@ service: type: root.RemoteKey status-code: 200 examples: - - request: + - headers: + X-Account-Token: '[object Object]' + request: name: Remote Deployment Key 1 response: body: diff --git a/.mock/definition/ats/interviews.yml b/.mock/definition/ats/interviews.yml index aa95289c..0d25c536 100644 --- a/.mock/definition/ats/interviews.yml +++ b/.mock/definition/ats/interviews.yml @@ -152,7 +152,10 @@ service: type: root.PaginatedScheduledInterviewList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -212,7 +215,8 @@ service: type: root.ScheduledInterviewResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} remote_user_id: remote_user_id @@ -309,7 +313,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: b8faf072-98b9-4445-8a9a-6b4950efca19 @@ -350,7 +355,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/ats/issues.yml b/.mock/definition/ats/issues.yml index 4984ce4e..51de2a7d 100644 --- a/.mock/definition/ats/issues.yml +++ b/.mock/definition/ats/issues.yml @@ -80,7 +80,11 @@ service: type: root.PaginatedIssueList status-code: 200 examples: - - response: + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: '[object Object]' + response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ @@ -112,6 +116,8 @@ service: examples: - path-parameters: id: id + headers: + X-Account-Token: '[object Object]' response: body: id: 3fa85f64-5717-4562-b3fc-2c963f66afa6 diff --git a/.mock/definition/ats/jobInterviewStages.yml b/.mock/definition/ats/jobInterviewStages.yml index 5753b281..d1a7f9fd 100644 --- a/.mock/definition/ats/jobInterviewStages.yml +++ b/.mock/definition/ats/jobInterviewStages.yml @@ -72,7 +72,10 @@ service: type: root.PaginatedJobInterviewStageList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -129,7 +132,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: f9813dd5-e70b-484c-91d8-00acd6065b07 diff --git a/.mock/definition/ats/jobPostings.yml b/.mock/definition/ats/jobPostings.yml index 859b5bb4..c888c890 100644 --- a/.mock/definition/ats/jobPostings.yml +++ b/.mock/definition/ats/jobPostings.yml @@ -95,7 +95,10 @@ service: type: root.PaginatedJobPostingList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -161,7 +164,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 156a2bef-57e5-4def-8ed2-7c41bd9a554t diff --git a/.mock/definition/ats/jobs.yml b/.mock/definition/ats/jobs.yml index 7ec7441a..b5f780af 100644 --- a/.mock/definition/ats/jobs.yml +++ b/.mock/definition/ats/jobs.yml @@ -243,7 +243,10 @@ service: type: root.PaginatedJobList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -334,7 +337,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 022a2bef-57e5-4def-8ed2-7c41bd9a5ed8 @@ -427,7 +431,10 @@ service: examples: - path-parameters: job_id: job_id - headers: {} + query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw diff --git a/.mock/definition/ats/linkToken.yml b/.mock/definition/ats/linkToken.yml index 1548f705..a6b77072 100644 --- a/.mock/definition/ats/linkToken.yml +++ b/.mock/definition/ats/linkToken.yml @@ -136,7 +136,9 @@ service: type: root.LinkToken status-code: 200 examples: - - request: + - headers: + X-Account-Token: '[object Object]' + request: end_user_email_address: example@gmail.com end_user_organization_name: Test Organization end_user_origin_id: '12345' diff --git a/.mock/definition/ats/linkedAccounts.yml b/.mock/definition/ats/linkedAccounts.yml index 7acf3099..1f942677 100644 --- a/.mock/definition/ats/linkedAccounts.yml +++ b/.mock/definition/ats/linkedAccounts.yml @@ -107,7 +107,11 @@ service: type: root.PaginatedAccountDetailsAndActionsList status-code: 200 examples: - - response: + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: '[object Object]' + response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ diff --git a/.mock/definition/ats/offers.yml b/.mock/definition/ats/offers.yml index cb2591c8..bfbc9bb7 100644 --- a/.mock/definition/ats/offers.yml +++ b/.mock/definition/ats/offers.yml @@ -102,7 +102,10 @@ service: type: root.PaginatedOfferList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -173,7 +176,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: dd85625c-6a59-446f-a317-6de64d83bae7 diff --git a/.mock/definition/ats/offices.yml b/.mock/definition/ats/offices.yml index 080386b8..d8009929 100644 --- a/.mock/definition/ats/offices.yml +++ b/.mock/definition/ats/offices.yml @@ -64,7 +64,10 @@ service: type: root.PaginatedOfficeList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -115,7 +118,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 9871b4a9-f5d2-4f3b-a66b-dfedbed42c46 diff --git a/.mock/definition/ats/passthrough.yml b/.mock/definition/ats/passthrough.yml index 7141a6bd..a3dff513 100644 --- a/.mock/definition/ats/passthrough.yml +++ b/.mock/definition/ats/passthrough.yml @@ -19,7 +19,8 @@ service: type: root.RemoteResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: method: GET path: /scooters diff --git a/.mock/definition/ats/regenerateKey.yml b/.mock/definition/ats/regenerateKey.yml index 1ea4149a..5db09f20 100644 --- a/.mock/definition/ats/regenerateKey.yml +++ b/.mock/definition/ats/regenerateKey.yml @@ -26,7 +26,9 @@ service: type: root.RemoteKey status-code: 200 examples: - - request: + - headers: + X-Account-Token: '[object Object]' + request: name: Remote Deployment Key 1 response: body: diff --git a/.mock/definition/ats/rejectReasons.yml b/.mock/definition/ats/rejectReasons.yml index 1552c46c..fc100819 100644 --- a/.mock/definition/ats/rejectReasons.yml +++ b/.mock/definition/ats/rejectReasons.yml @@ -64,7 +64,10 @@ service: type: root.PaginatedRejectReasonList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -114,7 +117,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 8be99a4a-f8d4-4339-bf1e-30eac970e217 diff --git a/.mock/definition/ats/scopes.yml b/.mock/definition/ats/scopes.yml index 422d3fa4..bdaf6ed0 100644 --- a/.mock/definition/ats/scopes.yml +++ b/.mock/definition/ats/scopes.yml @@ -19,7 +19,9 @@ service: type: root.CommonModelScopeApi status-code: 200 examples: - - response: + - headers: + X-Account-Token: '[object Object]' + response: body: common_models: - model_name: Employee @@ -60,7 +62,8 @@ service: type: root.CommonModelScopeApi status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: common_models: @@ -111,7 +114,8 @@ service: type: root.CommonModelScopeApi status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: common_models: - model_name: Employee diff --git a/.mock/definition/ats/scorecards.yml b/.mock/definition/ats/scorecards.yml index 6f83e854..a5f93514 100644 --- a/.mock/definition/ats/scorecards.yml +++ b/.mock/definition/ats/scorecards.yml @@ -119,7 +119,10 @@ service: type: root.PaginatedScorecardList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -189,7 +192,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 3eab2f17-eeb1-450d-97f0-029d8be1e06f diff --git a/.mock/definition/ats/syncStatus.yml b/.mock/definition/ats/syncStatus.yml index 99b9bd54..81b1fa9c 100644 --- a/.mock/definition/ats/syncStatus.yml +++ b/.mock/definition/ats/syncStatus.yml @@ -36,7 +36,10 @@ service: type: root.PaginatedSyncStatusList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw diff --git a/.mock/definition/ats/tags.yml b/.mock/definition/ats/tags.yml index f6007d90..106e5cf9 100644 --- a/.mock/definition/ats/tags.yml +++ b/.mock/definition/ats/tags.yml @@ -64,7 +64,10 @@ service: type: root.PaginatedTagList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw diff --git a/.mock/definition/ats/users.yml b/.mock/definition/ats/users.yml index 3bd2db1f..90a2bb54 100644 --- a/.mock/definition/ats/users.yml +++ b/.mock/definition/ats/users.yml @@ -81,7 +81,10 @@ service: type: root.PaginatedRemoteUserList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -146,7 +149,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: b82302de-852e-4e60-b050-edf9da3b7c02 diff --git a/.mock/definition/ats/webhookReceivers.yml b/.mock/definition/ats/webhookReceivers.yml index 91d2ae65..76339c9f 100644 --- a/.mock/definition/ats/webhookReceivers.yml +++ b/.mock/definition/ats/webhookReceivers.yml @@ -16,7 +16,8 @@ service: type: list status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: - event: event @@ -48,7 +49,8 @@ service: type: root.WebhookReceiver status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: event: event is_active: true diff --git a/.mock/definition/crm/__package__.yml b/.mock/definition/crm/__package__.yml index 4ad8f75d..1ff6b8e0 100644 --- a/.mock/definition/crm/__package__.yml +++ b/.mock/definition/crm/__package__.yml @@ -2076,17 +2076,6 @@ types: source: openapi: openapi/openapi.yml inline: true - ContactOwner: - discriminated: false - docs: The contact's owner. - union: - - type: string - validation: - format: uuid - - User - source: - openapi: openapi/openapi.yml - inline: true Contact: docs: >- # The Contact Object @@ -2126,8 +2115,10 @@ types: type: optional docs: The contact's account. owner: - type: optional + type: optional docs: The contact's owner. + validation: + format: uuid addresses: optional> email_addresses: optional> phone_numbers: optional> @@ -2168,17 +2159,6 @@ types: source: openapi: openapi/openapi.yml inline: true - ContactRequestOwner: - discriminated: false - docs: The contact's owner. - union: - - type: string - validation: - format: uuid - - User - source: - openapi: openapi/openapi.yml - inline: true ContactRequest: docs: >- # The Contact Object @@ -2202,8 +2182,10 @@ types: type: optional docs: The contact's account. owner: - type: optional + type: optional docs: The contact's owner. + validation: + format: uuid addresses: optional> email_addresses: optional> phone_numbers: optional> @@ -2821,6 +2803,22 @@ types: access: write-only source: openapi: openapi/openapi.yml + DataPassthroughRequestMethod: + discriminated: false + union: + - MethodEnum + - string + source: + openapi: openapi/openapi.yml + inline: true + DataPassthroughRequestRequestFormat: + discriminated: false + union: + - RequestFormatEnum + - string + source: + openapi: openapi/openapi.yml + inline: true DataPassthroughRequest: docs: >- # The DataPassthrough Object @@ -2836,7 +2834,7 @@ types: Create a `DataPassthrough` to get team hierarchies from your Rippling integration. properties: - method: MethodEnum + method: DataPassthroughRequestMethod path: type: string docs: The path of the request in the third party's platform. @@ -2866,7 +2864,7 @@ types: authorization headers). `Content-Type` header is required for passthrough. Choose content type corresponding to expected format of receiving server. - request_format: optional + request_format: optional normalize_response: type: optional docs: >- @@ -5158,6 +5156,7 @@ types: remote_key_name: optional description: optional is_custom: optional + is_common_model_field: optional is_required: optional field_type: optional field_format: optional diff --git a/.mock/definition/crm/accountDetails.yml b/.mock/definition/crm/accountDetails.yml index 4fe53ba5..2d2405a1 100644 --- a/.mock/definition/crm/accountDetails.yml +++ b/.mock/definition/crm/accountDetails.yml @@ -16,7 +16,8 @@ service: type: root.AccountDetails status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: id: 0496d4c2-42e6-4072-80b3-7b69bfdc76fd diff --git a/.mock/definition/crm/accountToken.yml b/.mock/definition/crm/accountToken.yml index f06c40c5..a47b83c3 100644 --- a/.mock/definition/crm/accountToken.yml +++ b/.mock/definition/crm/accountToken.yml @@ -22,6 +22,8 @@ service: examples: - path-parameters: public_token: public_token + headers: + X-Account-Token: '[object Object]' response: body: account_token: T9klMDQrcHdm9jrtHuOS2Nf06BIHwMNjpPXPMB diff --git a/.mock/definition/crm/accounts.yml b/.mock/definition/crm/accounts.yml index e2959115..2e936825 100644 --- a/.mock/definition/crm/accounts.yml +++ b/.mock/definition/crm/accounts.yml @@ -80,7 +80,10 @@ service: type: root.PaginatedAccountList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -153,7 +156,8 @@ service: type: root.CrmAccountResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -258,7 +262,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 0958cbc6-6040-430a-848e-aafacbadf4ae @@ -334,7 +339,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -416,7 +422,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -600,7 +607,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -826,7 +834,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -837,6 +848,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/crm/associationTypes.yml b/.mock/definition/crm/associationTypes.yml index 01f582d6..44da88c3 100644 --- a/.mock/definition/crm/associationTypes.yml +++ b/.mock/definition/crm/associationTypes.yml @@ -73,7 +73,10 @@ service: examples: - path-parameters: custom_object_class_id: custom_object_class_id - headers: {} + query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -124,7 +127,8 @@ service: examples: - path-parameters: custom_object_class_id: custom_object_class_id - headers: {} + headers: + X-Account-Token: X-Account-Token request: model: source_object_class: @@ -208,7 +212,8 @@ service: - path-parameters: custom_object_class_id: custom_object_class_id id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 5bb73c32-3c6c-4757-ab7d-7d3540a1be31 @@ -244,7 +249,8 @@ service: examples: - path-parameters: custom_object_class_id: custom_object_class_id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/crm/associations.yml b/.mock/definition/crm/associations.yml index bf27f3eb..983b55fe 100644 --- a/.mock/definition/crm/associations.yml +++ b/.mock/definition/crm/associations.yml @@ -81,7 +81,10 @@ service: - path-parameters: custom_object_class_id: custom_object_class_id object_id: object_id - headers: {} + query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -130,7 +133,8 @@ service: source_object_id: source_object_id target_class_id: target_class_id target_object_id: target_object_id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: created_at: '2021-09-15T00:00:00Z' diff --git a/.mock/definition/crm/asyncPassthrough.yml b/.mock/definition/crm/asyncPassthrough.yml index 6a7e257e..2fc106c9 100644 --- a/.mock/definition/crm/asyncPassthrough.yml +++ b/.mock/definition/crm/asyncPassthrough.yml @@ -21,7 +21,8 @@ service: type: root.AsyncPassthroughReciept status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: method: GET path: /scooters @@ -44,7 +45,8 @@ service: examples: - path-parameters: async_passthrough_receipt_id: async_passthrough_receipt_id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: method: GET diff --git a/.mock/definition/crm/auditTrail.yml b/.mock/definition/crm/auditTrail.yml index 68ad5c2f..be883e26 100644 --- a/.mock/definition/crm/auditTrail.yml +++ b/.mock/definition/crm/auditTrail.yml @@ -75,7 +75,11 @@ service: type: root.PaginatedAuditLogEventList status-code: 200 examples: - - response: + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: '[object Object]' + response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ diff --git a/.mock/definition/crm/availableActions.yml b/.mock/definition/crm/availableActions.yml index 40338033..71b5d890 100644 --- a/.mock/definition/crm/availableActions.yml +++ b/.mock/definition/crm/availableActions.yml @@ -16,7 +16,8 @@ service: type: root.AvailableActions status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: integration: diff --git a/.mock/definition/crm/contacts.yml b/.mock/definition/crm/contacts.yml index b9f0b0f0..5b9b9779 100644 --- a/.mock/definition/crm/contacts.yml +++ b/.mock/definition/crm/contacts.yml @@ -104,7 +104,10 @@ service: type: root.PaginatedContactList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -117,7 +120,7 @@ service: first_name: Gil last_name: Feig account: account - owner: owner + owner: b8fbfc30-0982-420e-8c20-dab07b70b9d6 addresses: - created_at: '2021-09-15T00:00:00Z' modified_at: '2021-10-16T00:00:00Z' @@ -179,7 +182,8 @@ service: type: root.CrmContactResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -192,7 +196,7 @@ service: first_name: Gil last_name: Feig account: account - owner: owner + owner: b8fbfc30-0982-420e-8c20-dab07b70b9d6 addresses: - created_at: '2021-09-15T00:00:00Z' modified_at: '2021-10-16T00:00:00Z' @@ -286,7 +290,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 550e8400-e29b-41d4-a716-446655440000 @@ -296,7 +301,7 @@ service: first_name: Gil last_name: Feig account: account - owner: owner + owner: b8fbfc30-0982-420e-8c20-dab07b70b9d6 addresses: - created_at: '2021-09-15T00:00:00Z' modified_at: '2021-10-16T00:00:00Z' @@ -364,7 +369,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -377,7 +383,7 @@ service: first_name: Gil last_name: Feig account: account - owner: owner + owner: b8fbfc30-0982-420e-8c20-dab07b70b9d6 addresses: - created_at: '2021-09-15T00:00:00Z' modified_at: '2021-10-16T00:00:00Z' @@ -451,7 +457,8 @@ service: examples: - path-parameters: model_id: model_id - headers: {} + headers: + X-Account-Token: X-Account-Token request: reason: GENERAL_CUSTOMER_REQUEST metaPatchRetrieve: @@ -470,7 +477,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -654,7 +662,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -880,7 +889,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -891,6 +903,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/crm/customObjectClasses.yml b/.mock/definition/crm/customObjectClasses.yml index 7f6a5fba..87b54cad 100644 --- a/.mock/definition/crm/customObjectClasses.yml +++ b/.mock/definition/crm/customObjectClasses.yml @@ -69,7 +69,10 @@ service: type: root.PaginatedCustomObjectClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -146,7 +149,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: ff1ff4cb-a66b-47dc-8e2a-50388049e602 diff --git a/.mock/definition/crm/customObjects.yml b/.mock/definition/crm/customObjects.yml index d4904e56..275d59c9 100644 --- a/.mock/definition/crm/customObjects.yml +++ b/.mock/definition/crm/customObjects.yml @@ -73,7 +73,10 @@ service: examples: - path-parameters: custom_object_class_id: custom_object_class_id - headers: {} + query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -121,7 +124,8 @@ service: examples: - path-parameters: custom_object_class_id: custom_object_class_id - headers: {} + headers: + X-Account-Token: X-Account-Token request: model: fields: @@ -197,7 +201,8 @@ service: - path-parameters: custom_object_class_id: custom_object_class_id id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: da0b1963-be70-469c-9f8c-06a81d0fe759 @@ -230,7 +235,8 @@ service: examples: - path-parameters: custom_object_class_id: custom_object_class_id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -456,7 +462,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -467,6 +476,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/crm/deleteAccount.yml b/.mock/definition/crm/deleteAccount.yml index b0bfe1cd..9a343bd8 100644 --- a/.mock/definition/crm/deleteAccount.yml +++ b/.mock/definition/crm/deleteAccount.yml @@ -10,6 +10,7 @@ service: source: openapi: openapi/openapi.yml examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token source: openapi: openapi/openapi.yml diff --git a/.mock/definition/crm/engagementTypes.yml b/.mock/definition/crm/engagementTypes.yml index 2070b2ef..025fe8e8 100644 --- a/.mock/definition/crm/engagementTypes.yml +++ b/.mock/definition/crm/engagementTypes.yml @@ -69,7 +69,10 @@ service: type: root.PaginatedEngagementTypeList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -117,7 +120,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 550e8400-e29b-41d4-a716-446655440000 @@ -184,7 +188,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -195,6 +202,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/crm/engagements.yml b/.mock/definition/crm/engagements.yml index aaf88ac0..0812685b 100644 --- a/.mock/definition/crm/engagements.yml +++ b/.mock/definition/crm/engagements.yml @@ -145,7 +145,10 @@ service: type: root.PaginatedEngagementList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -204,7 +207,8 @@ service: type: root.EngagementResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -295,7 +299,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 550e8400-e29b-41d4-a716-446655440000 @@ -357,7 +362,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -425,7 +431,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -609,7 +616,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -835,7 +843,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -846,6 +857,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/crm/fieldMapping.yml b/.mock/definition/crm/fieldMapping.yml index 5318dcf3..81c29c9c 100644 --- a/.mock/definition/crm/fieldMapping.yml +++ b/.mock/definition/crm/fieldMapping.yml @@ -30,7 +30,8 @@ service: type: root.FieldMappingApiInstanceResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: Account: @@ -245,7 +246,8 @@ service: type: root.FieldMappingInstanceResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: target_field_name: example_target_field_name target_field_description: this is a example description of the target field @@ -312,7 +314,8 @@ service: examples: - path-parameters: field_mapping_id: field_mapping_id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: model: @@ -394,7 +397,8 @@ service: examples: - path-parameters: field_mapping_id: field_mapping_id - headers: {} + headers: + X-Account-Token: X-Account-Token request: {} response: body: @@ -465,7 +469,8 @@ service: type: root.RemoteFieldApiResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: Account: @@ -611,7 +616,8 @@ service: type: root.ExternalTargetFieldApiResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: Account: diff --git a/.mock/definition/crm/forceResync.yml b/.mock/definition/crm/forceResync.yml index eb74ba18..32a995cb 100644 --- a/.mock/definition/crm/forceResync.yml +++ b/.mock/definition/crm/forceResync.yml @@ -21,7 +21,8 @@ service: type: list status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: - model_name: Account diff --git a/.mock/definition/crm/generateKey.yml b/.mock/definition/crm/generateKey.yml index 233479da..c913f239 100644 --- a/.mock/definition/crm/generateKey.yml +++ b/.mock/definition/crm/generateKey.yml @@ -26,7 +26,9 @@ service: type: root.RemoteKey status-code: 200 examples: - - request: + - headers: + X-Account-Token: '[object Object]' + request: name: Remote Deployment Key 1 response: body: diff --git a/.mock/definition/crm/issues.yml b/.mock/definition/crm/issues.yml index ed21c69c..85deddd4 100644 --- a/.mock/definition/crm/issues.yml +++ b/.mock/definition/crm/issues.yml @@ -80,7 +80,11 @@ service: type: root.PaginatedIssueList status-code: 200 examples: - - response: + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: '[object Object]' + response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ @@ -112,6 +116,8 @@ service: examples: - path-parameters: id: id + headers: + X-Account-Token: '[object Object]' response: body: id: 3fa85f64-5717-4562-b3fc-2c963f66afa6 diff --git a/.mock/definition/crm/leads.yml b/.mock/definition/crm/leads.yml index 1f1e46d1..f6cc37af 100644 --- a/.mock/definition/crm/leads.yml +++ b/.mock/definition/crm/leads.yml @@ -124,7 +124,10 @@ service: type: root.PaginatedLeadList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -204,7 +207,8 @@ service: type: root.LeadResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -316,7 +320,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 550e8400-e29b-41d4-a716-446655440000 @@ -380,7 +385,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -606,7 +612,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -617,6 +626,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/crm/linkToken.yml b/.mock/definition/crm/linkToken.yml index f67b6892..d01d1d24 100644 --- a/.mock/definition/crm/linkToken.yml +++ b/.mock/definition/crm/linkToken.yml @@ -136,7 +136,9 @@ service: type: root.LinkToken status-code: 200 examples: - - request: + - headers: + X-Account-Token: '[object Object]' + request: end_user_email_address: example@gmail.com end_user_organization_name: Test Organization end_user_origin_id: '12345' diff --git a/.mock/definition/crm/linkedAccounts.yml b/.mock/definition/crm/linkedAccounts.yml index c6f4399e..d2bf12d2 100644 --- a/.mock/definition/crm/linkedAccounts.yml +++ b/.mock/definition/crm/linkedAccounts.yml @@ -107,7 +107,11 @@ service: type: root.PaginatedAccountDetailsAndActionsList status-code: 200 examples: - - response: + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: '[object Object]' + response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ diff --git a/.mock/definition/crm/notes.yml b/.mock/definition/crm/notes.yml index df9293aa..ac7d94d1 100644 --- a/.mock/definition/crm/notes.yml +++ b/.mock/definition/crm/notes.yml @@ -147,7 +147,10 @@ service: type: root.PaginatedNoteList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -203,7 +206,8 @@ service: type: root.NoteResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -291,7 +295,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 550e8400-e29b-41d4-a716-446655440000 @@ -331,7 +336,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -557,7 +563,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -568,6 +577,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/crm/opportunities.yml b/.mock/definition/crm/opportunities.yml index 4a0253aa..3aaaa4d0 100644 --- a/.mock/definition/crm/opportunities.yml +++ b/.mock/definition/crm/opportunities.yml @@ -148,7 +148,10 @@ service: type: root.PaginatedOpportunityList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -207,7 +210,8 @@ service: type: root.OpportunityResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -308,7 +312,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 550e8400-e29b-41d4-a716-446655440000 @@ -370,7 +375,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -438,7 +444,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -622,7 +629,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -848,7 +856,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -859,6 +870,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/crm/passthrough.yml b/.mock/definition/crm/passthrough.yml index 902b459d..a0a04015 100644 --- a/.mock/definition/crm/passthrough.yml +++ b/.mock/definition/crm/passthrough.yml @@ -19,7 +19,8 @@ service: type: root.RemoteResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: method: GET path: /scooters diff --git a/.mock/definition/crm/regenerateKey.yml b/.mock/definition/crm/regenerateKey.yml index 06a1b856..d807b273 100644 --- a/.mock/definition/crm/regenerateKey.yml +++ b/.mock/definition/crm/regenerateKey.yml @@ -26,7 +26,9 @@ service: type: root.RemoteKey status-code: 200 examples: - - request: + - headers: + X-Account-Token: '[object Object]' + request: name: Remote Deployment Key 1 response: body: diff --git a/.mock/definition/crm/scopes.yml b/.mock/definition/crm/scopes.yml index 67286e70..7069f300 100644 --- a/.mock/definition/crm/scopes.yml +++ b/.mock/definition/crm/scopes.yml @@ -19,7 +19,9 @@ service: type: root.CommonModelScopeApi status-code: 200 examples: - - response: + - headers: + X-Account-Token: '[object Object]' + response: body: common_models: - model_name: Employee @@ -60,7 +62,8 @@ service: type: root.CommonModelScopeApi status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: common_models: @@ -111,7 +114,8 @@ service: type: root.CommonModelScopeApi status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: common_models: - model_name: Employee diff --git a/.mock/definition/crm/stages.yml b/.mock/definition/crm/stages.yml index a8676fa5..126f73c6 100644 --- a/.mock/definition/crm/stages.yml +++ b/.mock/definition/crm/stages.yml @@ -69,7 +69,10 @@ service: type: root.PaginatedStageList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -126,7 +129,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 0358cbc6-2040-430a-848e-aafacbadf3aa @@ -202,7 +206,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -213,6 +220,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/crm/syncStatus.yml b/.mock/definition/crm/syncStatus.yml index 52d8c36e..8e3a610c 100644 --- a/.mock/definition/crm/syncStatus.yml +++ b/.mock/definition/crm/syncStatus.yml @@ -36,7 +36,10 @@ service: type: root.PaginatedSyncStatusList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw diff --git a/.mock/definition/crm/tasks.yml b/.mock/definition/crm/tasks.yml index befb0c54..e5b9f3b8 100644 --- a/.mock/definition/crm/tasks.yml +++ b/.mock/definition/crm/tasks.yml @@ -105,7 +105,10 @@ service: type: root.PaginatedTaskList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -162,7 +165,8 @@ service: type: root.TaskResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -251,7 +255,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 550e8400-e29b-41d4-a716-446655440000 @@ -311,7 +316,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -377,7 +383,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -561,7 +568,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -787,7 +795,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -798,6 +809,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/crm/users.yml b/.mock/definition/crm/users.yml index 6762984a..ba9863c8 100644 --- a/.mock/definition/crm/users.yml +++ b/.mock/definition/crm/users.yml @@ -72,7 +72,10 @@ service: type: root.PaginatedUserList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -131,7 +134,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 0358cbc6-2040-430a-848e-aafacbadf3aa @@ -174,7 +178,8 @@ service: examples: - path-parameters: model_id: model_id - headers: {} + headers: + X-Account-Token: X-Account-Token request: reason: GENERAL_CUSTOMER_REQUEST remoteFieldClassesList: @@ -231,7 +236,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -242,6 +250,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/crm/webhookReceivers.yml b/.mock/definition/crm/webhookReceivers.yml index c68cd98b..e01c1645 100644 --- a/.mock/definition/crm/webhookReceivers.yml +++ b/.mock/definition/crm/webhookReceivers.yml @@ -16,7 +16,8 @@ service: type: list status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: - event: event @@ -48,7 +49,8 @@ service: type: root.WebhookReceiver status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: event: event is_active: true diff --git a/.mock/definition/filestorage/accountDetails.yml b/.mock/definition/filestorage/accountDetails.yml index 2411f37c..944a422b 100644 --- a/.mock/definition/filestorage/accountDetails.yml +++ b/.mock/definition/filestorage/accountDetails.yml @@ -16,7 +16,8 @@ service: type: root.AccountDetails status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: id: 0496d4c2-42e6-4072-80b3-7b69bfdc76fd diff --git a/.mock/definition/filestorage/accountToken.yml b/.mock/definition/filestorage/accountToken.yml index 2c17a04f..e5400279 100644 --- a/.mock/definition/filestorage/accountToken.yml +++ b/.mock/definition/filestorage/accountToken.yml @@ -22,6 +22,8 @@ service: examples: - path-parameters: public_token: public_token + headers: + X-Account-Token: '[object Object]' response: body: account_token: T9klMDQrcHdm9jrtHuOS2Nf06BIHwMNjpPXPMB diff --git a/.mock/definition/filestorage/asyncPassthrough.yml b/.mock/definition/filestorage/asyncPassthrough.yml index 58df8351..1408e056 100644 --- a/.mock/definition/filestorage/asyncPassthrough.yml +++ b/.mock/definition/filestorage/asyncPassthrough.yml @@ -21,7 +21,8 @@ service: type: root.AsyncPassthroughReciept status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: method: GET path: /scooters @@ -44,7 +45,8 @@ service: examples: - path-parameters: async_passthrough_receipt_id: async_passthrough_receipt_id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: method: GET diff --git a/.mock/definition/filestorage/auditTrail.yml b/.mock/definition/filestorage/auditTrail.yml index f21c35fe..c9fb17ce 100644 --- a/.mock/definition/filestorage/auditTrail.yml +++ b/.mock/definition/filestorage/auditTrail.yml @@ -75,7 +75,11 @@ service: type: root.PaginatedAuditLogEventList status-code: 200 examples: - - response: + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: '[object Object]' + response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ diff --git a/.mock/definition/filestorage/availableActions.yml b/.mock/definition/filestorage/availableActions.yml index b7a5e2b1..b60bd0c8 100644 --- a/.mock/definition/filestorage/availableActions.yml +++ b/.mock/definition/filestorage/availableActions.yml @@ -16,7 +16,8 @@ service: type: root.AvailableActions status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: integration: diff --git a/.mock/definition/filestorage/deleteAccount.yml b/.mock/definition/filestorage/deleteAccount.yml index 9b691154..cb9280c2 100644 --- a/.mock/definition/filestorage/deleteAccount.yml +++ b/.mock/definition/filestorage/deleteAccount.yml @@ -10,6 +10,7 @@ service: source: openapi: openapi/openapi.yml examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token source: openapi: openapi/openapi.yml diff --git a/.mock/definition/filestorage/drives.yml b/.mock/definition/filestorage/drives.yml index 969b2321..8053831f 100644 --- a/.mock/definition/filestorage/drives.yml +++ b/.mock/definition/filestorage/drives.yml @@ -69,7 +69,10 @@ service: type: root.PaginatedDriveList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -121,7 +124,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: f9e3d315-d6c2-458e-85c4-fa773d6ff4a6 diff --git a/.mock/definition/filestorage/fieldMapping.yml b/.mock/definition/filestorage/fieldMapping.yml index 0ef97a18..73378990 100644 --- a/.mock/definition/filestorage/fieldMapping.yml +++ b/.mock/definition/filestorage/fieldMapping.yml @@ -30,7 +30,8 @@ service: type: root.FieldMappingApiInstanceResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: File: @@ -181,7 +182,8 @@ service: type: root.FieldMappingInstanceResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: target_field_name: example_target_field_name target_field_description: this is a example description of the target field @@ -248,7 +250,8 @@ service: examples: - path-parameters: field_mapping_id: field_mapping_id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: model: @@ -330,7 +333,8 @@ service: examples: - path-parameters: field_mapping_id: field_mapping_id - headers: {} + headers: + X-Account-Token: X-Account-Token request: {} response: body: @@ -401,7 +405,8 @@ service: type: root.RemoteFieldApiResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: File: @@ -491,7 +496,8 @@ service: type: root.ExternalTargetFieldApiResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: File: diff --git a/.mock/definition/filestorage/files.yml b/.mock/definition/filestorage/files.yml index 7230424d..97b56cde 100644 --- a/.mock/definition/filestorage/files.yml +++ b/.mock/definition/filestorage/files.yml @@ -150,7 +150,10 @@ service: type: root.PaginatedFileList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -215,7 +218,8 @@ service: type: root.FileStorageFileResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -307,7 +311,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 45ce474c-dhcj-43a6-754r-629f799f7d68 @@ -401,7 +406,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 3fa85f64-5717-4562-b3fc-2c963f66afa6 @@ -473,7 +479,10 @@ service: type: root.PaginatedDownloadRequestMetaList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -496,7 +505,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/filestorage/folders.yml b/.mock/definition/filestorage/folders.yml index 50ad205b..5ad69d06 100644 --- a/.mock/definition/filestorage/folders.yml +++ b/.mock/definition/filestorage/folders.yml @@ -113,7 +113,10 @@ service: type: root.PaginatedFolderList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -169,7 +172,8 @@ service: type: root.FileStorageFolderResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -252,7 +256,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: e021f7a7-74fc-4487-8e12-14180c92d3b7 @@ -290,7 +295,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/filestorage/forceResync.yml b/.mock/definition/filestorage/forceResync.yml index 644c49b8..6dc20ca9 100644 --- a/.mock/definition/filestorage/forceResync.yml +++ b/.mock/definition/filestorage/forceResync.yml @@ -21,7 +21,8 @@ service: type: list status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: - model_name: File diff --git a/.mock/definition/filestorage/generateKey.yml b/.mock/definition/filestorage/generateKey.yml index 04ac41b8..06b1c8d7 100644 --- a/.mock/definition/filestorage/generateKey.yml +++ b/.mock/definition/filestorage/generateKey.yml @@ -26,7 +26,9 @@ service: type: root.RemoteKey status-code: 200 examples: - - request: + - headers: + X-Account-Token: '[object Object]' + request: name: Remote Deployment Key 1 response: body: diff --git a/.mock/definition/filestorage/groups.yml b/.mock/definition/filestorage/groups.yml index 247ce30a..75e3efbd 100644 --- a/.mock/definition/filestorage/groups.yml +++ b/.mock/definition/filestorage/groups.yml @@ -69,7 +69,10 @@ service: type: root.PaginatedGroupList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -128,7 +131,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 5624aceb-0ea2-4864-ba08-354ac56b9884 diff --git a/.mock/definition/filestorage/issues.yml b/.mock/definition/filestorage/issues.yml index b6a1d19e..19a40bd9 100644 --- a/.mock/definition/filestorage/issues.yml +++ b/.mock/definition/filestorage/issues.yml @@ -80,7 +80,11 @@ service: type: root.PaginatedIssueList status-code: 200 examples: - - response: + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: '[object Object]' + response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ @@ -112,6 +116,8 @@ service: examples: - path-parameters: id: id + headers: + X-Account-Token: '[object Object]' response: body: id: 3fa85f64-5717-4562-b3fc-2c963f66afa6 diff --git a/.mock/definition/filestorage/linkToken.yml b/.mock/definition/filestorage/linkToken.yml index fda54a0c..96af04e8 100644 --- a/.mock/definition/filestorage/linkToken.yml +++ b/.mock/definition/filestorage/linkToken.yml @@ -119,7 +119,9 @@ service: type: root.LinkToken status-code: 200 examples: - - request: + - headers: + X-Account-Token: '[object Object]' + request: end_user_email_address: example@gmail.com end_user_organization_name: Test Organization end_user_origin_id: '12345' diff --git a/.mock/definition/filestorage/linkedAccounts.yml b/.mock/definition/filestorage/linkedAccounts.yml index d8fb0eb6..3c656510 100644 --- a/.mock/definition/filestorage/linkedAccounts.yml +++ b/.mock/definition/filestorage/linkedAccounts.yml @@ -107,7 +107,11 @@ service: type: root.PaginatedAccountDetailsAndActionsList status-code: 200 examples: - - response: + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: '[object Object]' + response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ diff --git a/.mock/definition/filestorage/passthrough.yml b/.mock/definition/filestorage/passthrough.yml index 432034bc..71b42437 100644 --- a/.mock/definition/filestorage/passthrough.yml +++ b/.mock/definition/filestorage/passthrough.yml @@ -19,7 +19,8 @@ service: type: root.RemoteResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: method: GET path: /scooters diff --git a/.mock/definition/filestorage/regenerateKey.yml b/.mock/definition/filestorage/regenerateKey.yml index cd80f783..b251851a 100644 --- a/.mock/definition/filestorage/regenerateKey.yml +++ b/.mock/definition/filestorage/regenerateKey.yml @@ -26,7 +26,9 @@ service: type: root.RemoteKey status-code: 200 examples: - - request: + - headers: + X-Account-Token: '[object Object]' + request: name: Remote Deployment Key 1 response: body: diff --git a/.mock/definition/filestorage/scopes.yml b/.mock/definition/filestorage/scopes.yml index a48a1642..b6b40f3e 100644 --- a/.mock/definition/filestorage/scopes.yml +++ b/.mock/definition/filestorage/scopes.yml @@ -19,7 +19,9 @@ service: type: root.CommonModelScopeApi status-code: 200 examples: - - response: + - headers: + X-Account-Token: '[object Object]' + response: body: common_models: - model_name: Employee @@ -60,7 +62,8 @@ service: type: root.CommonModelScopeApi status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: common_models: @@ -111,7 +114,8 @@ service: type: root.CommonModelScopeApi status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: common_models: - model_name: Employee diff --git a/.mock/definition/filestorage/syncStatus.yml b/.mock/definition/filestorage/syncStatus.yml index 53140e4d..a35bc7c6 100644 --- a/.mock/definition/filestorage/syncStatus.yml +++ b/.mock/definition/filestorage/syncStatus.yml @@ -36,7 +36,10 @@ service: type: root.PaginatedSyncStatusList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw diff --git a/.mock/definition/filestorage/users.yml b/.mock/definition/filestorage/users.yml index 6921bd65..38b7714c 100644 --- a/.mock/definition/filestorage/users.yml +++ b/.mock/definition/filestorage/users.yml @@ -67,7 +67,10 @@ service: type: root.PaginatedUserList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -119,7 +122,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 83902e75-4362-4803-b76c-a7d6be292cbd diff --git a/.mock/definition/filestorage/webhookReceivers.yml b/.mock/definition/filestorage/webhookReceivers.yml index 3b0bcace..6b965003 100644 --- a/.mock/definition/filestorage/webhookReceivers.yml +++ b/.mock/definition/filestorage/webhookReceivers.yml @@ -16,7 +16,8 @@ service: type: list status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: - event: event @@ -48,7 +49,8 @@ service: type: root.WebhookReceiver status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: event: event is_active: true diff --git a/.mock/definition/hris/__package__.yml b/.mock/definition/hris/__package__.yml index 3e17db3f..126de185 100644 --- a/.mock/definition/hris/__package__.yml +++ b/.mock/definition/hris/__package__.yml @@ -64,6 +64,14 @@ types: source: openapi: openapi/openapi.yml inline: true + AccountDetailsAndActionsStatus: + discriminated: false + union: + - AccountDetailsAndActionsStatusEnum + - string + source: + openapi: openapi/openapi.yml + inline: true AccountDetailsAndActions: docs: >- # The LinkedAccount Object @@ -80,7 +88,7 @@ types: properties: id: string category: optional - status: AccountDetailsAndActionsStatusEnum + status: AccountDetailsAndActionsStatus status_detail: optional end_user_origin_id: optional end_user_organization_name: string @@ -689,6 +697,11 @@ types: end_date: type: optional docs: The day and time the benefit ended. + employer_benefit: + type: optional + docs: The employer benefit plan the employee is enrolled in. + validation: + format: uuid remote_was_deleted: type: optional docs: >- @@ -698,11 +711,6 @@ types: [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). access: read-only - employer_benefit: - type: optional - docs: The employer benefit plan the employee is enrolled in. - validation: - format: uuid field_mappings: type: optional> access: read-only diff --git a/.mock/definition/hris/accountDetails.yml b/.mock/definition/hris/accountDetails.yml index 2d4833d3..140409e5 100644 --- a/.mock/definition/hris/accountDetails.yml +++ b/.mock/definition/hris/accountDetails.yml @@ -16,7 +16,8 @@ service: type: root.AccountDetails status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: id: 0496d4c2-42e6-4072-80b3-7b69bfdc76fd diff --git a/.mock/definition/hris/accountToken.yml b/.mock/definition/hris/accountToken.yml index 84185ffb..022851f2 100644 --- a/.mock/definition/hris/accountToken.yml +++ b/.mock/definition/hris/accountToken.yml @@ -22,6 +22,8 @@ service: examples: - path-parameters: public_token: public_token + headers: + X-Account-Token: '[object Object]' response: body: account_token: T9klMDQrcHdm9jrtHuOS2Nf06BIHwMNjpPXPMB diff --git a/.mock/definition/hris/asyncPassthrough.yml b/.mock/definition/hris/asyncPassthrough.yml index 841c4d91..9cb0b941 100644 --- a/.mock/definition/hris/asyncPassthrough.yml +++ b/.mock/definition/hris/asyncPassthrough.yml @@ -21,7 +21,8 @@ service: type: root.AsyncPassthroughReciept status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: method: GET path: /scooters @@ -44,7 +45,8 @@ service: examples: - path-parameters: async_passthrough_receipt_id: async_passthrough_receipt_id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: method: GET diff --git a/.mock/definition/hris/auditTrail.yml b/.mock/definition/hris/auditTrail.yml index 19e653ea..684b7e5d 100644 --- a/.mock/definition/hris/auditTrail.yml +++ b/.mock/definition/hris/auditTrail.yml @@ -75,7 +75,11 @@ service: type: root.PaginatedAuditLogEventList status-code: 200 examples: - - response: + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: '[object Object]' + response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ diff --git a/.mock/definition/hris/availableActions.yml b/.mock/definition/hris/availableActions.yml index 74b6e655..e03e84f2 100644 --- a/.mock/definition/hris/availableActions.yml +++ b/.mock/definition/hris/availableActions.yml @@ -16,7 +16,8 @@ service: type: root.AvailableActions status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: integration: diff --git a/.mock/definition/hris/bankInfo.yml b/.mock/definition/hris/bankInfo.yml index d8d8fc21..872097f9 100644 --- a/.mock/definition/hris/bankInfo.yml +++ b/.mock/definition/hris/bankInfo.yml @@ -115,7 +115,10 @@ service: type: root.PaginatedBankInfoList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -185,7 +188,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: fd1e0fb5-8f92-4ec9-9f32-179cf732867d diff --git a/.mock/definition/hris/benefits.yml b/.mock/definition/hris/benefits.yml index 2a98a378..2802723b 100644 --- a/.mock/definition/hris/benefits.yml +++ b/.mock/definition/hris/benefits.yml @@ -74,7 +74,10 @@ service: type: root.PaginatedBenefitList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -86,13 +89,12 @@ service: modified_at: '2021-10-16T00:00:00Z' employee: employee provider_name: Blue Shield of California - benefit_plan_type: benefit_plan_type employee_contribution: 23.65 company_contribution: 150 start_date: '2020-11-15T00:59:25Z' end_date: '2021-10-15T00:23:25Z' - remote_was_deleted: true employer_benefit: 025fjlc6-6000-430a-848e-aafacbadf4fe + remote_was_deleted: true field_mappings: organization_defined_targets: custom_key: custom_value @@ -136,7 +138,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 3fe5ae7a-f1ba-4529-b7af-84e86dc6d232 @@ -145,13 +148,12 @@ service: modified_at: '2021-10-16T00:00:00Z' employee: employee provider_name: Blue Shield of California - benefit_plan_type: benefit_plan_type employee_contribution: 23.65 company_contribution: 150 start_date: '2020-11-15T00:59:25Z' end_date: '2021-10-15T00:23:25Z' - remote_was_deleted: true employer_benefit: 025fjlc6-6000-430a-848e-aafacbadf4fe + remote_was_deleted: true field_mappings: organization_defined_targets: custom_key: custom_value diff --git a/.mock/definition/hris/companies.yml b/.mock/definition/hris/companies.yml index 3b107952..cb3881df 100644 --- a/.mock/definition/hris/companies.yml +++ b/.mock/definition/hris/companies.yml @@ -64,7 +64,10 @@ service: type: root.PaginatedCompanyList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -119,7 +122,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 1b998423-db0a-4037-a4cf-f79c60cb67b3 diff --git a/.mock/definition/hris/deleteAccount.yml b/.mock/definition/hris/deleteAccount.yml index d8b1e45c..fb59bf5f 100644 --- a/.mock/definition/hris/deleteAccount.yml +++ b/.mock/definition/hris/deleteAccount.yml @@ -10,6 +10,7 @@ service: source: openapi: openapi/openapi.yml examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token source: openapi: openapi/openapi.yml diff --git a/.mock/definition/hris/dependents.yml b/.mock/definition/hris/dependents.yml index a4254ddd..bab4360c 100644 --- a/.mock/definition/hris/dependents.yml +++ b/.mock/definition/hris/dependents.yml @@ -69,7 +69,10 @@ service: type: root.PaginatedDependentList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -134,7 +137,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 025fjlc6-6000-430a-848e-aafacbadf4fe diff --git a/.mock/definition/hris/employeePayrollRuns.yml b/.mock/definition/hris/employeePayrollRuns.yml index c4ffb0b9..f6f53b28 100644 --- a/.mock/definition/hris/employeePayrollRuns.yml +++ b/.mock/definition/hris/employeePayrollRuns.yml @@ -116,7 +116,10 @@ service: type: root.PaginatedEmployeePayrollRunList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -206,7 +209,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: fb8c55b6-1cb8-4b4c-9fb6-17924231619d diff --git a/.mock/definition/hris/employees.yml b/.mock/definition/hris/employees.yml index bd50cfa6..df2cd00f 100644 --- a/.mock/definition/hris/employees.yml +++ b/.mock/definition/hris/employees.yml @@ -1320,7 +1320,10 @@ service: type: root.PaginatedEmployeeList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -1347,14 +1350,12 @@ service: home_location: home_location work_location: work_location manager: manager - team: team pay_group: pay_group ssn: '1234567890' gender: MALE ethnicity: AMERICAN_INDIAN_OR_ALASKA_NATIVE marital_status: SINGLE date_of_birth: '1990-11-10T00:00:00Z' - hire_date: '2020-10-10T00:00:00Z' start_date: '2020-10-11T00:00:00Z' remote_created_at: '2020-10-11T00:00:00Z' employment_status: ACTIVE @@ -1399,7 +1400,8 @@ service: type: root.EmployeeResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -1426,14 +1428,12 @@ service: home_location: home_location work_location: work_location manager: manager - team: team pay_group: pay_group ssn: '1234567890' gender: MALE ethnicity: AMERICAN_INDIAN_OR_ALASKA_NATIVE marital_status: SINGLE date_of_birth: '1990-11-10T00:00:00Z' - hire_date: '2020-10-10T00:00:00Z' start_date: '2020-10-11T00:00:00Z' remote_created_at: '2020-10-11T00:00:00Z' employment_status: ACTIVE @@ -1520,7 +1520,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 0958cbc6-6040-430a-848e-aafacbadf4ae @@ -1544,14 +1545,12 @@ service: home_location: home_location work_location: work_location manager: manager - team: team pay_group: pay_group ssn: '1234567890' gender: MALE ethnicity: AMERICAN_INDIAN_OR_ALASKA_NATIVE marital_status: SINGLE date_of_birth: '1990-11-10T00:00:00Z' - hire_date: '2020-10-10T00:00:00Z' start_date: '2020-10-11T00:00:00Z' remote_created_at: '2020-10-11T00:00:00Z' employment_status: ACTIVE @@ -1596,7 +1595,8 @@ service: examples: - path-parameters: model_id: model_id - headers: {} + headers: + X-Account-Token: X-Account-Token request: reason: GENERAL_CUSTOMER_REQUEST metaPostRetrieve: @@ -1611,7 +1611,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/hris/employerBenefits.yml b/.mock/definition/hris/employerBenefits.yml index f110617f..c8b0023c 100644 --- a/.mock/definition/hris/employerBenefits.yml +++ b/.mock/definition/hris/employerBenefits.yml @@ -64,7 +64,10 @@ service: type: root.PaginatedEmployerBenefitList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -115,7 +118,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 025fjlc6-6000-430a-848e-aafacbadf4fele diff --git a/.mock/definition/hris/employments.yml b/.mock/definition/hris/employments.yml index f676c7df..d653306f 100644 --- a/.mock/definition/hris/employments.yml +++ b/.mock/definition/hris/employments.yml @@ -232,7 +232,10 @@ service: type: root.PaginatedEmploymentList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -306,7 +309,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 65d8ffd0-211b-4ba4-b85a-fbe2ce220982 diff --git a/.mock/definition/hris/fieldMapping.yml b/.mock/definition/hris/fieldMapping.yml index 2c83b146..1a222f9f 100644 --- a/.mock/definition/hris/fieldMapping.yml +++ b/.mock/definition/hris/fieldMapping.yml @@ -30,7 +30,8 @@ service: type: root.FieldMappingApiInstanceResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: Benefit: @@ -357,7 +358,8 @@ service: type: root.FieldMappingInstanceResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: target_field_name: example_target_field_name target_field_description: this is a example description of the target field @@ -424,7 +426,8 @@ service: examples: - path-parameters: field_mapping_id: field_mapping_id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: model: @@ -506,7 +509,8 @@ service: examples: - path-parameters: field_mapping_id: field_mapping_id - headers: {} + headers: + X-Account-Token: X-Account-Token request: {} response: body: @@ -577,7 +581,8 @@ service: type: root.RemoteFieldApiResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: Benefit: @@ -821,7 +826,8 @@ service: type: root.ExternalTargetFieldApiResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: Benefit: diff --git a/.mock/definition/hris/forceResync.yml b/.mock/definition/hris/forceResync.yml index ccae8e7b..3871daeb 100644 --- a/.mock/definition/hris/forceResync.yml +++ b/.mock/definition/hris/forceResync.yml @@ -21,7 +21,8 @@ service: type: list status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: - model_name: Employee diff --git a/.mock/definition/hris/generateKey.yml b/.mock/definition/hris/generateKey.yml index 94a399fc..18c4f7c3 100644 --- a/.mock/definition/hris/generateKey.yml +++ b/.mock/definition/hris/generateKey.yml @@ -26,7 +26,9 @@ service: type: root.RemoteKey status-code: 200 examples: - - request: + - headers: + X-Account-Token: '[object Object]' + request: name: Remote Deployment Key 1 response: body: diff --git a/.mock/definition/hris/groups.yml b/.mock/definition/hris/groups.yml index 942ebedf..a9bc5589 100644 --- a/.mock/definition/hris/groups.yml +++ b/.mock/definition/hris/groups.yml @@ -91,7 +91,10 @@ service: type: root.PaginatedGroupList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -154,7 +157,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 134e0111-0f67-44f6-98f0-597000290bb3 diff --git a/.mock/definition/hris/issues.yml b/.mock/definition/hris/issues.yml index 9fd39ae2..d9de5306 100644 --- a/.mock/definition/hris/issues.yml +++ b/.mock/definition/hris/issues.yml @@ -80,7 +80,11 @@ service: type: root.PaginatedIssueList status-code: 200 examples: - - response: + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: '[object Object]' + response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ @@ -112,6 +116,8 @@ service: examples: - path-parameters: id: id + headers: + X-Account-Token: '[object Object]' response: body: id: 3fa85f64-5717-4562-b3fc-2c963f66afa6 diff --git a/.mock/definition/hris/linkToken.yml b/.mock/definition/hris/linkToken.yml index c83a57e8..766171de 100644 --- a/.mock/definition/hris/linkToken.yml +++ b/.mock/definition/hris/linkToken.yml @@ -136,7 +136,9 @@ service: type: root.LinkToken status-code: 200 examples: - - request: + - headers: + X-Account-Token: '[object Object]' + request: end_user_email_address: example@gmail.com end_user_organization_name: Test Organization end_user_origin_id: '12345' diff --git a/.mock/definition/hris/linkedAccounts.yml b/.mock/definition/hris/linkedAccounts.yml index 3ed63936..5d4c897d 100644 --- a/.mock/definition/hris/linkedAccounts.yml +++ b/.mock/definition/hris/linkedAccounts.yml @@ -107,7 +107,11 @@ service: type: root.PaginatedAccountDetailsAndActionsList status-code: 200 examples: - - response: + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: '[object Object]' + response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ diff --git a/.mock/definition/hris/locations.yml b/.mock/definition/hris/locations.yml index a4c2f9b6..d5217222 100644 --- a/.mock/definition/hris/locations.yml +++ b/.mock/definition/hris/locations.yml @@ -120,7 +120,10 @@ service: type: root.PaginatedLocationList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -188,7 +191,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: f5e6a151-f44e-449a-afb1-8fd781905958 diff --git a/.mock/definition/hris/passthrough.yml b/.mock/definition/hris/passthrough.yml index 602b2cd6..fbe19301 100644 --- a/.mock/definition/hris/passthrough.yml +++ b/.mock/definition/hris/passthrough.yml @@ -19,7 +19,8 @@ service: type: root.RemoteResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: method: GET path: /scooters diff --git a/.mock/definition/hris/payGroups.yml b/.mock/definition/hris/payGroups.yml index 981803d8..dd031706 100644 --- a/.mock/definition/hris/payGroups.yml +++ b/.mock/definition/hris/payGroups.yml @@ -64,7 +64,10 @@ service: type: root.PaginatedPayGroupList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -114,7 +117,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: fd1e0fb5-8f92-4ec9-9f32-179cf732867d diff --git a/.mock/definition/hris/payrollRuns.yml b/.mock/definition/hris/payrollRuns.yml index b4414e43..8687f6d5 100644 --- a/.mock/definition/hris/payrollRuns.yml +++ b/.mock/definition/hris/payrollRuns.yml @@ -153,7 +153,10 @@ service: type: root.PaginatedPayrollRunList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -217,7 +220,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 37336947-b3d4-4a4c-a310-ab6ab510e079 diff --git a/.mock/definition/hris/regenerateKey.yml b/.mock/definition/hris/regenerateKey.yml index e29e77d3..b9daa8b2 100644 --- a/.mock/definition/hris/regenerateKey.yml +++ b/.mock/definition/hris/regenerateKey.yml @@ -26,7 +26,9 @@ service: type: root.RemoteKey status-code: 200 examples: - - request: + - headers: + X-Account-Token: '[object Object]' + request: name: Remote Deployment Key 1 response: body: diff --git a/.mock/definition/hris/scopes.yml b/.mock/definition/hris/scopes.yml index 59ec6a77..31252ad4 100644 --- a/.mock/definition/hris/scopes.yml +++ b/.mock/definition/hris/scopes.yml @@ -19,7 +19,9 @@ service: type: root.CommonModelScopeApi status-code: 200 examples: - - response: + - headers: + X-Account-Token: '[object Object]' + response: body: common_models: - model_name: Employee @@ -60,7 +62,8 @@ service: type: root.CommonModelScopeApi status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: common_models: @@ -111,7 +114,8 @@ service: type: root.CommonModelScopeApi status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: common_models: - model_name: Employee diff --git a/.mock/definition/hris/syncStatus.yml b/.mock/definition/hris/syncStatus.yml index c7e03e66..cca7aca2 100644 --- a/.mock/definition/hris/syncStatus.yml +++ b/.mock/definition/hris/syncStatus.yml @@ -36,7 +36,10 @@ service: type: root.PaginatedSyncStatusList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw diff --git a/.mock/definition/hris/teams.yml b/.mock/definition/hris/teams.yml index 4cb87414..902b49a3 100644 --- a/.mock/definition/hris/teams.yml +++ b/.mock/definition/hris/teams.yml @@ -72,7 +72,10 @@ service: type: root.PaginatedTeamList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -128,7 +131,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 13a72919-9fae-4f54-81ca-ddfd8712a1ba diff --git a/.mock/definition/hris/timeOff.yml b/.mock/definition/hris/timeOff.yml index 94818112..6ed9b785 100644 --- a/.mock/definition/hris/timeOff.yml +++ b/.mock/definition/hris/timeOff.yml @@ -236,7 +236,10 @@ service: type: root.PaginatedTimeOffList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -292,7 +295,8 @@ service: type: root.TimeOffResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -385,7 +389,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 91b2b905-e866-40c8-8be2-efe53827a0aa @@ -423,7 +428,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/hris/timeOffBalances.yml b/.mock/definition/hris/timeOffBalances.yml index 509df361..22ad8176 100644 --- a/.mock/definition/hris/timeOffBalances.yml +++ b/.mock/definition/hris/timeOffBalances.yml @@ -112,7 +112,10 @@ service: type: root.PaginatedTimeOffBalanceList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -180,7 +183,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 91b2b905-e866-40c8-8be2-efe53827a0aa diff --git a/.mock/definition/hris/timesheetEntries.yml b/.mock/definition/hris/timesheetEntries.yml index 69380ef4..62f53265 100644 --- a/.mock/definition/hris/timesheetEntries.yml +++ b/.mock/definition/hris/timesheetEntries.yml @@ -106,7 +106,10 @@ service: type: root.PaginatedTimesheetEntryList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -157,7 +160,8 @@ service: type: root.TimesheetEntryResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -235,7 +239,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 91b2b905-e866-40c8-8be2-efe53827a0aa @@ -268,7 +273,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/hris/webhookReceivers.yml b/.mock/definition/hris/webhookReceivers.yml index 05eae39d..62fbcab5 100644 --- a/.mock/definition/hris/webhookReceivers.yml +++ b/.mock/definition/hris/webhookReceivers.yml @@ -16,7 +16,8 @@ service: type: list status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: - event: event @@ -48,7 +49,8 @@ service: type: root.WebhookReceiver status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: event: event is_active: true diff --git a/.mock/definition/ticketing/__package__.yml b/.mock/definition/ticketing/__package__.yml index fef97a5f..9d24f443 100644 --- a/.mock/definition/ticketing/__package__.yml +++ b/.mock/definition/ticketing/__package__.yml @@ -2117,9 +2117,6 @@ types: * `COLLECTION` - COLLECTION tags: optional>> roles: optional>> - completed_at: - type: optional - docs: When the ticket was completed. ticket_url: type: optional docs: The 3rd party url of the Ticket. @@ -2135,6 +2132,9 @@ types: * `HIGH` - HIGH * `NORMAL` - NORMAL * `LOW` - LOW + completed_at: + type: optional + docs: When the ticket was completed. integration_params: type: optional> access: write-only @@ -2319,6 +2319,7 @@ types: remote_key_name: optional description: optional is_custom: optional + is_common_model_field: optional is_required: optional field_type: optional field_format: optional @@ -2422,8 +2423,8 @@ types: * `ASSIGNED_ONLY` - ASSIGNED_ONLY * `TEAM_ONLY` - TEAM_ONLY union: - - string - TicketAccessEnum + - string source: openapi: openapi/openapi.yml inline: true @@ -2541,6 +2542,14 @@ types: source: openapi: openapi/openapi.yml inline: true + SyncStatusStatus: + discriminated: false + union: + - StatusFd5Enum + - string + source: + openapi: openapi/openapi.yml + inline: true SyncStatus: docs: >- # The SyncStatus Object @@ -2562,7 +2571,7 @@ types: next_sync_start: optional last_sync_result: optional last_sync_finished: optional - status: StatusFd5Enum + status: SyncStatusStatus is_initial_sync: boolean selective_sync_configurations_usage: optional source: @@ -2894,6 +2903,21 @@ types: * `COLLECTION` - COLLECTION tags: optional>> roles: optional>> + ticket_url: + type: optional + docs: The 3rd party url of the Ticket. + validation: + format: uri + maxLength: 2000 + priority: + type: optional + docs: |- + The priority or urgency of the Ticket. + + * `URGENT` - URGENT + * `HIGH` - HIGH + * `NORMAL` - NORMAL + * `LOW` - LOW remote_created_at: type: optional docs: When the third party's ticket was created. @@ -2912,21 +2936,6 @@ types: [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). access: read-only - ticket_url: - type: optional - docs: The 3rd party url of the Ticket. - validation: - format: uri - maxLength: 2000 - priority: - type: optional - docs: |- - The priority or urgency of the Ticket. - - * `URGENT` - URGENT - * `HIGH` - HIGH - * `NORMAL` - NORMAL - * `LOW` - LOW field_mappings: type: optional> access: read-only @@ -3194,9 +3203,6 @@ types: * `COLLECTION` - COLLECTION tags: optional>> roles: optional>> - completed_at: - type: optional - docs: When the ticket was completed. ticket_url: type: optional docs: The 3rd party url of the Ticket. @@ -3212,6 +3218,9 @@ types: * `HIGH` - HIGH * `NORMAL` - NORMAL * `LOW` - LOW + completed_at: + type: optional + docs: When the ticket was completed. integration_params: type: optional> access: write-only diff --git a/.mock/definition/ticketing/accountDetails.yml b/.mock/definition/ticketing/accountDetails.yml index 1cd26dd4..4204619f 100644 --- a/.mock/definition/ticketing/accountDetails.yml +++ b/.mock/definition/ticketing/accountDetails.yml @@ -16,7 +16,8 @@ service: type: root.AccountDetails status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: id: 0496d4c2-42e6-4072-80b3-7b69bfdc76fd diff --git a/.mock/definition/ticketing/accountToken.yml b/.mock/definition/ticketing/accountToken.yml index e3b505e5..057dc6d6 100644 --- a/.mock/definition/ticketing/accountToken.yml +++ b/.mock/definition/ticketing/accountToken.yml @@ -22,6 +22,8 @@ service: examples: - path-parameters: public_token: public_token + headers: + X-Account-Token: '[object Object]' response: body: account_token: T9klMDQrcHdm9jrtHuOS2Nf06BIHwMNjpPXPMB diff --git a/.mock/definition/ticketing/accounts.yml b/.mock/definition/ticketing/accounts.yml index 9dc3f7a8..4f695f73 100644 --- a/.mock/definition/ticketing/accounts.yml +++ b/.mock/definition/ticketing/accounts.yml @@ -64,7 +64,10 @@ service: type: root.PaginatedAccountList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -117,7 +120,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 17a54124-287f-494d-965e-3c5b330c9a68 diff --git a/.mock/definition/ticketing/asyncPassthrough.yml b/.mock/definition/ticketing/asyncPassthrough.yml index 0a2001fe..02724e93 100644 --- a/.mock/definition/ticketing/asyncPassthrough.yml +++ b/.mock/definition/ticketing/asyncPassthrough.yml @@ -21,7 +21,8 @@ service: type: root.AsyncPassthroughReciept status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: method: GET path: /scooters @@ -44,7 +45,8 @@ service: examples: - path-parameters: async_passthrough_receipt_id: async_passthrough_receipt_id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: method: GET diff --git a/.mock/definition/ticketing/attachments.yml b/.mock/definition/ticketing/attachments.yml index 9a8a8a9c..671474bf 100644 --- a/.mock/definition/ticketing/attachments.yml +++ b/.mock/definition/ticketing/attachments.yml @@ -77,7 +77,10 @@ service: type: root.PaginatedAttachmentList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -128,7 +131,8 @@ service: type: root.TicketingAttachmentResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -206,7 +210,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 17a54124-287f-494d-965e-3c5b330c9a68 @@ -270,7 +275,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/ticketing/auditTrail.yml b/.mock/definition/ticketing/auditTrail.yml index 82660fae..5b42e8b8 100644 --- a/.mock/definition/ticketing/auditTrail.yml +++ b/.mock/definition/ticketing/auditTrail.yml @@ -75,7 +75,11 @@ service: type: root.PaginatedAuditLogEventList status-code: 200 examples: - - response: + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: '[object Object]' + response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ diff --git a/.mock/definition/ticketing/availableActions.yml b/.mock/definition/ticketing/availableActions.yml index 745b76c7..750b5faa 100644 --- a/.mock/definition/ticketing/availableActions.yml +++ b/.mock/definition/ticketing/availableActions.yml @@ -16,7 +16,8 @@ service: type: root.AvailableActions status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: integration: diff --git a/.mock/definition/ticketing/collections.yml b/.mock/definition/ticketing/collections.yml index dbf6f131..0861c825 100644 --- a/.mock/definition/ticketing/collections.yml +++ b/.mock/definition/ticketing/collections.yml @@ -87,7 +87,10 @@ service: type: root.PaginatedCollectionList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -162,7 +165,10 @@ service: examples: - path-parameters: collection_id: collection_id - headers: {} + query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -218,7 +224,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: fb8c55b6-1cb8-4b4c-9fb6-17924231619d diff --git a/.mock/definition/ticketing/comments.yml b/.mock/definition/ticketing/comments.yml index 71a70dc5..7c789021 100644 --- a/.mock/definition/ticketing/comments.yml +++ b/.mock/definition/ticketing/comments.yml @@ -108,7 +108,10 @@ service: type: root.PaginatedCommentList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -164,7 +167,8 @@ service: type: root.CommentResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -247,7 +251,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 0958cbc6-6040-430a-848e-aafacbadf4ae @@ -285,7 +290,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/ticketing/contacts.yml b/.mock/definition/ticketing/contacts.yml index e4a13d7c..5296646e 100644 --- a/.mock/definition/ticketing/contacts.yml +++ b/.mock/definition/ticketing/contacts.yml @@ -25,6 +25,9 @@ service: cursor: type: optional docs: The pagination cursor value. + email_address: + type: optional + docs: If provided, will only return Contacts that match this email. expand: type: optional> docs: >- @@ -69,7 +72,10 @@ service: type: root.PaginatedContactList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -119,7 +125,8 @@ service: type: root.TicketingContactResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -196,7 +203,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 17a54124-287f-494d-965e-3c5b330c9a68 @@ -230,7 +238,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/ticketing/deleteAccount.yml b/.mock/definition/ticketing/deleteAccount.yml index b2d1911d..021acbde 100644 --- a/.mock/definition/ticketing/deleteAccount.yml +++ b/.mock/definition/ticketing/deleteAccount.yml @@ -10,6 +10,7 @@ service: source: openapi: openapi/openapi.yml examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token source: openapi: openapi/openapi.yml diff --git a/.mock/definition/ticketing/fieldMapping.yml b/.mock/definition/ticketing/fieldMapping.yml index 3051c3fc..8721c1c2 100644 --- a/.mock/definition/ticketing/fieldMapping.yml +++ b/.mock/definition/ticketing/fieldMapping.yml @@ -30,7 +30,8 @@ service: type: root.FieldMappingApiInstanceResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: Ticket: @@ -277,7 +278,8 @@ service: type: root.FieldMappingInstanceResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: target_field_name: example_target_field_name target_field_description: this is a example description of the target field @@ -344,7 +346,8 @@ service: examples: - path-parameters: field_mapping_id: field_mapping_id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: model: @@ -426,7 +429,8 @@ service: examples: - path-parameters: field_mapping_id: field_mapping_id - headers: {} + headers: + X-Account-Token: X-Account-Token request: {} response: body: @@ -497,7 +501,8 @@ service: type: root.RemoteFieldApiResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: Ticket: @@ -671,7 +676,8 @@ service: type: root.ExternalTargetFieldApiResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: Ticket: diff --git a/.mock/definition/ticketing/forceResync.yml b/.mock/definition/ticketing/forceResync.yml index a9669fa2..39b44277 100644 --- a/.mock/definition/ticketing/forceResync.yml +++ b/.mock/definition/ticketing/forceResync.yml @@ -21,7 +21,8 @@ service: type: list status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: - model_name: Ticket diff --git a/.mock/definition/ticketing/generateKey.yml b/.mock/definition/ticketing/generateKey.yml index 54e7585c..03e42e8e 100644 --- a/.mock/definition/ticketing/generateKey.yml +++ b/.mock/definition/ticketing/generateKey.yml @@ -26,7 +26,9 @@ service: type: root.RemoteKey status-code: 200 examples: - - request: + - headers: + X-Account-Token: '[object Object]' + request: name: Remote Deployment Key 1 response: body: diff --git a/.mock/definition/ticketing/issues.yml b/.mock/definition/ticketing/issues.yml index badd03c1..22c452d4 100644 --- a/.mock/definition/ticketing/issues.yml +++ b/.mock/definition/ticketing/issues.yml @@ -80,7 +80,11 @@ service: type: root.PaginatedIssueList status-code: 200 examples: - - response: + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: '[object Object]' + response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ @@ -112,6 +116,8 @@ service: examples: - path-parameters: id: id + headers: + X-Account-Token: '[object Object]' response: body: id: 3fa85f64-5717-4562-b3fc-2c963f66afa6 diff --git a/.mock/definition/ticketing/linkToken.yml b/.mock/definition/ticketing/linkToken.yml index 908ed584..b3c79737 100644 --- a/.mock/definition/ticketing/linkToken.yml +++ b/.mock/definition/ticketing/linkToken.yml @@ -136,7 +136,9 @@ service: type: root.LinkToken status-code: 200 examples: - - request: + - headers: + X-Account-Token: '[object Object]' + request: end_user_email_address: example@gmail.com end_user_organization_name: Test Organization end_user_origin_id: '12345' diff --git a/.mock/definition/ticketing/linkedAccounts.yml b/.mock/definition/ticketing/linkedAccounts.yml index 072cf0e3..a9563978 100644 --- a/.mock/definition/ticketing/linkedAccounts.yml +++ b/.mock/definition/ticketing/linkedAccounts.yml @@ -107,7 +107,11 @@ service: type: root.PaginatedAccountDetailsAndActionsList status-code: 200 examples: - - response: + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: '[object Object]' + response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ diff --git a/.mock/definition/ticketing/passthrough.yml b/.mock/definition/ticketing/passthrough.yml index 44434d15..f20522bf 100644 --- a/.mock/definition/ticketing/passthrough.yml +++ b/.mock/definition/ticketing/passthrough.yml @@ -19,7 +19,8 @@ service: type: root.RemoteResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: method: GET path: /scooters diff --git a/.mock/definition/ticketing/projects.yml b/.mock/definition/ticketing/projects.yml index dd749346..7623e288 100644 --- a/.mock/definition/ticketing/projects.yml +++ b/.mock/definition/ticketing/projects.yml @@ -64,7 +64,10 @@ service: type: root.PaginatedProjectList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -113,7 +116,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: fb8c55b6-1cb8-4b4c-9fb6-17924231619d @@ -180,7 +184,10 @@ service: examples: - path-parameters: parent_id: parent_id - headers: {} + query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw diff --git a/.mock/definition/ticketing/regenerateKey.yml b/.mock/definition/ticketing/regenerateKey.yml index 5dab779d..1697dc88 100644 --- a/.mock/definition/ticketing/regenerateKey.yml +++ b/.mock/definition/ticketing/regenerateKey.yml @@ -26,7 +26,9 @@ service: type: root.RemoteKey status-code: 200 examples: - - request: + - headers: + X-Account-Token: '[object Object]' + request: name: Remote Deployment Key 1 response: body: diff --git a/.mock/definition/ticketing/roles.yml b/.mock/definition/ticketing/roles.yml index 09eb4680..229d52a3 100644 --- a/.mock/definition/ticketing/roles.yml +++ b/.mock/definition/ticketing/roles.yml @@ -64,7 +64,10 @@ service: type: root.PaginatedRoleList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -79,7 +82,7 @@ service: - VIEW - EDIT - CREATE - ticket_access: ticket_access + ticket_access: ALL remote_was_deleted: true field_mappings: organization_defined_targets: @@ -117,7 +120,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 23454124-387f-494d-265e-345b330c9123 @@ -129,7 +133,7 @@ service: - VIEW - EDIT - CREATE - ticket_access: ticket_access + ticket_access: ALL remote_was_deleted: true field_mappings: organization_defined_targets: diff --git a/.mock/definition/ticketing/scopes.yml b/.mock/definition/ticketing/scopes.yml index 11866654..61201cbf 100644 --- a/.mock/definition/ticketing/scopes.yml +++ b/.mock/definition/ticketing/scopes.yml @@ -19,7 +19,9 @@ service: type: root.CommonModelScopeApi status-code: 200 examples: - - response: + - headers: + X-Account-Token: '[object Object]' + response: body: common_models: - model_name: Employee @@ -60,7 +62,8 @@ service: type: root.CommonModelScopeApi status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: common_models: @@ -111,7 +114,8 @@ service: type: root.CommonModelScopeApi status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: common_models: - model_name: Employee diff --git a/.mock/definition/ticketing/syncStatus.yml b/.mock/definition/ticketing/syncStatus.yml index 5b49f2a3..5cc91fe7 100644 --- a/.mock/definition/ticketing/syncStatus.yml +++ b/.mock/definition/ticketing/syncStatus.yml @@ -36,7 +36,10 @@ service: type: root.PaginatedSyncStatusList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw diff --git a/.mock/definition/ticketing/tags.yml b/.mock/definition/ticketing/tags.yml index 7ebaf157..d8046d5f 100644 --- a/.mock/definition/ticketing/tags.yml +++ b/.mock/definition/ticketing/tags.yml @@ -64,7 +64,10 @@ service: type: root.PaginatedTagList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -112,7 +115,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: remote_id: '19202938' diff --git a/.mock/definition/ticketing/teams.yml b/.mock/definition/ticketing/teams.yml index 47bcb682..0f6096db 100644 --- a/.mock/definition/ticketing/teams.yml +++ b/.mock/definition/ticketing/teams.yml @@ -64,7 +64,10 @@ service: type: root.PaginatedTeamList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -113,7 +116,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 17a54124-287f-494d-965e-3c5b330c9a68 diff --git a/.mock/definition/ticketing/tickets.yml b/.mock/definition/ticketing/tickets.yml index 8177b0bf..0dbddac4 100644 --- a/.mock/definition/ticketing/tickets.yml +++ b/.mock/definition/ticketing/tickets.yml @@ -1158,6 +1158,9 @@ service: docs: >- If provided, will only return objects created before this datetime. + creator_id: + type: optional + docs: If provided, will only return tickets created by this creator_id. cursor: type: optional docs: The pagination cursor value. @@ -1276,7 +1279,10 @@ service: type: root.PaginatedTicketList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -1313,12 +1319,12 @@ service: roles: - 21a54124-397f-494d-985e-3c5b330b8a68 - 17a54124-287f-494d-965e-3c5b330c9a68 + ticket_url: https://thirdpartysoftware.com/project/3/issue/1 + priority: URGENT remote_created_at: '2021-11-10T00:00:00Z' remote_updated_at: '2021-12-09T00:00:00Z' completed_at: '2021-12-09T00:00:00Z' remote_was_deleted: true - ticket_url: https://thirdpartysoftware.com/project/3/issue/1 - priority: URGENT field_mappings: organization_defined_targets: custom_key: custom_value @@ -1355,7 +1361,8 @@ service: type: root.TicketResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -1392,12 +1399,12 @@ service: roles: - 21a54124-397f-494d-985e-3c5b330b8a68 - 17a54124-287f-494d-965e-3c5b330c9a68 + ticket_url: https://thirdpartysoftware.com/project/3/issue/1 + priority: URGENT remote_created_at: '2021-11-10T00:00:00Z' remote_updated_at: '2021-12-09T00:00:00Z' completed_at: '2021-12-09T00:00:00Z' remote_was_deleted: true - ticket_url: https://thirdpartysoftware.com/project/3/issue/1 - priority: URGENT field_mappings: organization_defined_targets: custom_key: custom_value @@ -1476,7 +1483,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 0958cbc6-6040-430a-848e-aafacbadf4ae @@ -1510,12 +1518,12 @@ service: roles: - 21a54124-397f-494d-985e-3c5b330b8a68 - 17a54124-287f-494d-965e-3c5b330c9a68 + ticket_url: https://thirdpartysoftware.com/project/3/issue/1 + priority: URGENT remote_created_at: '2021-11-10T00:00:00Z' remote_updated_at: '2021-12-09T00:00:00Z' completed_at: '2021-12-09T00:00:00Z' remote_was_deleted: true - ticket_url: https://thirdpartysoftware.com/project/3/issue/1 - priority: URGENT field_mappings: organization_defined_targets: custom_key: custom_value @@ -1560,7 +1568,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -1597,12 +1606,12 @@ service: roles: - 21a54124-397f-494d-985e-3c5b330b8a68 - 17a54124-287f-494d-965e-3c5b330c9a68 + ticket_url: https://thirdpartysoftware.com/project/3/issue/1 + priority: URGENT remote_created_at: '2021-11-10T00:00:00Z' remote_updated_at: '2021-12-09T00:00:00Z' completed_at: '2021-12-09T00:00:00Z' remote_was_deleted: true - ticket_url: https://thirdpartysoftware.com/project/3/issue/1 - priority: URGENT field_mappings: organization_defined_targets: custom_key: custom_value @@ -1684,7 +1693,10 @@ service: examples: - path-parameters: ticket_id: ticket_id - headers: {} + query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -1712,7 +1724,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -1905,7 +1918,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -2131,7 +2145,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -2142,6 +2159,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: field_type field_format: field_format diff --git a/.mock/definition/ticketing/users.yml b/.mock/definition/ticketing/users.yml index 76cfbe5f..05094917 100644 --- a/.mock/definition/ticketing/users.yml +++ b/.mock/definition/ticketing/users.yml @@ -94,7 +94,10 @@ service: type: root.PaginatedUserList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -155,7 +158,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 17a54124-287f-494d-965e-3c5b330c9a68 diff --git a/.mock/definition/ticketing/webhookReceivers.yml b/.mock/definition/ticketing/webhookReceivers.yml index 54b5126a..454c1a98 100644 --- a/.mock/definition/ticketing/webhookReceivers.yml +++ b/.mock/definition/ticketing/webhookReceivers.yml @@ -16,7 +16,8 @@ service: type: list status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: - event: event @@ -48,7 +49,8 @@ service: type: root.WebhookReceiver status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: event: event is_active: true diff --git a/.mock/fern.config.json b/.mock/fern.config.json index c4faf103..43adf15e 100644 --- a/.mock/fern.config.json +++ b/.mock/fern.config.json @@ -1,4 +1,4 @@ { "organization" : "merge", - "version" : "0.63.28" + "version" : "0.66.29" } \ No newline at end of file diff --git a/README.md b/README.md index f61bfd79..760423c9 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ [![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Fmerge-api%2Fmerge-python-client) [![pypi](https://img.shields.io/pypi/v/MergePythonClient)](https://pypi.python.org/pypi/MergePythonClient) -The Merge Python library provides convenient access to the Merge API from Python. +The Merge Python library provides convenient access to the Merge APIs from Python. ## Documentation @@ -25,15 +25,14 @@ Instantiate and use the client with the following: ```python from merge import Merge -from merge.resources.ats import ActivityRequest +from merge.resources.crm import AccountRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.activities.create( - model=ActivityRequest(), - remote_user_id="remote_user_id", +client.crm.accounts.create( + model=AccountRequest(), ) ``` @@ -68,7 +67,7 @@ The SDK also exports an `async` client so that you can make non-blocking calls t import asyncio from merge import AsyncMerge -from merge.resources.ats import ActivityRequest +from merge.resources.crm import AccountRequest client = AsyncMerge( account_token="YOUR_ACCOUNT_TOKEN", @@ -77,9 +76,8 @@ client = AsyncMerge( async def main() -> None: - await client.ats.activities.create( - model=ActivityRequest(), - remote_user_id="remote_user_id", + await client.crm.accounts.create( + model=AccountRequest(), ) @@ -95,7 +93,7 @@ will be thrown. from merge.core.api_error import ApiError try: - client.ats.activities.create(...) + client.crm.accounts.create(...) except ApiError as e: print(e.status_code) print(e.body) @@ -114,7 +112,7 @@ from merge import Merge client = Merge( ..., ) -response = client.ats.activities.with_raw_response.create(...) +response = client.crm.accounts.with_raw_response.create(...) print(response.headers) # access the response headers print(response.data) # access the underlying object ``` @@ -134,7 +132,7 @@ A request is deemed retryable when any of the following HTTP status codes is ret Use the `max_retries` request option to configure this behavior. ```python -client.ats.activities.create(..., request_options={ +client.crm.accounts.create(..., request_options={ "max_retries": 1 }) ``` @@ -154,7 +152,7 @@ client = Merge( # Override timeout for a specific method -client.ats.activities.create(..., request_options={ +client.crm.accounts.create(..., request_options={ "timeout_in_seconds": 1 }) ``` @@ -230,3 +228,4 @@ while response.next is not None: ``` + diff --git a/poetry.lock b/poetry.lock index c1c2313e..c2ddd863 100644 --- a/poetry.lock +++ b/poetry.lock @@ -38,13 +38,13 @@ trio = ["trio (>=0.26.1)"] [[package]] name = "certifi" -version = "2025.7.14" +version = "2025.8.3" description = "Python package for providing Mozilla's CA Bundle." optional = false python-versions = ">=3.7" files = [ - {file = "certifi-2025.7.14-py3-none-any.whl", hash = "sha256:6b31f564a415d79ee77df69d757bb49a5bb53bd9f756cbbe24394ffd6fc1f4b2"}, - {file = "certifi-2025.7.14.tar.gz", hash = "sha256:8ea99dbdfaaf2ba2f9bac77b9249ef62ec5218e7c2b2e903378ed5fccf765995"}, + {file = "certifi-2025.8.3-py3-none-any.whl", hash = "sha256:f6c12493cfb1b06ba2ff328595af9350c65d6644968e5d3a2ffd78699af217a5"}, + {file = "certifi-2025.8.3.tar.gz", hash = "sha256:e564105f78ded564e3ae7c923924435e1daa7463faeab5bb932bc53ffae63407"}, ] [[package]] diff --git a/pyproject.toml b/pyproject.toml index 88939876..5542606e 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -3,7 +3,7 @@ name = "MergePythonClient" [tool.poetry] name = "MergePythonClient" -version = "2.1.1" +version = "2.2.0" description = "" readme = "README.md" authors = [] diff --git a/reference.md b/reference.md index a497d5bf..847c8caf 100644 --- a/reference.md +++ b/reference.md @@ -1,6 +1,6 @@ # Reference -## Ats AccountDetails -
client.ats.account_details.retrieve() +## Crm AccountDetails +
client.crm.account_details.retrieve()
@@ -33,7 +33,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.account_details.retrieve() +client.crm.account_details.retrieve() ```
@@ -61,8 +61,8 @@ client.ats.account_details.retrieve()
-## Ats AccountToken -
client.ats.account_token.retrieve(...) +## Crm AccountToken +
client.crm.account_token.retrieve(...)
@@ -95,7 +95,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.account_token.retrieve( +client.crm.account_token.retrieve( public_token="public_token", ) @@ -133,8 +133,8 @@ client.ats.account_token.retrieve(
-## Ats Activities -
client.ats.activities.list(...) +## Crm Accounts +
client.crm.accounts.list(...)
@@ -146,7 +146,7 @@ client.ats.account_token.retrieve(
-Returns a list of `Activity` objects. +Returns a list of `Account` objects.
@@ -167,7 +167,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.activities.list() +client.crm.accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -207,7 +209,7 @@ client.ats.activities.list()
-**expand:** `typing.Optional[typing.Literal["user"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[typing.Literal["owner"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -231,7 +233,7 @@ client.ats.activities.list()
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -239,7 +241,7 @@ client.ats.activities.list()
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -247,7 +249,7 @@ client.ats.activities.list()
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -255,7 +257,7 @@ client.ats.activities.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -263,7 +265,7 @@ client.ats.activities.list()
-**remote_fields:** `typing.Optional[ActivitiesListRequestRemoteFields]` — Deprecated. Use show_enum_origins. +**name:** `typing.Optional[str]` — If provided, will only return accounts with this name.
@@ -271,7 +273,7 @@ client.ats.activities.list()
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**owner_id:** `typing.Optional[str]` — If provided, will only return accounts with this owner.
@@ -279,7 +281,7 @@ client.ats.activities.list()
-**show_enum_origins:** `typing.Optional[ActivitiesListRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -287,7 +289,7 @@ client.ats.activities.list()
-**user_id:** `typing.Optional[str]` — If provided, will only return activities done by this user. +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -307,7 +309,7 @@ client.ats.activities.list()
-
client.ats.activities.create(...) +
client.crm.accounts.create(...)
@@ -319,7 +321,7 @@ client.ats.activities.list()
-Creates an `Activity` object with the given values. +Creates an `Account` object with the given values.
@@ -335,15 +337,14 @@ Creates an `Activity` object with the given values. ```python from merge import Merge -from merge.resources.ats import ActivityRequest +from merge.resources.crm import AccountRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.activities.create( - model=ActivityRequest(), - remote_user_id="remote_user_id", +client.crm.accounts.create( + model=AccountRequest(), ) ``` @@ -360,15 +361,7 @@ client.ats.activities.create(
-**model:** `ActivityRequest` - -
-
- -
-
- -**remote_user_id:** `str` +**model:** `AccountRequest`
@@ -404,7 +397,7 @@ client.ats.activities.create(
-
client.ats.activities.retrieve(...) +
client.crm.accounts.retrieve(...)
@@ -416,7 +409,7 @@ client.ats.activities.create(
-Returns an `Activity` object with the given `id`. +Returns an `Account` object with the given `id`.
@@ -437,7 +430,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.activities.retrieve( +client.crm.accounts.retrieve( id="id", ) @@ -463,7 +456,7 @@ client.ats.activities.retrieve(
-**expand:** `typing.Optional[typing.Literal["user"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[typing.Literal["owner"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -479,15 +472,7 @@ client.ats.activities.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
- -
-
- -**remote_fields:** `typing.Optional[ActivitiesRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins. +**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -495,7 +480,7 @@ client.ats.activities.retrieve(
-**show_enum_origins:** `typing.Optional[ActivitiesRetrieveRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -515,7 +500,7 @@ client.ats.activities.retrieve(
-
client.ats.activities.meta_post_retrieve() +
client.crm.accounts.partial_update(...)
@@ -527,7 +512,7 @@ client.ats.activities.retrieve(
-Returns metadata for `Activity` POSTs. +Updates an `Account` object with the given `id`.
@@ -543,74 +528,16 @@ Returns metadata for `Activity` POSTs. ```python from merge import Merge +from merge.resources.crm import PatchedAccountRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.activities.meta_post_retrieve() - -``` - -
- - - -#### ⚙️ Parameters - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - - - -
- -## Ats Applications -
client.ats.applications.list(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Returns a list of `Application` objects. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", +client.crm.accounts.partial_update( + id="id", + model=PatchedAccountRequest(), ) -client.ats.applications.list() ```
@@ -626,111 +553,7 @@ client.ats.applications.list()
-**candidate_id:** `typing.Optional[str]` — If provided, will only return applications for this candidate. - -
-
- -
-
- -**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. - -
-
- -
-
- -**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. - -
-
- -
-
- -**credited_to_id:** `typing.Optional[str]` — If provided, will only return applications credited to this user. - -
-
- -
-
- -**current_stage_id:** `typing.Optional[str]` — If provided, will only return applications at this interview stage. - -
-
- -
-
- -**cursor:** `typing.Optional[str]` — The pagination cursor value. - -
-
- -
-
- -**expand:** `typing.Optional[ApplicationsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - -
-
- -
-
- -**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). - -
-
- -
-
- -**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
- -
-
- -**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
- -
-
- -**job_id:** `typing.Optional[str]` — If provided, will only return applications for this job. - -
-
- -
-
- -**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. - -
-
- -
-
- -**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. - -
-
- -
-
- -**page_size:** `typing.Optional[int]` — Number of results to return per page. +**id:** `str`
@@ -738,7 +561,7 @@ client.ats.applications.list()
-**reject_reason_id:** `typing.Optional[str]` — If provided, will only return applications with this reject reason. +**model:** `PatchedAccountRequest`
@@ -746,7 +569,7 @@ client.ats.applications.list()
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -754,7 +577,7 @@ client.ats.applications.list()
-**source:** `typing.Optional[str]` — If provided, will only return applications with this source. +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -774,7 +597,7 @@ client.ats.applications.list()
-
client.ats.applications.create(...) +
client.crm.accounts.meta_patch_retrieve(...)
@@ -786,10 +609,7 @@ client.ats.applications.list()
-Creates an `Application` object with the given values. -For certain integrations, but not all, our API detects duplicate candidates and will associate applications with existing records in the third-party. New candidates are created and automatically linked to the application. - -See our [Help Center article](https://help.merge.dev/en/articles/10012366-updates-to-post-applications-oct-2024) for detailed support per integration. +Returns metadata for `CRMAccount` PATCHs.
@@ -805,15 +625,13 @@ See our [Help Center article](https://help.merge.dev/en/articles/10012366-update ```python from merge import Merge -from merge.resources.ats import ApplicationRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.applications.create( - model=ApplicationRequest(), - remote_user_id="remote_user_id", +client.crm.accounts.meta_patch_retrieve( + id="id", ) ``` @@ -830,31 +648,7 @@ client.ats.applications.create(
-**model:** `ApplicationRequest` - -
-
- -
-
- -**remote_user_id:** `str` - -
-
- -
-
- -**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. - -
-
- -
-
- -**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**id:** `str`
@@ -874,7 +668,7 @@ client.ats.applications.create(
-
client.ats.applications.retrieve(...) +
client.crm.accounts.meta_post_retrieve()
@@ -886,7 +680,7 @@ client.ats.applications.create(
-Returns an `Application` object with the given `id`. +Returns metadata for `CRMAccount` POSTs.
@@ -907,9 +701,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.applications.retrieve( - id="id", -) +client.crm.accounts.meta_post_retrieve() ``` @@ -925,38 +717,6 @@ client.ats.applications.retrieve(
-**id:** `str` - -
-
- -
-
- -**expand:** `typing.Optional[ApplicationsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - -
-
- -
-
- -**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
- -
-
- -**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -969,7 +729,7 @@ client.ats.applications.retrieve(
-
client.ats.applications.change_stage_create(...) +
client.crm.accounts.remote_field_classes_list(...)
@@ -981,7 +741,7 @@ client.ats.applications.retrieve(
-Updates the `current_stage` field of an `Application` object +Returns a list of `RemoteFieldClass` objects.
@@ -1002,8 +762,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.applications.change_stage_create( - id="id", +client.crm.accounts.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -1020,7 +780,7 @@ client.ats.applications.change_stage_create(
-**id:** `str` +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -1028,7 +788,7 @@ client.ats.applications.change_stage_create(
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -1036,7 +796,7 @@ client.ats.applications.change_stage_create(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -1044,7 +804,7 @@ client.ats.applications.change_stage_create(
-**job_interview_stage:** `typing.Optional[str]` — The interview stage to move the application to. +**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -1052,7 +812,7 @@ client.ats.applications.change_stage_create(
-**remote_user_id:** `typing.Optional[str]` +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -1060,68 +820,23 @@ client.ats.applications.change_stage_create(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
- -
- - - - -
- -
client.ats.applications.meta_post_retrieve(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Returns metadata for `Application` POSTs. -
-
-
-
- -#### 🔌 Usage - -
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ats.applications.meta_post_retrieve() - -``` -
-
+**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value +
-#### ⚙️ Parameters - -
-
-
-**application_remote_template_id:** `typing.Optional[str]` — The template ID associated with the nested application in the request. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -1141,8 +856,8 @@ client.ats.applications.meta_post_retrieve()
-## Ats AsyncPassthrough -
client.ats.async_passthrough.create(...) +## Crm AsyncPassthrough +
client.crm.async_passthrough.create(...)
@@ -1170,13 +885,13 @@ Asynchronously pull data from an endpoint not currently supported by Merge. ```python from merge import Merge -from merge.resources.ats import DataPassthroughRequest, MethodEnum +from merge.resources.crm import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.async_passthrough.create( +client.crm.async_passthrough.create( request=DataPassthroughRequest( method=MethodEnum.GET, path="/scooters", @@ -1217,7 +932,7 @@ client.ats.async_passthrough.create(
-
client.ats.async_passthrough.retrieve(...) +
client.crm.async_passthrough.retrieve(...)
@@ -1250,7 +965,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.async_passthrough.retrieve( +client.crm.async_passthrough.retrieve( async_passthrough_receipt_id="async_passthrough_receipt_id", ) @@ -1288,8 +1003,8 @@ client.ats.async_passthrough.retrieve(
-## Ats Attachments -
client.ats.attachments.list(...) +## Crm AuditTrail +
client.crm.audit_trail.list(...)
@@ -1301,7 +1016,7 @@ client.ats.async_passthrough.retrieve(
-Returns a list of `Attachment` objects. +Gets a list of audit trail events.
@@ -1322,7 +1037,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.attachments.list() +client.crm.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -1338,30 +1055,6 @@ client.ats.attachments.list()
-**candidate_id:** `typing.Optional[str]` — If provided, will only return attachments for this candidate. - -
-
- -
-
- -**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. - -
-
- -
-
- -**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. - -
-
- -
-
- **cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -1370,39 +1063,7 @@ client.ats.attachments.list()
-**expand:** `typing.Optional[typing.Literal["candidate"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - -
-
- -
-
- -**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). - -
-
- -
-
- -**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
- -
-
- -**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
- -
-
- -**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time
@@ -1410,7 +1071,7 @@ client.ats.attachments.list()
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**event_type:** `typing.Optional[str]` — If included, will only include events with the given event type. Possible values include: `CREATED_REMOTE_PRODUCTION_API_KEY`, `DELETED_REMOTE_PRODUCTION_API_KEY`, `CREATED_TEST_API_KEY`, `DELETED_TEST_API_KEY`, `REGENERATED_PRODUCTION_API_KEY`, `REGENERATED_WEBHOOK_SIGNATURE`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_LINKED_ACCOUNT`, `DELETED_ALL_COMMON_MODELS_FOR_LINKED_ACCOUNT`, `CREATED_DESTINATION`, `DELETED_DESTINATION`, `CHANGED_DESTINATION`, `CHANGED_SCOPES`, `CHANGED_PERSONAL_INFORMATION`, `CHANGED_ORGANIZATION_SETTINGS`, `ENABLED_INTEGRATION`, `DISABLED_INTEGRATION`, `ENABLED_CATEGORY`, `DISABLED_CATEGORY`, `CHANGED_PASSWORD`, `RESET_PASSWORD`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `CREATED_INTEGRATION_WIDE_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_FIELD_MAPPING`, `CHANGED_INTEGRATION_WIDE_FIELD_MAPPING`, `CHANGED_LINKED_ACCOUNT_FIELD_MAPPING`, `DELETED_INTEGRATION_WIDE_FIELD_MAPPING`, `DELETED_LINKED_ACCOUNT_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `FORCED_LINKED_ACCOUNT_RESYNC`, `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`, `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`, `END_USER_CREDENTIALS_ACCESSED`
@@ -1426,15 +1087,7 @@ client.ats.attachments.list()
-**remote_fields:** `typing.Optional[typing.Literal["attachment_type"]]` — Deprecated. Use show_enum_origins. - -
-
- -
-
- -**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time
@@ -1442,7 +1095,7 @@ client.ats.attachments.list()
-**show_enum_origins:** `typing.Optional[typing.Literal["attachment_type"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) +**user_email:** `typing.Optional[str]` — If provided, this will return events associated with the specified user email. Please note that the email address reflects the user's email at the time of the event, and may not be their current email.
@@ -1462,7 +1115,8 @@ client.ats.attachments.list()
-
client.ats.attachments.create(...) +## Crm AvailableActions +
client.crm.available_actions.retrieve()
@@ -1474,7 +1128,7 @@ client.ats.attachments.list()
-Creates an `Attachment` object with the given values. +Returns a list of models and actions available for an account.
@@ -1490,16 +1144,12 @@ Creates an `Attachment` object with the given values. ```python from merge import Merge -from merge.resources.ats import AttachmentRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.attachments.create( - model=AttachmentRequest(), - remote_user_id="remote_user_id", -) +client.crm.available_actions.retrieve() ``` @@ -1515,38 +1165,6 @@ client.ats.attachments.create(
-**model:** `AttachmentRequest` - -
-
- -
-
- -**remote_user_id:** `str` - -
-
- -
-
- -**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. - -
-
- -
-
- -**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -1559,7 +1177,8 @@ client.ats.attachments.create(
-
client.ats.attachments.retrieve(...) +## Crm Contacts +
client.crm.contacts.list(...)
@@ -1571,7 +1190,7 @@ client.ats.attachments.create(
-Returns an `Attachment` object with the given `id`. +Returns a list of `Contact` objects.
@@ -1592,8 +1211,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.attachments.retrieve( - id="id", +client.crm.contacts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -1610,7 +1229,7 @@ client.ats.attachments.retrieve(
-**id:** `str` +**account_id:** `typing.Optional[str]` — If provided, will only return contacts with this account.
@@ -1618,7 +1237,7 @@ client.ats.attachments.retrieve(
-**expand:** `typing.Optional[typing.Literal["candidate"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -1626,7 +1245,7 @@ client.ats.attachments.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -1634,7 +1253,7 @@ client.ats.attachments.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -1642,7 +1261,7 @@ client.ats.attachments.retrieve(
-**remote_fields:** `typing.Optional[typing.Literal["attachment_type"]]` — Deprecated. Use show_enum_origins. +**email_addresses:** `typing.Optional[str]` — If provided, will only return contacts matching the email addresses; multiple email_addresses can be separated by commas.
@@ -1650,7 +1269,7 @@ client.ats.attachments.retrieve(
-**show_enum_origins:** `typing.Optional[typing.Literal["attachment_type"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) +**expand:** `typing.Optional[ContactsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -1658,64 +1277,75 @@ client.ats.attachments.retrieve(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
- -
+
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +
-
-
client.ats.attachments.meta_post_retrieve()
-#### 📝 Description +**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. + +
+
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
+
-Returns metadata for `Attachment` POSTs. -
-
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. + -#### 🔌 Usage -
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. + +
+
+
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ats.attachments.meta_post_retrieve() - -``` +**page_size:** `typing.Optional[int]` — Number of results to return per page. +
+ +
+
+ +**phone_numbers:** `typing.Optional[str]` — If provided, will only return contacts matching the phone numbers; multiple phone numbers can be separated by commas. +
-#### ⚙️ Parameters -
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. + +
+
+
@@ -1731,8 +1361,7 @@ client.ats.attachments.meta_post_retrieve()
-## Ats AuditTrail -
client.ats.audit_trail.list(...) +
client.crm.contacts.create(...)
@@ -1744,7 +1373,7 @@ client.ats.attachments.meta_post_retrieve()
-Gets a list of audit trail events. +Creates a `Contact` object with the given values.
@@ -1760,12 +1389,15 @@ Gets a list of audit trail events. ```python from merge import Merge +from merge.resources.crm import ContactRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.audit_trail.list() +client.crm.contacts.create( + model=ContactRequest(), +) ``` @@ -1781,31 +1413,7 @@ client.ats.audit_trail.list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. - -
-
- -
-
- -**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time - -
-
- -
-
- -**event_type:** `typing.Optional[str]` — If included, will only include events with the given event type. Possible values include: `CREATED_REMOTE_PRODUCTION_API_KEY`, `DELETED_REMOTE_PRODUCTION_API_KEY`, `CREATED_TEST_API_KEY`, `DELETED_TEST_API_KEY`, `REGENERATED_PRODUCTION_API_KEY`, `REGENERATED_WEBHOOK_SIGNATURE`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_LINKED_ACCOUNT`, `DELETED_ALL_COMMON_MODELS_FOR_LINKED_ACCOUNT`, `CREATED_DESTINATION`, `DELETED_DESTINATION`, `CHANGED_DESTINATION`, `CHANGED_SCOPES`, `CHANGED_PERSONAL_INFORMATION`, `CHANGED_ORGANIZATION_SETTINGS`, `ENABLED_INTEGRATION`, `DISABLED_INTEGRATION`, `ENABLED_CATEGORY`, `DISABLED_CATEGORY`, `CHANGED_PASSWORD`, `RESET_PASSWORD`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `CREATED_INTEGRATION_WIDE_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_FIELD_MAPPING`, `CHANGED_INTEGRATION_WIDE_FIELD_MAPPING`, `CHANGED_LINKED_ACCOUNT_FIELD_MAPPING`, `DELETED_INTEGRATION_WIDE_FIELD_MAPPING`, `DELETED_LINKED_ACCOUNT_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `FORCED_LINKED_ACCOUNT_RESYNC`, `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`, `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`, `END_USER_CREDENTIALS_ACCESSED` - -
-
- -
-
- -**page_size:** `typing.Optional[int]` — Number of results to return per page. +**model:** `ContactRequest`
@@ -1813,7 +1421,7 @@ client.ats.audit_trail.list()
-**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -1821,7 +1429,7 @@ client.ats.audit_trail.list()
-**user_email:** `typing.Optional[str]` — If provided, this will return events associated with the specified user email. Please note that the email address reflects the user's email at the time of the event, and may not be their current email. +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -1841,8 +1449,7 @@ client.ats.audit_trail.list()
-## Ats AvailableActions -
client.ats.available_actions.retrieve() +
client.crm.contacts.retrieve(...)
@@ -1854,7 +1461,7 @@ client.ats.audit_trail.list()
-Returns a list of models and actions available for an account. +Returns a `Contact` object with the given `id`.
@@ -1875,7 +1482,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.available_actions.retrieve() +client.crm.contacts.retrieve( + id="id", +) ``` @@ -1891,69 +1500,31 @@ client.ats.available_actions.retrieve()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**id:** `str`
- -
- - - - -
- -## Ats Candidates -
client.ats.candidates.list(...) -
-
- -#### 📝 Description - -
-
-Returns a list of `Candidate` objects. -
-
+**expand:** `typing.Optional[ContactsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +
-#### 🔌 Usage - -
-
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ats.candidates.list() - -``` -
-
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +
-#### ⚙️ Parameters -
-
-
- -**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -1961,7 +1532,7 @@ client.ats.candidates.list()
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -1969,79 +1540,72 @@ client.ats.candidates.list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
- -
-
- -**email_addresses:** `typing.Optional[str]` — If provided, will only return candidates with these email addresses; multiple addresses can be separated by commas. -
-
-
-**expand:** `typing.Optional[CandidatesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. -
+
+
client.crm.contacts.partial_update(...)
-**first_name:** `typing.Optional[str]` — If provided, will only return candidates with this first name. - -
-
+#### 📝 Description
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). - -
-
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - +Updates a `Contact` object with the given `id`. +
+
+#### 🔌 Usage +
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
-
-**last_name:** `typing.Optional[str]` — If provided, will only return candidates with this last name. - +```python +from merge import Merge +from merge.resources.crm import PatchedContactRequest + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.contacts.partial_update( + id="id", + model=PatchedContactRequest(), +) + +```
+ + + +#### ⚙️ Parameters
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. - -
-
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**id:** `str`
@@ -2049,7 +1613,7 @@ client.ats.candidates.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**model:** `PatchedContactRequest`
@@ -2057,7 +1621,7 @@ client.ats.candidates.list()
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -2065,7 +1629,7 @@ client.ats.candidates.list()
-**tags:** `typing.Optional[str]` — If provided, will only return candidates with these tags; multiple tags can be separated by commas. +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -2085,7 +1649,7 @@ client.ats.candidates.list()
-
client.ats.candidates.create(...) +
client.crm.contacts.ignore_create(...)
@@ -2097,7 +1661,7 @@ client.ats.candidates.list()
-Creates a `Candidate` object with the given values. +Ignores a specific row based on the `model_id` in the url. These records will have their properties set to null, and will not be updated in future syncs. The "reason" and "message" fields in the request body will be stored for audit purposes.
@@ -2113,15 +1677,17 @@ Creates a `Candidate` object with the given values. ```python from merge import Merge -from merge.resources.ats import CandidateRequest +from merge.resources.crm import IgnoreCommonModelRequest, ReasonEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.candidates.create( - model=CandidateRequest(), - remote_user_id="remote_user_id", +client.crm.contacts.ignore_create( + model_id="model_id", + request=IgnoreCommonModelRequest( + reason=ReasonEnum.GENERAL_CUSTOMER_REQUEST, + ), ) ``` @@ -2138,23 +1704,7 @@ client.ats.candidates.create(
-**model:** `CandidateRequest` - -
-
- -
-
- -**remote_user_id:** `str` - -
-
- -
-
- -**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +**model_id:** `str`
@@ -2162,7 +1712,7 @@ client.ats.candidates.create(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**request:** `IgnoreCommonModelRequest`
@@ -2182,7 +1732,7 @@ client.ats.candidates.create(
-
client.ats.candidates.retrieve(...) +
client.crm.contacts.meta_patch_retrieve(...)
@@ -2194,7 +1744,7 @@ client.ats.candidates.create(
-Returns a `Candidate` object with the given `id`. +Returns metadata for `CRMContact` PATCHs.
@@ -2215,7 +1765,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.candidates.retrieve( +client.crm.contacts.meta_patch_retrieve( id="id", ) @@ -2241,27 +1791,64 @@ client.ats.candidates.retrieve(
-**expand:** `typing.Optional[CandidatesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
+ + + +
+ +
client.crm.contacts.meta_post_retrieve()
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - +#### 📝 Description + +
+
+ +
+
+ +Returns metadata for `CRMContact` POSTs. +
+
+#### 🔌 Usage +
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.contacts.meta_post_retrieve() + +``` +
+
+#### ⚙️ Parameters + +
+
+
@@ -2277,7 +1864,7 @@ client.ats.candidates.retrieve(
-
client.ats.candidates.partial_update(...) +
client.crm.contacts.remote_field_classes_list(...)
@@ -2289,7 +1876,7 @@ client.ats.candidates.retrieve(
-Updates a `Candidate` object with the given `id`. +Returns a list of `RemoteFieldClass` objects.
@@ -2305,16 +1892,13 @@ Updates a `Candidate` object with the given `id`. ```python from merge import Merge -from merge.resources.ats import PatchedCandidateRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.candidates.partial_update( - id="id", - model=PatchedCandidateRequest(), - remote_user_id="remote_user_id", +client.crm.contacts.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -2331,7 +1915,7 @@ client.ats.candidates.partial_update(
-**id:** `str` +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -2339,7 +1923,7 @@ client.ats.candidates.partial_update(
-**model:** `PatchedCandidateRequest` +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -2347,7 +1931,7 @@ client.ats.candidates.partial_update(
-**remote_user_id:** `str` +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -2355,7 +1939,7 @@ client.ats.candidates.partial_update(
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -2363,7 +1947,31 @@ client.ats.candidates.partial_update(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
+ +
+
+ +**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value + +
+
+ +
+
+ +**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value + +
+
+ +
+
+ +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -2383,7 +1991,8 @@ client.ats.candidates.partial_update(
-
client.ats.candidates.ignore_create(...) +## Crm CustomObjectClasses +
client.crm.custom_object_classes.list(...)
@@ -2395,7 +2004,7 @@ client.ats.candidates.partial_update(
-Ignores a specific row based on the `model_id` in the url. These records will have their properties set to null, and will not be updated in future syncs. The "reason" and "message" fields in the request body will be stored for audit purposes. +Returns a list of `CustomObjectClass` objects.
@@ -2411,15 +2020,13 @@ Ignores a specific row based on the `model_id` in the url. These records will ha ```python from merge import Merge -from merge.resources.ats import ReasonEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.candidates.ignore_create( - model_id="model_id", - reason=ReasonEnum.GENERAL_CUSTOMER_REQUEST, +client.crm.custom_object_classes.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -2436,7 +2043,7 @@ client.ats.candidates.ignore_create(
-**model_id:** `str` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -2444,7 +2051,7 @@ client.ats.candidates.ignore_create(
-**reason:** `IgnoreCommonModelRequestReason` +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -2452,7 +2059,7 @@ client.ats.candidates.ignore_create(
-**message:** `typing.Optional[str]` +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -2460,70 +2067,63 @@ client.ats.candidates.ignore_create(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**expand:** `typing.Optional[typing.Literal["fields"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
- -
+
+
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +
-
-
client.ats.candidates.meta_patch_retrieve(...)
-#### 📝 Description - -
-
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
-Returns metadata for `Candidate` PATCHs. -
-
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +
-#### 🔌 Usage -
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. + +
+
+
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ats.candidates.meta_patch_retrieve( - id="id", -) - -``` -
-
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. + -#### ⚙️ Parameters -
+**page_size:** `typing.Optional[int]` — Number of results to return per page. + +
+
+
-**id:** `str` +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -2543,7 +2143,7 @@ client.ats.candidates.meta_patch_retrieve(
-
client.ats.candidates.meta_post_retrieve() +
client.crm.custom_object_classes.retrieve(...)
@@ -2555,7 +2155,7 @@ client.ats.candidates.meta_patch_retrieve(
-Returns metadata for `Candidate` POSTs. +Returns a `CustomObjectClass` object with the given `id`.
@@ -2576,7 +2176,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.candidates.meta_post_retrieve() +client.crm.custom_object_classes.retrieve( + id="id", +) ``` @@ -2592,6 +2194,38 @@ client.ats.candidates.meta_post_retrieve()
+**id:** `str` + +
+
+ +
+
+ +**expand:** `typing.Optional[typing.Literal["fields"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
+ +
+
+ +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+ +
+
+ +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -2604,8 +2238,8 @@ client.ats.candidates.meta_post_retrieve()
-## Ats Scopes -
client.ats.scopes.default_scopes_retrieve() +## Crm AssociationTypes +
client.crm.association_types.custom_object_classes_association_types_list(...)
@@ -2617,7 +2251,7 @@ client.ats.candidates.meta_post_retrieve()
-Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes). +Returns a list of `AssociationType` objects.
@@ -2638,7 +2272,10 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.scopes.default_scopes_retrieve() +client.crm.association_types.custom_object_classes_association_types_list( + custom_object_class_id="custom_object_class_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -2654,64 +2291,99 @@ client.ats.scopes.default_scopes_retrieve()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**custom_object_class_id:** `str`
+ +
+
+ +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +
+
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +
-
-
client.ats.scopes.linked_account_scopes_retrieve()
-#### 📝 Description +**cursor:** `typing.Optional[str]` — The pagination cursor value. + +
+
+**expand:** `typing.Optional[typing.Literal["target_object_classes"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
+
-Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes). +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +
+ +
+
+ +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +
-#### 🔌 Usage -
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
+
-```python -from merge import Merge +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. + +
+
-client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ats.scopes.linked_account_scopes_retrieve() +
+
-``` +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +
+ +
+
+ +**page_size:** `typing.Optional[int]` — Number of results to return per page. +
-#### ⚙️ Parameters -
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. + +
+
+
@@ -2727,7 +2399,7 @@ client.ats.scopes.linked_account_scopes_retrieve()
-
client.ats.scopes.linked_account_scopes_create(...) +
client.crm.association_types.custom_object_classes_association_types_create(...)
@@ -2739,7 +2411,7 @@ client.ats.scopes.linked_account_scopes_retrieve()
-Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes) +Creates an `AssociationType` object with the given values.
@@ -2755,42 +2427,31 @@ Update permissions for any Common Model or field for a single Linked Account. An ```python from merge import Merge -from merge.resources.ats import ( - FieldPermissionDeserializerRequest, - IndividualCommonModelScopeDeserializerRequest, - ModelPermissionDeserializerRequest, +from merge.resources.crm import ( + AssociationTypeRequestRequest, + ObjectClassDescriptionRequest, + OriginTypeEnum, ) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.scopes.linked_account_scopes_create( - common_models=[ - IndividualCommonModelScopeDeserializerRequest( - model_name="Employee", - model_permissions={ - "READ": ModelPermissionDeserializerRequest( - is_enabled=True, - ), - "WRITE": ModelPermissionDeserializerRequest( - is_enabled=False, - ), - }, - field_permissions=FieldPermissionDeserializerRequest( - enabled_fields=["avatar", "home_location"], - disabled_fields=["work_location"], - ), - ), - IndividualCommonModelScopeDeserializerRequest( - model_name="Benefit", - model_permissions={ - "WRITE": ModelPermissionDeserializerRequest( - is_enabled=False, - ) - }, +client.crm.association_types.custom_object_classes_association_types_create( + custom_object_class_id="custom_object_class_id", + model=AssociationTypeRequestRequest( + source_object_class=ObjectClassDescriptionRequest( + id="id", + origin_type=OriginTypeEnum.CUSTOM_OBJECT, ), - ], + target_object_classes=[ + ObjectClassDescriptionRequest( + id="id", + origin_type=OriginTypeEnum.CUSTOM_OBJECT, + ) + ], + remote_key_name="remote_key_name", + ), ) ``` @@ -2807,7 +2468,7 @@ client.ats.scopes.linked_account_scopes_create(
-**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for +**custom_object_class_id:** `str`
@@ -2815,65 +2476,27 @@ client.ats.scopes.linked_account_scopes_create(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**model:** `AssociationTypeRequestRequest`
- -
- - - - -
- -## Ats DeleteAccount -
client.ats.delete_account.delete() -
-
- -#### 📝 Description - -
-
-Delete a linked account. -
-
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +
-#### 🔌 Usage -
-
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ats.delete_account.delete() - -``` -
-
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +
-#### ⚙️ Parameters - -
-
-
@@ -2889,8 +2512,7 @@ client.ats.delete_account.delete()
-## Ats Departments -
client.ats.departments.list(...) +
client.crm.association_types.custom_object_classes_association_types_retrieve(...)
@@ -2902,7 +2524,7 @@ client.ats.delete_account.delete()
-Returns a list of `Department` objects. +Returns an `AssociationType` object with the given `id`.
@@ -2923,7 +2545,10 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.departments.list() +client.crm.association_types.custom_object_classes_association_types_retrieve( + custom_object_class_id="custom_object_class_id", + id="id", +) ``` @@ -2939,15 +2564,7 @@ client.ats.departments.list()
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. - -
-
- -
-
- -**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**custom_object_class_id:** `str`
@@ -2955,7 +2572,7 @@ client.ats.departments.list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**id:** `str`
@@ -2963,7 +2580,7 @@ client.ats.departments.list()
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**expand:** `typing.Optional[typing.Literal["target_object_classes"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -2987,38 +2604,6 @@ client.ats.departments.list()
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. - -
-
- -
-
- -**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. - -
-
- -
-
- -**page_size:** `typing.Optional[int]` — Number of results to return per page. - -
-
- -
-
- -**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -3031,7 +2616,7 @@ client.ats.departments.list()
-
client.ats.departments.retrieve(...) +
client.crm.association_types.custom_object_classes_association_types_meta_post_retrieve(...)
@@ -3043,7 +2628,7 @@ client.ats.departments.list()
-Returns a `Department` object with the given `id`. +Returns metadata for `CRMAssociationType` POSTs.
@@ -3064,8 +2649,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.departments.retrieve( - id="id", +client.crm.association_types.custom_object_classes_association_types_meta_post_retrieve( + custom_object_class_id="custom_object_class_id", ) ``` @@ -3082,23 +2667,7 @@ client.ats.departments.retrieve(
-**id:** `str` - -
-
- -
-
- -**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
- -
-
- -**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**custom_object_class_id:** `str`
@@ -3118,8 +2687,8 @@ client.ats.departments.retrieve(
-## Ats Eeocs -
client.ats.eeocs.list(...) +## Crm CustomObjects +
client.crm.custom_objects.custom_object_classes_custom_objects_list(...)
@@ -3131,7 +2700,7 @@ client.ats.departments.retrieve(
-Returns a list of `EEOC` objects. +Returns a list of `CustomObject` objects.
@@ -3152,7 +2721,10 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.eeocs.list() +client.crm.custom_objects.custom_object_classes_custom_objects_list( + custom_object_class_id="custom_object_class_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -3168,7 +2740,7 @@ client.ats.eeocs.list()
-**candidate_id:** `typing.Optional[str]` — If provided, will only return EEOC info for this candidate. +**custom_object_class_id:** `str`
@@ -3200,7 +2772,7 @@ client.ats.eeocs.list()
-**expand:** `typing.Optional[typing.Literal["candidate"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -3208,7 +2780,7 @@ client.ats.eeocs.list()
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -3216,7 +2788,7 @@ client.ats.eeocs.list()
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -3256,7 +2828,7 @@ client.ats.eeocs.list()
-**remote_fields:** `typing.Optional[EeocsListRequestRemoteFields]` — Deprecated. Use show_enum_origins. +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -3264,15 +2836,98 @@ client.ats.eeocs.list()
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
+ + + +
+ +
client.crm.custom_objects.custom_object_classes_custom_objects_create(...)
-**show_enum_origins:** `typing.Optional[EeocsListRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) +#### 📝 Description + +
+
+ +
+
+ +Creates a `CustomObject` object with the given values. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from merge import Merge +from merge.resources.crm import CustomObjectRequest + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.custom_objects.custom_object_classes_custom_objects_create( + custom_object_class_id="custom_object_class_id", + model=CustomObjectRequest( + fields={"test_field": "hello"}, + ), +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**custom_object_class_id:** `str` + +
+
+ +
+
+ +**model:** `CustomObjectRequest` + +
+
+ +
+
+ +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. + +
+
+ +
+
+ +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -3292,7 +2947,7 @@ client.ats.eeocs.list()
-
client.ats.eeocs.retrieve(...) +
client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(...)
@@ -3304,7 +2959,7 @@ client.ats.eeocs.list()
-Returns an `EEOC` object with the given `id`. +Returns a `CustomObject` object with the given `id`.
@@ -3325,7 +2980,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.eeocs.retrieve( +client.crm.custom_objects.custom_object_classes_custom_objects_retrieve( + custom_object_class_id="custom_object_class_id", id="id", ) @@ -3343,7 +2999,7 @@ client.ats.eeocs.retrieve(
-**id:** `str` +**custom_object_class_id:** `str`
@@ -3351,7 +3007,7 @@ client.ats.eeocs.retrieve(
-**expand:** `typing.Optional[typing.Literal["candidate"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**id:** `str`
@@ -3367,15 +3023,7 @@ client.ats.eeocs.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
- -
-
- -**remote_fields:** `typing.Optional[EeocsRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins. +**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -3383,7 +3031,7 @@ client.ats.eeocs.retrieve(
-**show_enum_origins:** `typing.Optional[EeocsRetrieveRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -3403,8 +3051,7 @@ client.ats.eeocs.retrieve(
-## Ats FieldMapping -
client.ats.field_mapping.field_mappings_retrieve(...) +
client.crm.custom_objects.custom_object_classes_custom_objects_meta_post_retrieve(...)
@@ -3416,7 +3063,7 @@ client.ats.eeocs.retrieve(
-Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/). +Returns metadata for `CRMCustomObject` POSTs.
@@ -3437,7 +3084,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.field_mapping.field_mappings_retrieve() +client.crm.custom_objects.custom_object_classes_custom_objects_meta_post_retrieve( + custom_object_class_id="custom_object_class_id", +) ``` @@ -3453,7 +3102,7 @@ client.ats.field_mapping.field_mappings_retrieve()
-**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations. +**custom_object_class_id:** `str`
@@ -3473,7 +3122,7 @@ client.ats.field_mapping.field_mappings_retrieve()
-
client.ats.field_mapping.field_mappings_create(...) +
client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_classes_list(...)
@@ -3485,7 +3134,7 @@ client.ats.field_mapping.field_mappings_retrieve()
-Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start. +Returns a list of `RemoteFieldClass` objects.
@@ -3506,13 +3155,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.field_mapping.field_mappings_create( - target_field_name="example_target_field_name", - target_field_description="this is a example description of the target field", - remote_field_traversal_path=["example_remote_field"], - remote_method="GET", - remote_url_path="/example-url-path", - common_model_name="ExampleCommonModel", +client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -3529,7 +3173,7 @@ client.ats.field_mapping.field_mappings_create(
-**target_field_name:** `str` — The name of the target field you want this remote field to map to. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -3537,7 +3181,7 @@ client.ats.field_mapping.field_mappings_create(
-**target_field_description:** `str` — The description of the target field you want this remote field to map to. +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -3545,7 +3189,7 @@ client.ats.field_mapping.field_mappings_create(
-**remote_field_traversal_path:** `typing.Sequence[typing.Optional[typing.Any]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -3553,7 +3197,7 @@ client.ats.field_mapping.field_mappings_create(
-**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from. +**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -3561,7 +3205,7 @@ client.ats.field_mapping.field_mappings_create(
-**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -3569,7 +3213,7 @@ client.ats.field_mapping.field_mappings_create(
-**common_model_name:** `str` — The name of the Common Model that the remote field corresponds to in a given category. +**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
@@ -3577,7 +3221,15 @@ client.ats.field_mapping.field_mappings_create(
-**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations. +**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value + +
+
+ +
+
+ +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -3597,7 +3249,8 @@ client.ats.field_mapping.field_mappings_create(
-
client.ats.field_mapping.field_mappings_destroy(...) +## Crm Associations +
client.crm.associations.custom_object_classes_custom_objects_associations_list(...)
@@ -3609,7 +3262,7 @@ client.ats.field_mapping.field_mappings_create(
-Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start. +Returns a list of `Association` objects.
@@ -3630,8 +3283,10 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.field_mapping.field_mappings_destroy( - field_mapping_id="field_mapping_id", +client.crm.associations.custom_object_classes_custom_objects_associations_list( + custom_object_class_id="custom_object_class_id", + object_id="object_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -3648,7 +3303,7 @@ client.ats.field_mapping.field_mappings_destroy(
-**field_mapping_id:** `str` +**custom_object_class_id:** `str`
@@ -3656,70 +3311,79 @@ client.ats.field_mapping.field_mappings_destroy(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**object_id:** `str`
- -
+
+
+**association_type_id:** `typing.Optional[str]` — If provided, will only return opportunities with this association_type. +
-
-
client.ats.field_mapping.field_mappings_partial_update(...)
-#### 📝 Description +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. + +
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. + +
+
+
-Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start. -
-
+**cursor:** `typing.Optional[str]` — The pagination cursor value. + -#### 🔌 Usage -
+**expand:** `typing.Optional[typing.Literal["association_type"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
+
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ats.field_mapping.field_mappings_partial_update( - field_mapping_id="field_mapping_id", -) - -``` +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +
+ +
+
+ +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +
-#### ⚙️ Parameters -
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
+
-**field_mapping_id:** `str` +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -3727,7 +3391,7 @@ client.ats.field_mapping.field_mappings_partial_update(
-**remote_field_traversal_path:** `typing.Optional[typing.Sequence[typing.Optional[typing.Any]]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -3735,7 +3399,7 @@ client.ats.field_mapping.field_mappings_partial_update(
-**remote_method:** `typing.Optional[str]` — The method of the remote endpoint where the remote field is coming from. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -3743,7 +3407,7 @@ client.ats.field_mapping.field_mappings_partial_update(
-**remote_url_path:** `typing.Optional[str]` — The path of the remote endpoint where the remote field is coming from. +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -3763,7 +3427,7 @@ client.ats.field_mapping.field_mappings_partial_update(
-
client.ats.field_mapping.remote_fields_retrieve(...) +
client.crm.associations.custom_object_classes_custom_objects_associations_update(...)
@@ -3775,7 +3439,7 @@ client.ats.field_mapping.field_mappings_partial_update(
-Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/). +Creates an Association between `source_object_id` and `target_object_id` of type `association_type_id`.
@@ -3796,7 +3460,13 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.field_mapping.remote_fields_retrieve() +client.crm.associations.custom_object_classes_custom_objects_associations_update( + association_type_id="association_type_id", + source_class_id="source_class_id", + source_object_id="source_object_id", + target_class_id="target_class_id", + target_object_id="target_object_id", +) ``` @@ -3812,7 +3482,7 @@ client.ats.field_mapping.remote_fields_retrieve()
-**common_models:** `typing.Optional[str]` — A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models. +**association_type_id:** `str`
@@ -3820,7 +3490,47 @@ client.ats.field_mapping.remote_fields_retrieve()
-**include_example_values:** `typing.Optional[str]` — If true, will include example values, where available, for remote fields in the 3rd party platform. These examples come from active data from your customers. +**source_class_id:** `str` + +
+
+ +
+
+ +**source_object_id:** `str` + +
+
+ +
+
+ +**target_class_id:** `str` + +
+
+ +
+
+ +**target_object_id:** `str` + +
+
+ +
+
+ +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. + +
+
+ +
+
+ +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -3840,7 +3550,8 @@ client.ats.field_mapping.remote_fields_retrieve()
-
client.ats.field_mapping.target_fields_retrieve() +## Crm Scopes +
client.crm.scopes.default_scopes_retrieve()
@@ -3852,7 +3563,7 @@ client.ats.field_mapping.remote_fields_retrieve()
-Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields. Organization-wide Target Fields are additional fields appended to the Merge Common Model for all Linked Accounts in a category. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/target-fields/). +Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
@@ -3873,7 +3584,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.field_mapping.target_fields_retrieve() +client.crm.scopes.default_scopes_retrieve() ``` @@ -3901,8 +3612,7 @@ client.ats.field_mapping.target_fields_retrieve()
-## Ats GenerateKey -
client.ats.generate_key.create(...) +
client.crm.scopes.linked_account_scopes_retrieve()
@@ -3914,7 +3624,7 @@ client.ats.field_mapping.target_fields_retrieve()
-Create a remote key. +Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
@@ -3935,9 +3645,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.generate_key.create( - name="Remote Deployment Key 1", -) +client.crm.scopes.linked_account_scopes_retrieve() ``` @@ -3953,14 +3661,6 @@ client.ats.generate_key.create(
-**name:** `str` — The name of the remote key - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -3973,8 +3673,7 @@ client.ats.generate_key.create(
-## Ats Interviews -
client.ats.interviews.list(...) +
client.crm.scopes.linked_account_scopes_create(...)
@@ -3986,7 +3685,7 @@ client.ats.generate_key.create(
-Returns a list of `ScheduledInterview` objects. +Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes)
@@ -4002,12 +3701,43 @@ Returns a list of `ScheduledInterview` objects. ```python from merge import Merge +from merge.resources.crm import ( + FieldPermissionDeserializerRequest, + IndividualCommonModelScopeDeserializerRequest, + ModelPermissionDeserializerRequest, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.interviews.list() +client.crm.scopes.linked_account_scopes_create( + common_models=[ + IndividualCommonModelScopeDeserializerRequest( + model_name="Employee", + model_permissions={ + "READ": ModelPermissionDeserializerRequest( + is_enabled=True, + ), + "WRITE": ModelPermissionDeserializerRequest( + is_enabled=False, + ), + }, + field_permissions=FieldPermissionDeserializerRequest( + enabled_fields=["avatar", "home_location"], + disabled_fields=["work_location"], + ), + ), + IndividualCommonModelScopeDeserializerRequest( + model_name="Benefit", + model_permissions={ + "WRITE": ModelPermissionDeserializerRequest( + is_enabled=False, + ) + }, + ), + ], +) ``` @@ -4023,7 +3753,7 @@ client.ats.interviews.list()
-**application_id:** `typing.Optional[str]` — If provided, will only return interviews for this application. +**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for
@@ -4031,47 +3761,133 @@ client.ats.interviews.list()
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
+ + + +
+ +## Crm DeleteAccount +
client.crm.delete_account.delete()
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. - +#### 📝 Description + +
+
+ +
+
+ +Delete a linked account. +
+
+#### 🔌 Usage +
-**cursor:** `typing.Optional[str]` — The pagination cursor value. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.delete_account.delete() + +``` +
+
+#### ⚙️ Parameters +
-**expand:** `typing.Optional[InterviewsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+ + +
+
+
+ +## Crm EngagementTypes +
client.crm.engagement_types.list(...) +
+
+ +#### 📝 Description
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). - +
+
+ +Returns a list of `EngagementType` objects.
+
+
+ +#### 🔌 Usage
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.engagement_types.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -4079,7 +3895,7 @@ client.ats.interviews.list()
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -4087,7 +3903,7 @@ client.ats.interviews.list()
-**job_id:** `typing.Optional[str]` — If provided, wll only return interviews organized for this job. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -4095,7 +3911,7 @@ client.ats.interviews.list()
-**job_interview_stage_id:** `typing.Optional[str]` — If provided, will only return interviews at this stage. +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -4103,7 +3919,7 @@ client.ats.interviews.list()
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -4111,7 +3927,7 @@ client.ats.interviews.list()
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -4119,7 +3935,7 @@ client.ats.interviews.list()
-**organizer_id:** `typing.Optional[str]` — If provided, will only return interviews organized by this user. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -4127,7 +3943,7 @@ client.ats.interviews.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -4135,7 +3951,7 @@ client.ats.interviews.list()
-**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -4143,7 +3959,7 @@ client.ats.interviews.list()
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -4151,7 +3967,7 @@ client.ats.interviews.list()
-**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -4171,7 +3987,7 @@ client.ats.interviews.list()
-
client.ats.interviews.create(...) +
client.crm.engagement_types.retrieve(...)
@@ -4183,7 +3999,7 @@ client.ats.interviews.list()
-Creates a `ScheduledInterview` object with the given values. +Returns an `EngagementType` object with the given `id`.
@@ -4199,15 +4015,13 @@ Creates a `ScheduledInterview` object with the given values. ```python from merge import Merge -from merge.resources.ats import ScheduledInterviewRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.interviews.create( - model=ScheduledInterviewRequest(), - remote_user_id="remote_user_id", +client.crm.engagement_types.retrieve( + id="id", ) ``` @@ -4224,7 +4038,7 @@ client.ats.interviews.create(
-**model:** `ScheduledInterviewRequest` +**id:** `str`
@@ -4232,7 +4046,7 @@ client.ats.interviews.create(
-**remote_user_id:** `str` +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -4240,7 +4054,7 @@ client.ats.interviews.create(
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -4248,7 +4062,7 @@ client.ats.interviews.create(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -4268,7 +4082,7 @@ client.ats.interviews.create(
-
client.ats.interviews.retrieve(...) +
client.crm.engagement_types.remote_field_classes_list(...)
@@ -4280,7 +4094,7 @@ client.ats.interviews.create(
-Returns a `ScheduledInterview` object with the given `id`. +Returns a list of `RemoteFieldClass` objects.
@@ -4301,8 +4115,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.interviews.retrieve( - id="id", +client.crm.engagement_types.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -4319,7 +4133,7 @@ client.ats.interviews.retrieve(
-**id:** `str` +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -4327,7 +4141,7 @@ client.ats.interviews.retrieve(
-**expand:** `typing.Optional[InterviewsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -4343,6 +4157,14 @@ client.ats.interviews.retrieve(
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. + +
+
+ +
+
+ **include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -4351,7 +4173,7 @@ client.ats.interviews.retrieve(
-**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins. +**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
@@ -4359,7 +4181,15 @@ client.ats.interviews.retrieve(
-**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) +**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value + +
+
+ +
+
+ +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -4379,7 +4209,8 @@ client.ats.interviews.retrieve(
-
client.ats.interviews.meta_post_retrieve() +## Crm Engagements +
client.crm.engagements.list(...)
@@ -4391,7 +4222,7 @@ client.ats.interviews.retrieve(
-Returns metadata for `ScheduledInterview` POSTs. +Returns a list of `Engagement` objects.
@@ -4412,7 +4243,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.interviews.meta_post_retrieve() +client.crm.engagements.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -4428,69 +4261,55 @@ client.ats.interviews.meta_post_retrieve()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
- -
+
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +
-
-## Ats Issues -
client.ats.issues.list(...)
-#### 📝 Description - -
-
+**cursor:** `typing.Optional[str]` — The pagination cursor value. + +
+
-Gets all issues for Organization. -
-
+**expand:** `typing.Optional[EngagementsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +
-#### 🔌 Usage -
-
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ats.issues.list() - -``` -
-
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +
-#### ⚙️ Parameters -
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+
-**account_token:** `typing.Optional[str]` +**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -4498,7 +4317,7 @@ client.ats.issues.list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -4506,7 +4325,7 @@ client.ats.issues.list()
-**end_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred before this time +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -4514,7 +4333,7 @@ client.ats.issues.list()
-**end_user_organization_name:** `typing.Optional[str]` +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -4522,7 +4341,7 @@ client.ats.issues.list()
-**first_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was after this datetime. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -4530,7 +4349,7 @@ client.ats.issues.list()
-**first_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was before this datetime. +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -4538,7 +4357,7 @@ client.ats.issues.list()
-**include_muted:** `typing.Optional[str]` — If true, will include muted issues +**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return engagements started after this datetime.
@@ -4546,7 +4365,7 @@ client.ats.issues.list()
-**integration_name:** `typing.Optional[str]` +**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return engagements started before this datetime.
@@ -4554,31 +4373,71 @@ client.ats.issues.list()
-**last_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was after this datetime. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ + + + + + +
+
client.crm.engagements.create(...)
-**last_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was before this datetime. - +#### 📝 Description + +
+
+ +
+
+ +Creates an `Engagement` object with the given values.
+
+
+ +#### 🔌 Usage
-**linked_account_id:** `typing.Optional[str]` — If provided, will only include issues pertaining to the linked account passed in. - +
+
+ +```python +from merge import Merge +from merge.resources.crm import EngagementRequest + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.engagements.create( + model=EngagementRequest(), +) + +``` +
+
+#### ⚙️ Parameters +
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +
+
+ +**model:** `EngagementRequest`
@@ -4586,7 +4445,7 @@ client.ats.issues.list()
-**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -4594,12 +4453,7 @@ client.ats.issues.list()
-**status:** `typing.Optional[IssuesListRequestStatus]` - -Status of the issue. Options: ('ONGOING', 'RESOLVED') - -* `ONGOING` - ONGOING -* `RESOLVED` - RESOLVED +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -4619,7 +4473,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-
client.ats.issues.retrieve(...) +
client.crm.engagements.retrieve(...)
@@ -4631,7 +4485,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-Get a specific issue. +Returns an `Engagement` object with the given `id`.
@@ -4652,7 +4506,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.issues.retrieve( +client.crm.engagements.retrieve( id="id", ) @@ -4678,6 +4532,38 @@ client.ats.issues.retrieve(
+**expand:** `typing.Optional[EngagementsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
+ +
+
+ +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+ +
+
+ +**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. + +
+
+ +
+
+ +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -4690,8 +4576,7 @@ client.ats.issues.retrieve(
-## Ats JobInterviewStages -
client.ats.job_interview_stages.list(...) +
client.crm.engagements.partial_update(...)
@@ -4703,7 +4588,7 @@ client.ats.issues.retrieve(
-Returns a list of `JobInterviewStage` objects. +Updates an `Engagement` object with the given `id`.
@@ -4719,12 +4604,16 @@ Returns a list of `JobInterviewStage` objects. ```python from merge import Merge +from merge.resources.crm import PatchedEngagementRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.job_interview_stages.list() +client.crm.engagements.partial_update( + id="id", + model=PatchedEngagementRequest(), +) ``` @@ -4740,7 +4629,7 @@ client.ats.job_interview_stages.list()
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**id:** `str`
@@ -4748,7 +4637,7 @@ client.ats.job_interview_stages.list()
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**model:** `PatchedEngagementRequest`
@@ -4756,7 +4645,7 @@ client.ats.job_interview_stages.list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -4764,7 +4653,7 @@ client.ats.job_interview_stages.list()
-**expand:** `typing.Optional[typing.Literal["job"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -4772,63 +4661,70 @@ client.ats.job_interview_stages.list()
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. -
+
+
client.crm.engagements.meta_patch_retrieve(...)
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
+#### 📝 Description
-**job_id:** `typing.Optional[str]` — If provided, will only return interview stages for this job. - -
-
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. - +Returns metadata for `Engagement` PATCHs.
+ + + +#### 🔌 Usage
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. - -
-
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. - +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.engagements.meta_patch_retrieve( + id="id", +) + +``` +
+
+#### ⚙️ Parameters +
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +
+
+ +**id:** `str`
@@ -4848,7 +4744,7 @@ client.ats.job_interview_stages.list()
-
client.ats.job_interview_stages.retrieve(...) +
client.crm.engagements.meta_post_retrieve()
@@ -4860,7 +4756,7 @@ client.ats.job_interview_stages.list()
-Returns a `JobInterviewStage` object with the given `id`. +Returns metadata for `Engagement` POSTs.
@@ -4881,9 +4777,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.job_interview_stages.retrieve( - id="id", -) +client.crm.engagements.meta_post_retrieve() ``` @@ -4899,38 +4793,6 @@ client.ats.job_interview_stages.retrieve(
-**id:** `str` - -
-
- -
-
- -**expand:** `typing.Optional[typing.Literal["job"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - -
-
- -
-
- -**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
- -
-
- -**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -4943,8 +4805,7 @@ client.ats.job_interview_stages.retrieve(
-## Ats JobPostings -
client.ats.job_postings.list(...) +
client.crm.engagements.remote_field_classes_list(...)
@@ -4956,7 +4817,7 @@ client.ats.job_interview_stages.retrieve(
-Returns a list of `JobPosting` objects. +Returns a list of `RemoteFieldClass` objects.
@@ -4977,7 +4838,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.job_postings.list() +client.crm.engagements.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -4993,7 +4856,7 @@ client.ats.job_postings.list()
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -5001,7 +4864,7 @@ client.ats.job_postings.list()
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -5009,7 +4872,7 @@ client.ats.job_postings.list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -5017,7 +4880,7 @@ client.ats.job_postings.list()
-**expand:** `typing.Optional[typing.Literal["job"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -5025,7 +4888,7 @@ client.ats.job_postings.list()
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -5033,7 +4896,7 @@ client.ats.job_postings.list()
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
@@ -5041,7 +4904,7 @@ client.ats.job_postings.list()
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value
@@ -5049,7 +4912,7 @@ client.ats.job_postings.list()
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -5057,39 +4920,69 @@ client.ats.job_postings.list()
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
+ + + +
+ +## Crm FieldMapping +
client.crm.field_mapping.field_mappings_retrieve(...)
-**page_size:** `typing.Optional[int]` — Number of results to return per page. - +#### 📝 Description + +
+
+ +
+
+ +Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/). +
+
+#### 🔌 Usage +
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.field_mapping.field_mappings_retrieve() + +``` +
+
+#### ⚙️ Parameters +
-**status:** `typing.Optional[JobPostingsListRequestStatus]` - -If provided, will only return Job Postings with this status. Options: ('PUBLISHED', 'CLOSED', 'DRAFT', 'INTERNAL', 'PENDING') +
+
-* `PUBLISHED` - PUBLISHED -* `CLOSED` - CLOSED -* `DRAFT` - DRAFT -* `INTERNAL` - INTERNAL -* `PENDING` - PENDING +**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations.
@@ -5109,7 +5002,7 @@ If provided, will only return Job Postings with this status. Options: ('PUBLISHE
-
client.ats.job_postings.retrieve(...) +
client.crm.field_mapping.field_mappings_create(...)
@@ -5121,7 +5014,7 @@ If provided, will only return Job Postings with this status. Options: ('PUBLISHE
-Returns a `JobPosting` object with the given `id`. +Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
@@ -5142,8 +5035,13 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.job_postings.retrieve( - id="id", +client.crm.field_mapping.field_mappings_create( + target_field_name="example_target_field_name", + target_field_description="this is a example description of the target field", + remote_field_traversal_path=["example_remote_field"], + remote_method="GET", + remote_url_path="/example-url-path", + common_model_name="ExampleCommonModel", ) ``` @@ -5160,7 +5058,7 @@ client.ats.job_postings.retrieve(
-**id:** `str` +**target_field_name:** `str` — The name of the target field you want this remote field to map to.
@@ -5168,7 +5066,7 @@ client.ats.job_postings.retrieve(
-**expand:** `typing.Optional[typing.Literal["job"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**target_field_description:** `str` — The description of the target field you want this remote field to map to.
@@ -5176,7 +5074,7 @@ client.ats.job_postings.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**remote_field_traversal_path:** `typing.Sequence[typing.Optional[typing.Any]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
@@ -5184,7 +5082,31 @@ client.ats.job_postings.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from. + +
+
+ +
+
+ +**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from. + +
+
+ +
+
+ +**common_model_name:** `str` — The name of the Common Model that the remote field corresponds to in a given category. + +
+
+ +
+
+ +**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations.
@@ -5204,8 +5126,7 @@ client.ats.job_postings.retrieve(
-## Ats Jobs -
client.ats.jobs.list(...) +
client.crm.field_mapping.field_mappings_destroy(...)
@@ -5217,7 +5138,7 @@ client.ats.job_postings.retrieve(
-Returns a list of `Job` objects. +Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
@@ -5238,7 +5159,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.jobs.list() +client.crm.field_mapping.field_mappings_destroy( + field_mapping_id="field_mapping_id", +) ``` @@ -5254,7 +5177,7 @@ client.ats.jobs.list()
-**code:** `typing.Optional[str]` — If provided, will only return jobs with this code. +**field_mapping_id:** `str`
@@ -5262,95 +5185,70 @@ client.ats.jobs.list()
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
- -
-
- -**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. -
-
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value. -
+
+
client.crm.field_mapping.field_mappings_partial_update(...)
-**expand:** `typing.Optional[JobsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - -
-
+#### 📝 Description
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). - -
-
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - +Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
- -
-
- -**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). -
+#### 🔌 Usage +
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. - -
-
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. - -
-
+```python +from merge import Merge -
-
+client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.field_mapping.field_mappings_partial_update( + field_mapping_id="field_mapping_id", +) -**offices:** `typing.Optional[str]` — If provided, will only return jobs for this office; multiple offices can be separated by commas. - +``` +
+
+#### ⚙️ Parameters +
-**page_size:** `typing.Optional[int]` — Number of results to return per page. - -
-
-
-**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins. +**field_mapping_id:** `str`
@@ -5358,7 +5256,7 @@ client.ats.jobs.list()
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**remote_field_traversal_path:** `typing.Optional[typing.Sequence[typing.Optional[typing.Any]]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
@@ -5366,7 +5264,7 @@ client.ats.jobs.list()
-**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) +**remote_method:** `typing.Optional[str]` — The method of the remote endpoint where the remote field is coming from.
@@ -5374,15 +5272,7 @@ client.ats.jobs.list()
-**status:** `typing.Optional[JobsListRequestStatus]` - -If provided, will only return jobs with this status. Options: ('OPEN', 'CLOSED', 'DRAFT', 'ARCHIVED', 'PENDING') - -* `OPEN` - OPEN -* `CLOSED` - CLOSED -* `DRAFT` - DRAFT -* `ARCHIVED` - ARCHIVED -* `PENDING` - PENDING +**remote_url_path:** `typing.Optional[str]` — The path of the remote endpoint where the remote field is coming from.
@@ -5402,7 +5292,7 @@ If provided, will only return jobs with this status. Options: ('OPEN', 'CLOSED',
-
client.ats.jobs.retrieve(...) +
client.crm.field_mapping.remote_fields_retrieve(...)
@@ -5414,7 +5304,7 @@ If provided, will only return jobs with this status. Options: ('OPEN', 'CLOSED',
-Returns a `Job` object with the given `id`. +Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
@@ -5435,9 +5325,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.jobs.retrieve( - id="id", -) +client.crm.field_mapping.remote_fields_retrieve() ``` @@ -5453,39 +5341,7 @@ client.ats.jobs.retrieve(
-**id:** `str` - -
-
- -
-
- -**expand:** `typing.Optional[JobsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - -
-
- -
-
- -**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
- -
-
- -**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
- -
-
- -**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins. +**common_models:** `typing.Optional[str]` — A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models.
@@ -5493,7 +5349,7 @@ client.ats.jobs.retrieve(
-**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) +**include_example_values:** `typing.Optional[str]` — If true, will include example values, where available, for remote fields in the 3rd party platform. These examples come from active data from your customers.
@@ -5513,7 +5369,7 @@ client.ats.jobs.retrieve(
-
client.ats.jobs.screening_questions_list(...) +
client.crm.field_mapping.target_fields_retrieve()
@@ -5525,7 +5381,7 @@ client.ats.jobs.retrieve(
-Returns a list of `ScreeningQuestion` objects. +Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields. Organization-wide Target Fields are additional fields appended to the Merge Common Model for all Linked Accounts in a category. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/target-fields/).
@@ -5546,9 +5402,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.jobs.screening_questions_list( - job_id="job_id", -) +client.crm.field_mapping.target_fields_retrieve() ``` @@ -5564,55 +5418,71 @@ client.ats.jobs.screening_questions_list(
-**job_id:** `str` +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value. -
+
+## Crm GenerateKey +
client.crm.generate_key.create(...)
-**expand:** `typing.Optional[JobsScreeningQuestionsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - -
-
+#### 📝 Description
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). - -
-
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - +Create a remote key. +
+
+#### 🔌 Usage +
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.generate_key.create( + name="Remote Deployment Key 1", +) + +``` +
+
+#### ⚙️ Parameters +
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +
+
+ +**name:** `str` — The name of the remote key
@@ -5632,8 +5502,8 @@ client.ats.jobs.screening_questions_list(
-## Ats LinkToken -
client.ats.link_token.create(...) +## Crm Issues +
client.crm.issues.list(...)
@@ -5645,7 +5515,7 @@ client.ats.jobs.screening_questions_list(
-Creates a link token to be used when linking a new end user. +Gets all issues for Organization.
@@ -5661,17 +5531,13 @@ Creates a link token to be used when linking a new end user. ```python from merge import Merge -from merge.resources.ats import CategoriesEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.link_token.create( - end_user_email_address="example@gmail.com", - end_user_organization_name="Test Organization", - end_user_origin_id="12345", - categories=[CategoriesEnum.HRIS, CategoriesEnum.ATS], +client.crm.issues.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -5688,7 +5554,7 @@ client.ats.link_token.create(
-**end_user_email_address:** `str` — Your end user's email address. This is purely for identification purposes - setting this value will not cause any emails to be sent. +**account_token:** `typing.Optional[str]`
@@ -5696,7 +5562,7 @@ client.ats.link_token.create(
-**end_user_organization_name:** `str` — Your end user's organization. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -5704,7 +5570,7 @@ client.ats.link_token.create(
-**end_user_origin_id:** `str` — This unique identifier typically represents the ID for your end user in your product's database. This value must be distinct from other Linked Accounts' unique identifiers. +**end_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred before this time
@@ -5712,7 +5578,7 @@ client.ats.link_token.create(
-**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link. +**end_user_organization_name:** `typing.Optional[str]`
@@ -5720,7 +5586,7 @@ client.ats.link_token.create(
-**integration:** `typing.Optional[str]` — The slug of a specific pre-selected integration for this linking flow token. For examples of slugs, see https://docs.merge.dev/guides/merge-link/single-integration/. +**first_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was after this datetime.
@@ -5728,7 +5594,7 @@ client.ats.link_token.create(
-**link_expiry_mins:** `typing.Optional[int]` — An integer number of minutes between [30, 720 or 10080 if for a Magic Link URL] for how long this token is valid. Defaults to 30. +**first_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was before this datetime.
@@ -5736,7 +5602,7 @@ client.ats.link_token.create(
-**should_create_magic_link_url:** `typing.Optional[bool]` — Whether to generate a Magic Link URL. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link. +**include_muted:** `typing.Optional[str]` — If true, will include muted issues
@@ -5744,7 +5610,7 @@ client.ats.link_token.create(
-**hide_admin_magic_link:** `typing.Optional[bool]` — Whether to generate a Magic Link URL on the Admin Needed screen during the linking flow. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link. +**integration_name:** `typing.Optional[str]`
@@ -5752,7 +5618,7 @@ client.ats.link_token.create(
-**common_models:** `typing.Optional[typing.Sequence[CommonModelScopesBodyRequest]]` — An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account. +**last_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was after this datetime.
@@ -5760,14 +5626,7 @@ client.ats.link_token.create(
-**category_common_model_scopes:** `typing.Optional[ - typing.Dict[ - str, - typing.Optional[ - typing.Sequence[IndividualCommonModelScopeDeserializerRequest] - ], - ] -]` — When creating a Link Token, you can set permissions for Common Models that will apply to the account that is going to be linked. Any model or field not specified in link token payload will default to existing settings. +**last_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was before this datetime.
@@ -5775,12 +5634,15 @@ client.ats.link_token.create(
-**language:** `typing.Optional[EndUserDetailsRequestLanguage]` +**linked_account_id:** `typing.Optional[str]` — If provided, will only include issues pertaining to the linked account passed in. + +
+
-The following subset of IETF language tags can be used to configure localization. +
+
-* `en` - en -* `de` - de +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -5788,7 +5650,7 @@ The following subset of IETF language tags can be used to configure localization
-**are_syncs_disabled:** `typing.Optional[bool]` — The boolean that indicates whether initial, periodic, and force syncs will be disabled. +**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time
@@ -5796,7 +5658,12 @@ The following subset of IETF language tags can be used to configure localization
-**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — A JSON object containing integration-specific configuration options. +**status:** `typing.Optional[IssuesListRequestStatus]` + +Status of the issue. Options: ('ONGOING', 'RESOLVED') + +* `ONGOING` - ONGOING +* `RESOLVED` - RESOLVED
@@ -5816,8 +5683,7 @@ The following subset of IETF language tags can be used to configure localization
-## Ats LinkedAccounts -
client.ats.linked_accounts.list(...) +
client.crm.issues.retrieve(...)
@@ -5829,7 +5695,7 @@ The following subset of IETF language tags can be used to configure localization
-List linked accounts for your organization. +Get a specific issue.
@@ -5850,7 +5716,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.linked_accounts.list() +client.crm.issues.retrieve( + id="id", +) ``` @@ -5866,17 +5734,7 @@ client.ats.linked_accounts.list()
-**category:** `typing.Optional[LinkedAccountsListRequestCategory]` - -Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing` - -* `hris` - hris -* `ats` - ats -* `accounting` - accounting -* `ticketing` - ticketing -* `crm` - crm -* `mktg` - mktg -* `filestorage` - filestorage +**id:** `str`
@@ -5884,63 +5742,71 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**end_user_email_address:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given email address. -
+
+## Crm Leads +
client.crm.leads.list(...)
-**end_user_organization_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given organization name. - -
-
+#### 📝 Description
-**end_user_origin_id:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given origin ID. - -
-
-
-**end_user_origin_ids:** `typing.Optional[str]` — Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once. - +Returns a list of `Lead` objects. +
+
+#### 🔌 Usage +
-**id:** `typing.Optional[str]` - -
-
-
-**ids:** `typing.Optional[str]` — Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once. - +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.leads.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) + +``` +
+
+#### ⚙️ Parameters +
-**include_duplicates:** `typing.Optional[bool]` — If `true`, will include complete production duplicates of the account specified by the `id` query parameter in the response. `id` must be for a complete production linked account. +
+
+ +**converted_account_id:** `typing.Optional[str]` — If provided, will only return leads with this account.
@@ -5948,7 +5814,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**integration_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given integration name. +**converted_contact_id:** `typing.Optional[str]` — If provided, will only return leads with this contact.
@@ -5956,7 +5822,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**is_test_account:** `typing.Optional[str]` — If included, will only include test linked accounts. If not included, will only include non-test linked accounts. +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -5964,7 +5830,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -5972,7 +5838,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**status:** `typing.Optional[str]` — Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED` +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -5980,69 +5846,47 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**email_addresses:** `typing.Optional[str]` — If provided, will only return contacts matching the email addresses; multiple email_addresses can be separated by commas.
-
-
+
+
+**expand:** `typing.Optional[LeadsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +
-
-## Ats Offers -
client.ats.offers.list(...)
-#### 📝 Description - -
-
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). + +
+
-Returns a list of `Offer` objects. -
-
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +
-#### 🔌 Usage -
-
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ats.offers.list() - -``` -
-
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +
-#### ⚙️ Parameters - -
-
-
-**application_id:** `typing.Optional[str]` — If provided, will only return offers for this application. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -6050,7 +5894,7 @@ client.ats.offers.list()
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -6058,7 +5902,7 @@ client.ats.offers.list()
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -6066,7 +5910,7 @@ client.ats.offers.list()
-**creator_id:** `typing.Optional[str]` — If provided, will only return offers created by this user. +**owner_id:** `typing.Optional[str]` — If provided, will only return leads with this owner.
@@ -6074,7 +5918,7 @@ client.ats.offers.list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -6082,7 +5926,7 @@ client.ats.offers.list()
-**expand:** `typing.Optional[OffersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**phone_numbers:** `typing.Optional[str]` — If provided, will only return contacts matching the phone numbers; multiple phone numbers can be separated by commas.
@@ -6090,7 +5934,7 @@ client.ats.offers.list()
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -6098,47 +5942,71 @@ client.ats.offers.list()
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
-
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). -
+
+
client.crm.leads.create(...)
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. - -
-
+#### 📝 Description
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. - +
+
+ +Creates a `Lead` object with the given values. +
+
+#### 🔌 Usage +
-**page_size:** `typing.Optional[int]` — Number of results to return per page. - +
+
+ +```python +from merge import Merge +from merge.resources.crm import LeadRequest + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.leads.create( + model=LeadRequest(), +) + +``` +
+
+#### ⚙️ Parameters +
-**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins. +
+
+ +**model:** `LeadRequest`
@@ -6146,7 +6014,7 @@ client.ats.offers.list()
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -6154,7 +6022,7 @@ client.ats.offers.list()
-**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -6174,7 +6042,7 @@ client.ats.offers.list()
-
client.ats.offers.retrieve(...) +
client.crm.leads.retrieve(...)
@@ -6186,7 +6054,7 @@ client.ats.offers.list()
-Returns an `Offer` object with the given `id`. +Returns a `Lead` object with the given `id`.
@@ -6207,7 +6075,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.offers.retrieve( +client.crm.leads.retrieve( id="id", ) @@ -6233,7 +6101,7 @@ client.ats.offers.retrieve(
-**expand:** `typing.Optional[OffersRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[LeadsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -6249,15 +6117,7 @@ client.ats.offers.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
- -
-
- -**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins. +**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -6265,7 +6125,7 @@ client.ats.offers.retrieve(
-**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -6285,8 +6145,7 @@ client.ats.offers.retrieve(
-## Ats Offices -
client.ats.offices.list(...) +
client.crm.leads.meta_post_retrieve()
@@ -6298,7 +6157,7 @@ client.ats.offers.retrieve(
-Returns a list of `Office` objects. +Returns metadata for `Lead` POSTs.
@@ -6319,7 +6178,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.offices.list() +client.crm.leads.meta_post_retrieve() ``` @@ -6335,19 +6194,66 @@ client.ats.offices.list()
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
+ + + +
+ +
client.crm.leads.remote_field_classes_list(...)
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. - +#### 📝 Description + +
+
+ +
+
+ +Returns a list of `RemoteFieldClass` objects. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.leads.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) + +``` +
+
+#### ⚙️ Parameters + +
+
+
@@ -6375,7 +6281,7 @@ client.ats.offices.list()
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -6383,7 +6289,7 @@ client.ats.offices.list()
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -6391,7 +6297,7 @@ client.ats.offices.list()
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
@@ -6399,7 +6305,7 @@ client.ats.offices.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value
@@ -6407,7 +6313,7 @@ client.ats.offices.list()
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -6427,7 +6333,8 @@ client.ats.offices.list()
-
client.ats.offices.retrieve(...) +## Crm LinkToken +
client.crm.link_token.create(...)
@@ -6439,7 +6346,7 @@ client.ats.offices.list()
-Returns an `Office` object with the given `id`. +Creates a link token to be used when linking a new end user.
@@ -6455,13 +6362,17 @@ Returns an `Office` object with the given `id`. ```python from merge import Merge +from merge.resources.crm import CategoriesEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.offices.retrieve( - id="id", +client.crm.link_token.create( + end_user_email_address="example@gmail.com", + end_user_organization_name="Test Organization", + end_user_origin_id="12345", + categories=[CategoriesEnum.HRIS, CategoriesEnum.ATS], ) ``` @@ -6478,7 +6389,7 @@ client.ats.offices.retrieve(
-**id:** `str` +**end_user_email_address:** `str` — Your end user's email address. This is purely for identification purposes - setting this value will not cause any emails to be sent.
@@ -6486,7 +6397,7 @@ client.ats.offices.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**end_user_organization_name:** `str` — Your end user's organization.
@@ -6494,7 +6405,7 @@ client.ats.offices.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**end_user_origin_id:** `str` — This unique identifier typically represents the ID for your end user in your product's database. This value must be distinct from other Linked Accounts' unique identifiers.
@@ -6502,75 +6413,39 @@ client.ats.offices.retrieve(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link.
- -
- - - - -
-## Ats Passthrough -
client.ats.passthrough.create(...)
-#### 📝 Description - -
-
+**integration:** `typing.Optional[str]` — The slug of a specific pre-selected integration for this linking flow token. For examples of slugs, see https://docs.merge.dev/guides/merge-link/single-integration/. + +
+
-Pull data from an endpoint not currently supported by Merge. -
-
+**link_expiry_mins:** `typing.Optional[int]` — An integer number of minutes between [30, 720 or 10080 if for a Magic Link URL] for how long this token is valid. Defaults to 30. +
-#### 🔌 Usage -
-
-
- -```python -from merge import Merge -from merge.resources.ats import DataPassthroughRequest, MethodEnum - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ats.passthrough.create( - request=DataPassthroughRequest( - method=MethodEnum.GET, - path="/scooters", - ), -) - -``` -
-
+**should_create_magic_link_url:** `typing.Optional[bool]` — Whether to generate a Magic Link URL. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link. +
-#### ⚙️ Parameters - -
-
-
-**request:** `DataPassthroughRequest` +**hide_admin_magic_link:** `typing.Optional[bool]` — Whether to generate a Magic Link URL on the Admin Needed screen during the linking flow. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link.
@@ -6578,71 +6453,51 @@ client.ats.passthrough.create(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**common_models:** `typing.Optional[typing.Sequence[CommonModelScopesBodyRequest]]` — An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account.
-
-
+
+
+**category_common_model_scopes:** `typing.Optional[ + typing.Dict[ + str, + typing.Optional[ + typing.Sequence[IndividualCommonModelScopeDeserializerRequest] + ], + ] +]` — When creating a Link Token, you can set permissions for Common Models that will apply to the account that is going to be linked. Any model or field not specified in link token payload will default to existing settings. +
-
-## Ats RegenerateKey -
client.ats.regenerate_key.create(...)
-#### 📝 Description - -
-
+**language:** `typing.Optional[EndUserDetailsRequestLanguage]` -
-
+The following subset of IETF language tags can be used to configure localization. -Exchange remote keys. -
-
+* `en` - en +* `de` - de +
-#### 🔌 Usage - -
-
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ats.regenerate_key.create( - name="Remote Deployment Key 1", -) - -``` -
-
+**are_syncs_disabled:** `typing.Optional[bool]` — The boolean that indicates whether initial, periodic, and force syncs will be disabled. +
-#### ⚙️ Parameters - -
-
-
-**name:** `str` — The name of the remote key +**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — A JSON object containing integration-specific configuration options.
@@ -6662,8 +6517,8 @@ client.ats.regenerate_key.create(
-## Ats RejectReasons -
client.ats.reject_reasons.list(...) +## Crm LinkedAccounts +
client.crm.linked_accounts.list(...)
@@ -6675,7 +6530,7 @@ client.ats.regenerate_key.create(
-Returns a list of `RejectReason` objects. +List linked accounts for your organization.
@@ -6696,7 +6551,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.reject_reasons.list() +client.crm.linked_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -6712,15 +6569,17 @@ client.ats.reject_reasons.list()
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. - -
-
+**category:** `typing.Optional[LinkedAccountsListRequestCategory]` -
-
+Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing` -**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +* `hris` - hris +* `ats` - ats +* `accounting` - accounting +* `ticketing` - ticketing +* `crm` - crm +* `mktg` - mktg +* `filestorage` - filestorage
@@ -6736,7 +6595,7 @@ client.ats.reject_reasons.list()
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**end_user_email_address:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given email address.
@@ -6744,7 +6603,7 @@ client.ats.reject_reasons.list()
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**end_user_organization_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given organization name.
@@ -6752,7 +6611,7 @@ client.ats.reject_reasons.list()
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**end_user_origin_id:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given origin ID.
@@ -6760,7 +6619,7 @@ client.ats.reject_reasons.list()
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**end_user_origin_ids:** `typing.Optional[str]` — Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once.
@@ -6768,7 +6627,7 @@ client.ats.reject_reasons.list()
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**id:** `typing.Optional[str]`
@@ -6776,7 +6635,7 @@ client.ats.reject_reasons.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**ids:** `typing.Optional[str]` — Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once.
@@ -6784,7 +6643,7 @@ client.ats.reject_reasons.list()
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**include_duplicates:** `typing.Optional[bool]` — If `true`, will include complete production duplicates of the account specified by the `id` query parameter in the response. `id` must be for a complete production linked account.
@@ -6792,70 +6651,15 @@ client.ats.reject_reasons.list()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**integration_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given integration name.
- -
- - - - -
- -
client.ats.reject_reasons.retrieve(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Returns a `RejectReason` object with the given `id`. -
-
-
-
- -#### 🔌 Usage
-
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ats.reject_reasons.retrieve( - id="id", -) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**id:** `str` +**is_test_account:** `typing.Optional[str]` — If included, will only include test linked accounts. If not included, will only include non-test linked accounts.
@@ -6863,7 +6667,7 @@ client.ats.reject_reasons.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -6871,7 +6675,7 @@ client.ats.reject_reasons.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**status:** `typing.Optional[str]` — Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED`
@@ -6891,8 +6695,8 @@ client.ats.reject_reasons.retrieve(
-## Ats Scorecards -
client.ats.scorecards.list(...) +## Crm Notes +
client.crm.notes.list(...)
@@ -6904,7 +6708,7 @@ client.ats.reject_reasons.retrieve(
-Returns a list of `Scorecard` objects. +Returns a list of `Note` objects.
@@ -6925,7 +6729,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.scorecards.list() +client.crm.notes.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -6941,7 +6747,15 @@ client.ats.scorecards.list()
-**application_id:** `typing.Optional[str]` — If provided, will only return scorecards for this application. +**account_id:** `typing.Optional[str]` — If provided, will only return notes with this account. + +
+
+ +
+
+ +**contact_id:** `typing.Optional[str]` — If provided, will only return notes with this contact.
@@ -6973,7 +6787,7 @@ client.ats.scorecards.list()
-**expand:** `typing.Optional[ScorecardsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[NotesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -6997,15 +6811,7 @@ client.ats.scorecards.list()
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
- -
-
- -**interview_id:** `typing.Optional[str]` — If provided, will only return scorecards for this interview. +**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -7013,7 +6819,7 @@ client.ats.scorecards.list()
-**interviewer_id:** `typing.Optional[str]` — If provided, will only return scorecards for this interviewer. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -7037,7 +6843,7 @@ client.ats.scorecards.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**opportunity_id:** `typing.Optional[str]` — If provided, will only return notes with this opportunity.
@@ -7045,7 +6851,7 @@ client.ats.scorecards.list()
-**remote_fields:** `typing.Optional[typing.Literal["overall_recommendation"]]` — Deprecated. Use show_enum_origins. +**owner_id:** `typing.Optional[str]` — If provided, will only return notes with this owner.
@@ -7053,7 +6859,7 @@ client.ats.scorecards.list()
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -7061,7 +6867,7 @@ client.ats.scorecards.list()
-**show_enum_origins:** `typing.Optional[typing.Literal["overall_recommendation"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -7081,7 +6887,7 @@ client.ats.scorecards.list()
-
client.ats.scorecards.retrieve(...) +
client.crm.notes.create(...)
@@ -7093,7 +6899,7 @@ client.ats.scorecards.list()
-Returns a `Scorecard` object with the given `id`. +Creates a `Note` object with the given values.
@@ -7109,13 +6915,14 @@ Returns a `Scorecard` object with the given `id`. ```python from merge import Merge +from merge.resources.crm import NoteRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.scorecards.retrieve( - id="id", +client.crm.notes.create( + model=NoteRequest(), ) ``` @@ -7132,31 +6939,7 @@ client.ats.scorecards.retrieve(
-**id:** `str` - -
-
- -
-
- -**expand:** `typing.Optional[ScorecardsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - -
-
- -
-
- -**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
- -
-
- -**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**model:** `NoteRequest`
@@ -7164,7 +6947,7 @@ client.ats.scorecards.retrieve(
-**remote_fields:** `typing.Optional[typing.Literal["overall_recommendation"]]` — Deprecated. Use show_enum_origins. +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -7172,7 +6955,7 @@ client.ats.scorecards.retrieve(
-**show_enum_origins:** `typing.Optional[typing.Literal["overall_recommendation"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -7192,8 +6975,7 @@ client.ats.scorecards.retrieve(
-## Ats SyncStatus -
client.ats.sync_status.list(...) +
client.crm.notes.retrieve(...)
@@ -7205,7 +6987,7 @@ client.ats.scorecards.retrieve(
-Get sync status for the current sync and the most recently finished sync. `last_sync_start` represents the most recent time any sync began. `last_sync_finished` represents the most recent time any sync completed. These timestamps may correspond to different sync instances which may result in a sync start time being later than a separate sync completed time. To ensure you are retrieving the latest available data reference the `last_sync_finished` timestamp where `last_sync_result` is `DONE`. Possible values for `status` and `last_sync_result` are `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses). +Returns a `Note` object with the given `id`.
@@ -7226,7 +7008,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.sync_status.list() +client.crm.notes.retrieve( + id="id", +) ``` @@ -7242,7 +7026,7 @@ client.ats.sync_status.list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**id:** `str`
@@ -7250,7 +7034,31 @@ client.ats.sync_status.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**expand:** `typing.Optional[NotesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
+ +
+
+ +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+ +
+
+ +**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. + +
+
+ +
+
+ +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -7270,8 +7078,7 @@ client.ats.sync_status.list()
-## Ats ForceResync -
client.ats.force_resync.sync_status_resync_create() +
client.crm.notes.meta_post_retrieve()
@@ -7283,7 +7090,7 @@ client.ats.sync_status.list()
-Force re-sync of all models. This endpoint is available for monthly, quarterly, and highest sync frequency customers on the Professional or Enterprise plans. Doing so will consume a sync credit for the relevant linked account. Force re-syncs can also be triggered manually in the Merge Dashboard and is available for all customers. +Returns metadata for `Note` POSTs.
@@ -7304,7 +7111,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.force_resync.sync_status_resync_create() +client.crm.notes.meta_post_retrieve() ``` @@ -7332,8 +7139,7 @@ client.ats.force_resync.sync_status_resync_create()
-## Ats Tags -
client.ats.tags.list(...) +
client.crm.notes.remote_field_classes_list(...)
@@ -7345,7 +7151,7 @@ client.ats.force_resync.sync_status_resync_create()
-Returns a list of `Tag` objects. +Returns a list of `RemoteFieldClass` objects.
@@ -7366,7 +7172,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.tags.list() +client.crm.notes.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -7382,22 +7190,6 @@ client.ats.tags.list()
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. - -
-
- -
-
- -**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. - -
-
- -
-
- **cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -7422,7 +7214,7 @@ client.ats.tags.list()
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -7430,7 +7222,7 @@ client.ats.tags.list()
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -7438,7 +7230,7 @@ client.ats.tags.list()
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
@@ -7446,7 +7238,7 @@ client.ats.tags.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value
@@ -7454,7 +7246,7 @@ client.ats.tags.list()
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -7474,8 +7266,8 @@ client.ats.tags.list()
-## Ats Users -
client.ats.users.list(...) +## Crm Opportunities +
client.crm.opportunities.list(...)
@@ -7487,7 +7279,7 @@ client.ats.tags.list()
-Returns a list of `RemoteUser` objects. +Returns a list of `Opportunity` objects.
@@ -7508,7 +7300,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.users.list() +client.crm.opportunities.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -7524,6 +7318,14 @@ client.ats.users.list()
+**account_id:** `typing.Optional[str]` — If provided, will only return opportunities with this account. + +
+
+ +
+
+ **created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -7548,7 +7350,7 @@ client.ats.users.list()
-**email:** `typing.Optional[str]` — If provided, will only return remote users with the given email address +**expand:** `typing.Optional[OpportunitiesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -7572,6 +7374,14 @@ client.ats.users.list()
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. + +
+
+ +
+
+ **include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -7596,6 +7406,14 @@ client.ats.users.list()
+**owner_id:** `typing.Optional[str]` — If provided, will only return opportunities with this owner. + +
+
+ +
+
+ **page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -7604,7 +7422,15 @@ client.ats.users.list()
-**remote_fields:** `typing.Optional[typing.Literal["access_role"]]` — Deprecated. Use show_enum_origins. +**remote_created_after:** `typing.Optional[dt.datetime]` — If provided, will only return opportunities created in the third party platform after this datetime. + +
+
+ +
+
+ +**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins.
@@ -7620,7 +7446,29 @@ client.ats.users.list()
-**show_enum_origins:** `typing.Optional[typing.Literal["access_role"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) +**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) + +
+
+ +
+
+ +**stage_id:** `typing.Optional[str]` — If provided, will only return opportunities with this stage. + +
+
+ +
+
+ +**status:** `typing.Optional[OpportunitiesListRequestStatus]` + +If provided, will only return opportunities with this status. Options: ('OPEN', 'WON', 'LOST') + +* `OPEN` - OPEN +* `WON` - WON +* `LOST` - LOST
@@ -7640,7 +7488,7 @@ client.ats.users.list()
-
client.ats.users.retrieve(...) +
client.crm.opportunities.create(...)
@@ -7652,7 +7500,7 @@ client.ats.users.list()
-Returns a `RemoteUser` object with the given `id`. +Creates an `Opportunity` object with the given values.
@@ -7668,12 +7516,100 @@ Returns a `RemoteUser` object with the given `id`. ```python from merge import Merge +from merge.resources.crm import OpportunityRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.users.retrieve( +client.crm.opportunities.create( + model=OpportunityRequest(), +) + +``` + +
+ + + +#### ⚙️ Parameters + +
+
+ +
+
+ +**model:** `OpportunityRequest` + +
+
+ +
+
+ +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. + +
+
+ +
+
+ +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + + + +
+ +
client.crm.opportunities.retrieve(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns an `Opportunity` object with the given `id`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.opportunities.retrieve( id="id", ) @@ -7699,7 +7635,7 @@ client.ats.users.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**expand:** `typing.Optional[OpportunitiesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -7707,7 +7643,7 @@ client.ats.users.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -7715,7 +7651,7 @@ client.ats.users.retrieve(
-**remote_fields:** `typing.Optional[typing.Literal["access_role"]]` — Deprecated. Use show_enum_origins. +**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -7723,7 +7659,7 @@ client.ats.users.retrieve(
-**show_enum_origins:** `typing.Optional[typing.Literal["access_role"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -7731,65 +7667,19 @@ client.ats.users.retrieve(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins.
-
-
- -
-
-
- -## Ats WebhookReceivers -
client.ats.webhook_receivers.list()
-#### 📝 Description - -
-
- -
-
- -Returns a list of `WebhookReceiver` objects. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ats.webhook_receivers.list() - -``` -
-
+**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) +
-#### ⚙️ Parameters - -
-
-
@@ -7805,7 +7695,7 @@ client.ats.webhook_receivers.list()
-
client.ats.webhook_receivers.create(...) +
client.crm.opportunities.partial_update(...)
@@ -7817,7 +7707,7 @@ client.ats.webhook_receivers.list()
-Creates a `WebhookReceiver` object with the given values. +Updates an `Opportunity` object with the given `id`.
@@ -7833,14 +7723,15 @@ Creates a `WebhookReceiver` object with the given values. ```python from merge import Merge +from merge.resources.crm import PatchedOpportunityRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.webhook_receivers.create( - event="event", - is_active=True, +client.crm.opportunities.partial_update( + id="id", + model=PatchedOpportunityRequest(), ) ``` @@ -7857,7 +7748,7 @@ client.ats.webhook_receivers.create(
-**event:** `str` +**id:** `str`
@@ -7865,7 +7756,7 @@ client.ats.webhook_receivers.create(
-**is_active:** `bool` +**model:** `PatchedOpportunityRequest`
@@ -7873,7 +7764,15 @@ client.ats.webhook_receivers.create(
-**key:** `typing.Optional[str]` +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. + +
+
+ +
+
+ +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -7893,8 +7792,7 @@ client.ats.webhook_receivers.create(
-## Crm AccountDetails -
client.crm.account_details.retrieve() +
client.crm.opportunities.meta_patch_retrieve(...)
@@ -7906,7 +7804,7 @@ client.ats.webhook_receivers.create(
-Get details for a linked account. +Returns metadata for `Opportunity` PATCHs.
@@ -7927,7 +7825,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.account_details.retrieve() +client.crm.opportunities.meta_patch_retrieve( + id="id", +) ``` @@ -7943,6 +7843,14 @@ client.crm.account_details.retrieve()
+**id:** `str` + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -7955,8 +7863,7 @@ client.crm.account_details.retrieve()
-## Crm AccountToken -
client.crm.account_token.retrieve(...) +
client.crm.opportunities.meta_post_retrieve()
@@ -7968,7 +7875,7 @@ client.crm.account_details.retrieve()
-Returns the account token for the end user with the provided public token. +Returns metadata for `Opportunity` POSTs.
@@ -7989,9 +7896,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.account_token.retrieve( - public_token="public_token", -) +client.crm.opportunities.meta_post_retrieve() ``` @@ -8007,14 +7912,6 @@ client.crm.account_token.retrieve(
-**public_token:** `str` - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -8027,8 +7924,7 @@ client.crm.account_token.retrieve(
-## Crm Accounts -
client.crm.accounts.list(...) +
client.crm.opportunities.remote_field_classes_list(...)
@@ -8040,7 +7936,7 @@ client.crm.account_token.retrieve(
-Returns a list of `Account` objects. +Returns a list of `RemoteFieldClass` objects.
@@ -8061,7 +7957,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.accounts.list() +client.crm.opportunities.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -8077,7 +7975,7 @@ client.crm.accounts.list()
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -8085,7 +7983,7 @@ client.crm.accounts.list()
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -8093,7 +7991,7 @@ client.crm.accounts.list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -8101,7 +7999,7 @@ client.crm.accounts.list()
-**expand:** `typing.Optional[typing.Literal["owner"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -8109,7 +8007,7 @@ client.crm.accounts.list()
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -8117,7 +8015,7 @@ client.crm.accounts.list()
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
@@ -8125,7 +8023,7 @@ client.crm.accounts.list()
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value
@@ -8133,7 +8031,7 @@ client.crm.accounts.list()
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -8141,47 +8039,75 @@ client.crm.accounts.list()
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. -
+
+## Crm Passthrough +
client.crm.passthrough.create(...)
-**name:** `typing.Optional[str]` — If provided, will only return accounts with this name. - -
-
+#### 📝 Description
-**owner_id:** `typing.Optional[str]` — If provided, will only return accounts with this owner. - +
+
+ +Pull data from an endpoint not currently supported by Merge. +
+
+#### 🔌 Usage +
-**page_size:** `typing.Optional[int]` — Number of results to return per page. - +
+
+ +```python +from merge import Merge +from merge.resources.crm import DataPassthroughRequest, MethodEnum + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.passthrough.create( + request=DataPassthroughRequest( + method=MethodEnum.GET, + path="/scooters", + ), +) + +```
+
+
+ +#### ⚙️ Parameters
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +
+
+ +**request:** `DataPassthroughRequest`
@@ -8201,7 +8127,8 @@ client.crm.accounts.list()
-
client.crm.accounts.create(...) +## Crm RegenerateKey +
client.crm.regenerate_key.create(...)
@@ -8213,7 +8140,7 @@ client.crm.accounts.list()
-Creates an `Account` object with the given values. +Exchange remote keys.
@@ -8229,14 +8156,13 @@ Creates an `Account` object with the given values. ```python from merge import Merge -from merge.resources.crm import AccountRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.accounts.create( - model=AccountRequest(), +client.crm.regenerate_key.create( + name="Remote Deployment Key 1", ) ``` @@ -8253,23 +8179,7 @@ client.crm.accounts.create(
-**model:** `AccountRequest` - -
-
- -
-
- -**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. - -
-
- -
-
- -**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**name:** `str` — The name of the remote key
@@ -8289,7 +8199,8 @@ client.crm.accounts.create(
-
client.crm.accounts.retrieve(...) +## Crm Stages +
client.crm.stages.list(...)
@@ -8301,7 +8212,7 @@ client.crm.accounts.create(
-Returns an `Account` object with the given `id`. +Returns a list of `Stage` objects.
@@ -8322,8 +8233,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.accounts.retrieve( - id="id", +client.crm.stages.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -8340,7 +8251,7 @@ client.crm.accounts.retrieve(
-**id:** `str` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -8348,7 +8259,23 @@ client.crm.accounts.retrieve(
-**expand:** `typing.Optional[typing.Literal["owner"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` — The pagination cursor value. + +
+
+ +
+
+ +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -8380,6 +8307,38 @@ client.crm.accounts.retrieve(
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. + +
+
+ +
+
+ +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. + +
+
+ +
+
+ +**page_size:** `typing.Optional[int]` — Number of results to return per page. + +
+
+ +
+
+ +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -8392,7 +8351,7 @@ client.crm.accounts.retrieve(
-
client.crm.accounts.partial_update(...) +
client.crm.stages.retrieve(...)
@@ -8404,7 +8363,7 @@ client.crm.accounts.retrieve(
-Updates an `Account` object with the given `id`. +Returns a `Stage` object with the given `id`.
@@ -8420,15 +8379,13 @@ Updates an `Account` object with the given `id`. ```python from merge import Merge -from merge.resources.crm import PatchedAccountRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.accounts.partial_update( +client.crm.stages.retrieve( id="id", - model=PatchedAccountRequest(), ) ``` @@ -8453,7 +8410,7 @@ client.crm.accounts.partial_update(
-**model:** `PatchedAccountRequest` +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -8461,7 +8418,7 @@ client.crm.accounts.partial_update(
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -8469,7 +8426,7 @@ client.crm.accounts.partial_update(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -8489,7 +8446,7 @@ client.crm.accounts.partial_update(
-
client.crm.accounts.meta_patch_retrieve(...) +
client.crm.stages.remote_field_classes_list(...)
@@ -8501,7 +8458,7 @@ client.crm.accounts.partial_update(
-Returns metadata for `CRMAccount` PATCHs. +Returns a list of `RemoteFieldClass` objects.
@@ -8522,8 +8479,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.accounts.meta_patch_retrieve( - id="id", +client.crm.stages.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -8540,7 +8497,7 @@ client.crm.accounts.meta_patch_retrieve(
-**id:** `str` +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -8548,64 +8505,59 @@ client.crm.accounts.meta_patch_retrieve(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
- -
+
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +
-
-
client.crm.accounts.meta_post_retrieve()
-#### 📝 Description - -
-
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. + +
+
-Returns metadata for `CRMAccount` POSTs. -
-
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +
-#### 🔌 Usage -
+**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value + +
+
+
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.accounts.meta_post_retrieve() - -``` -
-
+**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value + -#### ⚙️ Parameters -
+**page_size:** `typing.Optional[int]` — Number of results to return per page. + +
+
+
@@ -8621,7 +8573,8 @@ client.crm.accounts.meta_post_retrieve()
-
client.crm.accounts.remote_field_classes_list(...) +## Crm SyncStatus +
client.crm.sync_status.list(...)
@@ -8633,7 +8586,7 @@ client.crm.accounts.meta_post_retrieve()
-Returns a list of `RemoteFieldClass` objects. +Get sync status for the current sync and the most recently finished sync. `last_sync_start` represents the most recent time any sync began. `last_sync_finished` represents the most recent time any sync completed. These timestamps may correspond to different sync instances which may result in a sync start time being later than a separate sync completed time. To ensure you are retrieving the latest available data reference the `last_sync_finished` timestamp where `last_sync_result` is `DONE`. Possible values for `status` and `last_sync_result` are `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses).
@@ -8654,7 +8607,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.accounts.remote_field_classes_list() +client.crm.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -8678,54 +8633,6 @@ client.crm.accounts.remote_field_classes_list()
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). - -
-
- -
-
- -**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
- -
-
- -**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. - -
-
- -
-
- -**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
- -
-
- -**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value - -
-
- -
-
- -**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value - -
-
- -
-
- **page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -8746,8 +8653,8 @@ client.crm.accounts.remote_field_classes_list()
-## Crm AsyncPassthrough -
client.crm.async_passthrough.create(...) +## Crm ForceResync +
client.crm.force_resync.sync_status_resync_create()
@@ -8759,7 +8666,7 @@ client.crm.accounts.remote_field_classes_list()
-Asynchronously pull data from an endpoint not currently supported by Merge. +Force re-sync of all models. This endpoint is available for monthly, quarterly, and highest sync frequency customers on the Professional or Enterprise plans. Doing so will consume a sync credit for the relevant linked account. Force re-syncs can also be triggered manually in the Merge Dashboard and is available for all customers.
@@ -8775,18 +8682,12 @@ Asynchronously pull data from an endpoint not currently supported by Merge. ```python from merge import Merge -from merge.resources.crm import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.async_passthrough.create( - request=DataPassthroughRequest( - method=MethodEnum.GET, - path="/scooters", - ), -) +client.crm.force_resync.sync_status_resync_create() ``` @@ -8802,14 +8703,6 @@ client.crm.async_passthrough.create(
-**request:** `DataPassthroughRequest` - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -8822,7 +8715,8 @@ client.crm.async_passthrough.create(
-
client.crm.async_passthrough.retrieve(...) +## Crm Tasks +
client.crm.tasks.list(...)
@@ -8834,7 +8728,7 @@ client.crm.async_passthrough.create(
-Retrieves data from earlier async-passthrough POST request +Returns a list of `Task` objects.
@@ -8855,8 +8749,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.async_passthrough.retrieve( - async_passthrough_receipt_id="async_passthrough_receipt_id", +client.crm.tasks.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -8873,7 +8767,7 @@ client.crm.async_passthrough.retrieve(
-**async_passthrough_receipt_id:** `str` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -8881,69 +8775,47 @@ client.crm.async_passthrough.retrieve(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
- -
+
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value. +
-
-## Crm AuditTrail -
client.crm.audit_trail.list(...)
-#### 📝 Description - -
-
+**expand:** `typing.Optional[TasksListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
-Gets a list of audit trail events. -
-
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +
-#### 🔌 Usage -
-
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.audit_trail.list() - -``` -
-
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +
-#### ⚙️ Parameters -
-
-
- -**cursor:** `typing.Optional[str]` — The pagination cursor value. +**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -8951,7 +8823,7 @@ client.crm.audit_trail.list()
-**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -8959,7 +8831,7 @@ client.crm.audit_trail.list()
-**event_type:** `typing.Optional[str]` — If included, will only include events with the given event type. Possible values include: `CREATED_REMOTE_PRODUCTION_API_KEY`, `DELETED_REMOTE_PRODUCTION_API_KEY`, `CREATED_TEST_API_KEY`, `DELETED_TEST_API_KEY`, `REGENERATED_PRODUCTION_API_KEY`, `REGENERATED_WEBHOOK_SIGNATURE`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_LINKED_ACCOUNT`, `DELETED_ALL_COMMON_MODELS_FOR_LINKED_ACCOUNT`, `CREATED_DESTINATION`, `DELETED_DESTINATION`, `CHANGED_DESTINATION`, `CHANGED_SCOPES`, `CHANGED_PERSONAL_INFORMATION`, `CHANGED_ORGANIZATION_SETTINGS`, `ENABLED_INTEGRATION`, `DISABLED_INTEGRATION`, `ENABLED_CATEGORY`, `DISABLED_CATEGORY`, `CHANGED_PASSWORD`, `RESET_PASSWORD`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `CREATED_INTEGRATION_WIDE_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_FIELD_MAPPING`, `CHANGED_INTEGRATION_WIDE_FIELD_MAPPING`, `CHANGED_LINKED_ACCOUNT_FIELD_MAPPING`, `DELETED_INTEGRATION_WIDE_FIELD_MAPPING`, `DELETED_LINKED_ACCOUNT_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `FORCED_LINKED_ACCOUNT_RESYNC`, `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`, `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`, `END_USER_CREDENTIALS_ACCESSED` +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -8967,7 +8839,7 @@ client.crm.audit_trail.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -8975,7 +8847,7 @@ client.crm.audit_trail.list()
-**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -8983,7 +8855,7 @@ client.crm.audit_trail.list()
-**user_email:** `typing.Optional[str]` — If provided, this will return events associated with the specified user email. Please note that the email address reflects the user's email at the time of the event, and may not be their current email. +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -9003,8 +8875,7 @@ client.crm.audit_trail.list()
-## Crm AvailableActions -
client.crm.available_actions.retrieve() +
client.crm.tasks.create(...)
@@ -9016,7 +8887,7 @@ client.crm.audit_trail.list()
-Returns a list of models and actions available for an account. +Creates a `Task` object with the given values.
@@ -9032,12 +8903,15 @@ Returns a list of models and actions available for an account. ```python from merge import Merge +from merge.resources.crm import TaskRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.available_actions.retrieve() +client.crm.tasks.create( + model=TaskRequest(), +) ``` @@ -9053,6 +8927,30 @@ client.crm.available_actions.retrieve()
+**model:** `TaskRequest` + +
+
+ +
+
+ +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. + +
+
+ +
+
+ +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -9065,8 +8963,7 @@ client.crm.available_actions.retrieve()
-## Crm Contacts -
client.crm.contacts.list(...) +
client.crm.tasks.retrieve(...)
@@ -9078,7 +8975,7 @@ client.crm.available_actions.retrieve()
-Returns a list of `Contact` objects. +Returns a `Task` object with the given `id`.
@@ -9099,7 +8996,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.contacts.list() +client.crm.tasks.retrieve( + id="id", +) ``` @@ -9115,47 +9014,7 @@ client.crm.contacts.list()
-**account_id:** `typing.Optional[str]` — If provided, will only return contacts with this account. - -
-
- -
-
- -**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. - -
-
- -
-
- -**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. - -
-
- -
-
- -**cursor:** `typing.Optional[str]` — The pagination cursor value. - -
-
- -
-
- -**email_addresses:** `typing.Optional[str]` — If provided, will only return contacts matching the email addresses; multiple email_addresses can be separated by commas. - -
-
- -
-
- -**expand:** `typing.Optional[ContactsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**id:** `str`
@@ -9163,7 +9022,7 @@ client.crm.contacts.list()
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**expand:** `typing.Optional[TasksRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -9195,46 +9054,6 @@ client.crm.contacts.list()
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. - -
-
- -
-
- -**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. - -
-
- -
-
- -**page_size:** `typing.Optional[int]` — Number of results to return per page. - -
-
- -
-
- -**phone_numbers:** `typing.Optional[str]` — If provided, will only return contacts matching the phone numbers; multiple phone numbers can be separated by commas. - -
-
- -
-
- -**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -9247,7 +9066,7 @@ client.crm.contacts.list()
-
client.crm.contacts.create(...) +
client.crm.tasks.partial_update(...)
@@ -9259,7 +9078,7 @@ client.crm.contacts.list()
-Creates a `Contact` object with the given values. +Updates a `Task` object with the given `id`.
@@ -9275,14 +9094,15 @@ Creates a `Contact` object with the given values. ```python from merge import Merge -from merge.resources.crm import ContactRequest +from merge.resources.crm import PatchedTaskRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.contacts.create( - model=ContactRequest(), +client.crm.tasks.partial_update( + id="id", + model=PatchedTaskRequest(), ) ``` @@ -9299,7 +9119,15 @@ client.crm.contacts.create(
-**model:** `ContactRequest` +**id:** `str` + +
+
+ +
+
+ +**model:** `PatchedTaskRequest`
@@ -9335,7 +9163,7 @@ client.crm.contacts.create(
-
client.crm.contacts.retrieve(...) +
client.crm.tasks.meta_patch_retrieve(...)
@@ -9347,7 +9175,7 @@ client.crm.contacts.create(
-Returns a `Contact` object with the given `id`. +Returns metadata for `Task` PATCHs.
@@ -9368,7 +9196,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.contacts.retrieve( +client.crm.tasks.meta_patch_retrieve( id="id", ) @@ -9394,35 +9222,64 @@ client.crm.contacts.retrieve(
-**expand:** `typing.Optional[ContactsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. -
+
+
client.crm.tasks.meta_post_retrieve()
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. - +#### 📝 Description + +
+
+ +
+
+ +Returns metadata for `Task` POSTs.
+
+
+ +#### 🔌 Usage
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.tasks.meta_post_retrieve() + +``` +
+
+#### ⚙️ Parameters + +
+
+
@@ -9438,7 +9295,7 @@ client.crm.contacts.retrieve(
-
client.crm.contacts.partial_update(...) +
client.crm.tasks.remote_field_classes_list(...)
@@ -9450,7 +9307,7 @@ client.crm.contacts.retrieve(
-Updates a `Contact` object with the given `id`. +Returns a list of `RemoteFieldClass` objects.
@@ -9466,15 +9323,13 @@ Updates a `Contact` object with the given `id`. ```python from merge import Merge -from merge.resources.crm import PatchedContactRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.contacts.partial_update( - id="id", - model=PatchedContactRequest(), +client.crm.tasks.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -9491,7 +9346,7 @@ client.crm.contacts.partial_update(
-**id:** `str` +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -9499,7 +9354,7 @@ client.crm.contacts.partial_update(
-**model:** `PatchedContactRequest` +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -9507,7 +9362,7 @@ client.crm.contacts.partial_update(
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -9515,7 +9370,7 @@ client.crm.contacts.partial_update(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -9523,74 +9378,23 @@ client.crm.contacts.partial_update(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
- -
- - - - -
- -
client.crm.contacts.ignore_create(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Ignores a specific row based on the `model_id` in the url. These records will have their properties set to null, and will not be updated in future syncs. The "reason" and "message" fields in the request body will be stored for audit purposes. -
-
-
-
- -#### 🔌 Usage
-
-
- -```python -from merge import Merge -from merge.resources.crm import IgnoreCommonModelRequest, ReasonEnum - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.contacts.ignore_create( - model_id="model_id", - request=IgnoreCommonModelRequest( - reason=ReasonEnum.GENERAL_CUSTOMER_REQUEST, - ), -) - -``` -
-
+**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value +
-#### ⚙️ Parameters - -
-
-
-**model_id:** `str` +**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value
@@ -9598,7 +9402,7 @@ client.crm.contacts.ignore_create(
-**request:** `IgnoreCommonModelRequest` +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -9618,7 +9422,8 @@ client.crm.contacts.ignore_create(
-
client.crm.contacts.meta_patch_retrieve(...) +## Crm Users +
client.crm.users.list(...)
@@ -9630,7 +9435,7 @@ client.crm.contacts.ignore_create(
-Returns metadata for `CRMContact` PATCHs. +Returns a list of `User` objects.
@@ -9651,8 +9456,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.contacts.meta_patch_retrieve( - id="id", +client.crm.users.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -9669,7 +9474,7 @@ client.crm.contacts.meta_patch_retrieve(
-**id:** `str` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -9677,64 +9482,91 @@ client.crm.contacts.meta_patch_retrieve(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
- -
+
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value. +
-
-
client.crm.contacts.meta_post_retrieve()
-#### 📝 Description +**email:** `typing.Optional[str]` — If provided, will only return users with this email. + +
+
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). + +
+
+
-Returns metadata for `CRMContact` POSTs. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +
+ +
+
+ +**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +
-#### 🔌 Usage -
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
+
-```python -from merge import Merge +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. + +
+
-client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.contacts.meta_post_retrieve() +
+
-``` +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +
+ +
+
+ +**page_size:** `typing.Optional[int]` — Number of results to return per page. +
-#### ⚙️ Parameters -
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. + +
+
+
@@ -9750,7 +9582,7 @@ client.crm.contacts.meta_post_retrieve()
-
client.crm.contacts.remote_field_classes_list(...) +
client.crm.users.retrieve(...)
@@ -9762,7 +9594,7 @@ client.crm.contacts.meta_post_retrieve()
-Returns a list of `RemoteFieldClass` objects. +Returns a `User` object with the given `id`.
@@ -9783,7 +9615,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.contacts.remote_field_classes_list() +client.crm.users.retrieve( + id="id", +) ``` @@ -9799,15 +9633,7 @@ client.crm.contacts.remote_field_classes_list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. - -
-
- -
-
- -**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**id:** `str`
@@ -9839,15 +9665,74 @@ client.crm.contacts.remote_field_classes_list()
-**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
+ + + +
+ +
client.crm.users.ignore_create(...)
-**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value +#### 📝 Description + +
+
+ +
+
+ +Ignores a specific row based on the `model_id` in the url. These records will have their properties set to null, and will not be updated in future syncs. The "reason" and "message" fields in the request body will be stored for audit purposes. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from merge import Merge +from merge.resources.crm import IgnoreCommonModelRequest, ReasonEnum + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.users.ignore_create( + model_id="model_id", + request=IgnoreCommonModelRequest( + reason=ReasonEnum.GENERAL_CUSTOMER_REQUEST, + ), +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**model_id:** `str`
@@ -9855,7 +9740,7 @@ client.crm.contacts.remote_field_classes_list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**request:** `IgnoreCommonModelRequest`
@@ -9875,8 +9760,7 @@ client.crm.contacts.remote_field_classes_list()
-## Crm CustomObjectClasses -
client.crm.custom_object_classes.list(...) +
client.crm.users.remote_field_classes_list(...)
@@ -9888,7 +9772,7 @@ client.crm.contacts.remote_field_classes_list()
-Returns a list of `CustomObjectClass` objects. +Returns a list of `RemoteFieldClass` objects.
@@ -9909,7 +9793,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.custom_object_classes.list() +client.crm.users.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -9925,22 +9811,6 @@ client.crm.custom_object_classes.list()
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. - -
-
- -
-
- -**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. - -
-
- -
-
- **cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -9949,14 +9819,6 @@ client.crm.custom_object_classes.list()
-**expand:** `typing.Optional[typing.Literal["fields"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - -
-
- -
-
- **include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -9973,7 +9835,7 @@ client.crm.custom_object_classes.list()
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -9981,7 +9843,7 @@ client.crm.custom_object_classes.list()
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -9989,7 +9851,7 @@ client.crm.custom_object_classes.list()
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
@@ -9997,7 +9859,7 @@ client.crm.custom_object_classes.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value
@@ -10005,7 +9867,7 @@ client.crm.custom_object_classes.list()
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -10025,7 +9887,8 @@ client.crm.custom_object_classes.list()
-
client.crm.custom_object_classes.retrieve(...) +## Crm WebhookReceivers +
client.crm.webhook_receivers.list()
@@ -10037,7 +9900,7 @@ client.crm.custom_object_classes.list()
-Returns a `CustomObjectClass` object with the given `id`. +Returns a list of `WebhookReceiver` objects.
@@ -10058,9 +9921,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.custom_object_classes.retrieve( - id="id", -) +client.crm.webhook_receivers.list() ``` @@ -10076,38 +9937,6 @@ client.crm.custom_object_classes.retrieve(
-**id:** `str` - -
-
- -
-
- -**expand:** `typing.Optional[typing.Literal["fields"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - -
-
- -
-
- -**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
- -
-
- -**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -10120,8 +9949,7 @@ client.crm.custom_object_classes.retrieve(
-## Crm AssociationTypes -
client.crm.association_types.custom_object_classes_association_types_list(...) +
client.crm.webhook_receivers.create(...)
@@ -10133,7 +9961,7 @@ client.crm.custom_object_classes.retrieve(
-Returns a list of `AssociationType` objects. +Creates a `WebhookReceiver` object with the given values.
@@ -10154,8 +9982,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.association_types.custom_object_classes_association_types_list( - custom_object_class_id="custom_object_class_id", +client.crm.webhook_receivers.create( + event="event", + is_active=True, ) ``` @@ -10172,7 +10001,7 @@ client.crm.association_types.custom_object_classes_association_types_list(
-**custom_object_class_id:** `str` +**event:** `str`
@@ -10180,7 +10009,7 @@ client.crm.association_types.custom_object_classes_association_types_list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**is_active:** `bool`
@@ -10188,7 +10017,7 @@ client.crm.association_types.custom_object_classes_association_types_list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**key:** `typing.Optional[str]`
@@ -10196,75 +10025,65 @@ client.crm.association_types.custom_object_classes_association_types_list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
- -
-
- -**expand:** `typing.Optional[typing.Literal["target_object_classes"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. -
-
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). -
+
+## Filestorage AccountDetails +
client.filestorage.account_details.retrieve()
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
+#### 📝 Description
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. - +Get details for a linked account. +
+
+#### 🔌 Usage +
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. - -
-
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. - +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.filestorage.account_details.retrieve() + +``` +
+
+#### ⚙️ Parameters +
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. - -
-
-
@@ -10280,7 +10099,8 @@ client.crm.association_types.custom_object_classes_association_types_list(
-
client.crm.association_types.custom_object_classes_association_types_create(...) +## Filestorage AccountToken +
client.filestorage.account_token.retrieve(...)
@@ -10292,7 +10112,7 @@ client.crm.association_types.custom_object_classes_association_types_list(
-Creates an `AssociationType` object with the given values. +Returns the account token for the end user with the provided public token.
@@ -10308,31 +10128,13 @@ Creates an `AssociationType` object with the given values. ```python from merge import Merge -from merge.resources.crm import ( - AssociationTypeRequestRequest, - ObjectClassDescriptionRequest, - OriginTypeEnum, -) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.association_types.custom_object_classes_association_types_create( - custom_object_class_id="custom_object_class_id", - model=AssociationTypeRequestRequest( - source_object_class=ObjectClassDescriptionRequest( - id="id", - origin_type=OriginTypeEnum.CUSTOM_OBJECT, - ), - target_object_classes=[ - ObjectClassDescriptionRequest( - id="id", - origin_type=OriginTypeEnum.CUSTOM_OBJECT, - ) - ], - remote_key_name="remote_key_name", - ), +client.filestorage.account_token.retrieve( + public_token="public_token", ) ``` @@ -10349,31 +10151,7 @@ client.crm.association_types.custom_object_classes_association_types_create(
-**custom_object_class_id:** `str` - -
-
- -
-
- -**model:** `AssociationTypeRequestRequest` - -
-
- -
-
- -**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. - -
-
- -
-
- -**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**public_token:** `str`
@@ -10393,7 +10171,8 @@ client.crm.association_types.custom_object_classes_association_types_create(
-
client.crm.association_types.custom_object_classes_association_types_retrieve(...) +## Filestorage AsyncPassthrough +
client.filestorage.async_passthrough.create(...)
@@ -10405,7 +10184,7 @@ client.crm.association_types.custom_object_classes_association_types_create(
-Returns an `AssociationType` object with the given `id`. +Asynchronously pull data from an endpoint not currently supported by Merge.
@@ -10421,14 +10200,17 @@ Returns an `AssociationType` object with the given `id`. ```python from merge import Merge +from merge.resources.filestorage import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.association_types.custom_object_classes_association_types_retrieve( - custom_object_class_id="custom_object_class_id", - id="id", +client.filestorage.async_passthrough.create( + request=DataPassthroughRequest( + method=MethodEnum.GET, + path="/scooters", + ), ) ``` @@ -10445,39 +10227,7 @@ client.crm.association_types.custom_object_classes_association_types_retrieve(
-**custom_object_class_id:** `str` - -
-
- -
-
- -**id:** `str` - -
-
- -
-
- -**expand:** `typing.Optional[typing.Literal["target_object_classes"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - -
-
- -
-
- -**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
- -
-
- -**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**request:** `DataPassthroughRequest`
@@ -10497,7 +10247,7 @@ client.crm.association_types.custom_object_classes_association_types_retrieve(
-
client.crm.association_types.custom_object_classes_association_types_meta_post_retrieve(...) +
client.filestorage.async_passthrough.retrieve(...)
@@ -10509,7 +10259,7 @@ client.crm.association_types.custom_object_classes_association_types_retrieve(
-Returns metadata for `CRMAssociationType` POSTs. +Retrieves data from earlier async-passthrough POST request
@@ -10530,8 +10280,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.association_types.custom_object_classes_association_types_meta_post_retrieve( - custom_object_class_id="custom_object_class_id", +client.filestorage.async_passthrough.retrieve( + async_passthrough_receipt_id="async_passthrough_receipt_id", ) ``` @@ -10548,7 +10298,7 @@ client.crm.association_types.custom_object_classes_association_types_meta_post_r
-**custom_object_class_id:** `str` +**async_passthrough_receipt_id:** `str`
@@ -10568,8 +10318,8 @@ client.crm.association_types.custom_object_classes_association_types_meta_post_r
-## Crm CustomObjects -
client.crm.custom_objects.custom_object_classes_custom_objects_list(...) +## Filestorage AuditTrail +
client.filestorage.audit_trail.list(...)
@@ -10581,7 +10331,7 @@ client.crm.association_types.custom_object_classes_association_types_meta_post_r
-Returns a list of `CustomObject` objects. +Gets a list of audit trail events.
@@ -10602,8 +10352,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.custom_objects.custom_object_classes_custom_objects_list( - custom_object_class_id="custom_object_class_id", +client.filestorage.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -10620,30 +10370,6 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-**custom_object_class_id:** `str` - -
-
- -
-
- -**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. - -
-
- -
-
- -**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. - -
-
- -
-
- **cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -10652,31 +10378,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). - -
-
- -
-
- -**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
- -
-
- -**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. - -
-
- -
-
- -**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time
@@ -10684,7 +10386,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**event_type:** `typing.Optional[str]` — If included, will only include events with the given event type. Possible values include: `CREATED_REMOTE_PRODUCTION_API_KEY`, `DELETED_REMOTE_PRODUCTION_API_KEY`, `CREATED_TEST_API_KEY`, `DELETED_TEST_API_KEY`, `REGENERATED_PRODUCTION_API_KEY`, `REGENERATED_WEBHOOK_SIGNATURE`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_LINKED_ACCOUNT`, `DELETED_ALL_COMMON_MODELS_FOR_LINKED_ACCOUNT`, `CREATED_DESTINATION`, `DELETED_DESTINATION`, `CHANGED_DESTINATION`, `CHANGED_SCOPES`, `CHANGED_PERSONAL_INFORMATION`, `CHANGED_ORGANIZATION_SETTINGS`, `ENABLED_INTEGRATION`, `DISABLED_INTEGRATION`, `ENABLED_CATEGORY`, `DISABLED_CATEGORY`, `CHANGED_PASSWORD`, `RESET_PASSWORD`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `CREATED_INTEGRATION_WIDE_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_FIELD_MAPPING`, `CHANGED_INTEGRATION_WIDE_FIELD_MAPPING`, `CHANGED_LINKED_ACCOUNT_FIELD_MAPPING`, `DELETED_INTEGRATION_WIDE_FIELD_MAPPING`, `DELETED_LINKED_ACCOUNT_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `FORCED_LINKED_ACCOUNT_RESYNC`, `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`, `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`, `END_USER_CREDENTIALS_ACCESSED`
@@ -10692,7 +10394,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -10700,7 +10402,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time
@@ -10708,7 +10410,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**user_email:** `typing.Optional[str]` — If provided, this will return events associated with the specified user email. Please note that the email address reflects the user's email at the time of the event, and may not be their current email.
@@ -10728,7 +10430,8 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-
client.crm.custom_objects.custom_object_classes_custom_objects_create(...) +## Filestorage AvailableActions +
client.filestorage.available_actions.retrieve()
@@ -10740,7 +10443,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-Creates a `CustomObject` object with the given values. +Returns a list of models and actions available for an account.
@@ -10756,18 +10459,12 @@ Creates a `CustomObject` object with the given values. ```python from merge import Merge -from merge.resources.crm import CustomObjectRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.custom_objects.custom_object_classes_custom_objects_create( - custom_object_class_id="custom_object_class_id", - model=CustomObjectRequest( - fields={"test_field": "hello"}, - ), -) +client.filestorage.available_actions.retrieve() ``` @@ -10783,38 +10480,6 @@ client.crm.custom_objects.custom_object_classes_custom_objects_create(
-**custom_object_class_id:** `str` - -
-
- -
-
- -**model:** `CustomObjectRequest` - -
-
- -
-
- -**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. - -
-
- -
-
- -**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -10827,7 +10492,8 @@ client.crm.custom_objects.custom_object_classes_custom_objects_create(
-
client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(...) +## Filestorage Scopes +
client.filestorage.scopes.default_scopes_retrieve()
@@ -10839,7 +10505,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_create(
-Returns a `CustomObject` object with the given `id`. +Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
@@ -10860,10 +10526,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.custom_objects.custom_object_classes_custom_objects_retrieve( - custom_object_class_id="custom_object_class_id", - id="id", -) +client.filestorage.scopes.default_scopes_retrieve() ``` @@ -10879,46 +10542,6 @@ client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(
-**custom_object_class_id:** `str` - -
-
- -
-
- -**id:** `str` - -
-
- -
-
- -**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
- -
-
- -**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. - -
-
- -
-
- -**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -10931,7 +10554,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(
-
client.crm.custom_objects.custom_object_classes_custom_objects_meta_post_retrieve(...) +
client.filestorage.scopes.linked_account_scopes_retrieve()
@@ -10943,7 +10566,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(
-Returns metadata for `CRMCustomObject` POSTs. +Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
@@ -10964,9 +10587,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.custom_objects.custom_object_classes_custom_objects_meta_post_retrieve( - custom_object_class_id="custom_object_class_id", -) +client.filestorage.scopes.linked_account_scopes_retrieve() ``` @@ -10982,14 +10603,6 @@ client.crm.custom_objects.custom_object_classes_custom_objects_meta_post_retriev
-**custom_object_class_id:** `str` - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -11002,7 +10615,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_meta_post_retriev
-
client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_classes_list(...) +
client.filestorage.scopes.linked_account_scopes_create(...)
@@ -11014,7 +10627,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_meta_post_retriev
-Returns a list of `RemoteFieldClass` objects. +Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes)
@@ -11030,12 +10643,43 @@ Returns a list of `RemoteFieldClass` objects. ```python from merge import Merge +from merge.resources.filestorage import ( + FieldPermissionDeserializerRequest, + IndividualCommonModelScopeDeserializerRequest, + ModelPermissionDeserializerRequest, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_classes_list() +client.filestorage.scopes.linked_account_scopes_create( + common_models=[ + IndividualCommonModelScopeDeserializerRequest( + model_name="Employee", + model_permissions={ + "READ": ModelPermissionDeserializerRequest( + is_enabled=True, + ), + "WRITE": ModelPermissionDeserializerRequest( + is_enabled=False, + ), + }, + field_permissions=FieldPermissionDeserializerRequest( + enabled_fields=["avatar", "home_location"], + disabled_fields=["work_location"], + ), + ), + IndividualCommonModelScopeDeserializerRequest( + model_name="Benefit", + model_permissions={ + "WRITE": ModelPermissionDeserializerRequest( + is_enabled=False, + ) + }, + ), + ], +) ``` @@ -11051,7 +10695,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for
@@ -11059,59 +10703,65 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. -
+
+## Filestorage DeleteAccount +
client.filestorage.delete_account.delete()
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. - -
-
+#### 📝 Description
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
-
-**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value - +Delete a linked account.
+ + + +#### 🔌 Usage
-**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value - -
-
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. - +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.filestorage.delete_account.delete() + +``` +
+
+#### ⚙️ Parameters + +
+
+
@@ -11127,8 +10777,8 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
-## Crm Associations -
client.crm.associations.custom_object_classes_custom_objects_associations_list(...) +## Filestorage Drives +
client.filestorage.drives.list(...)
@@ -11140,7 +10790,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
-Returns a list of `Association` objects. +Returns a list of `Drive` objects.
@@ -11161,9 +10811,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.associations.custom_object_classes_custom_objects_associations_list( - custom_object_class_id="custom_object_class_id", - object_id="object_id", +client.filestorage.drives.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -11180,30 +10829,6 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-**custom_object_class_id:** `str` - -
-
- -
-
- -**object_id:** `str` - -
-
- -
-
- -**association_type_id:** `typing.Optional[str]` — If provided, will only return opportunities with this association_type. - -
-
- -
-
- **created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -11228,7 +10853,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-**expand:** `typing.Optional[typing.Literal["association_type"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -11236,7 +10861,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -11244,7 +10869,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -11252,7 +10877,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -11260,7 +10885,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -11268,7 +10893,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**name:** `typing.Optional[str]` — If provided, will only return drives with this name. This performs an exact match.
@@ -11304,7 +10929,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-
client.crm.associations.custom_object_classes_custom_objects_associations_update(...) +
client.filestorage.drives.retrieve(...)
@@ -11316,7 +10941,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-Creates an Association between `source_object_id` and `target_object_id` of type `association_type_id`. +Returns a `Drive` object with the given `id`.
@@ -11337,12 +10962,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.associations.custom_object_classes_custom_objects_associations_update( - association_type_id="association_type_id", - source_class_id="source_class_id", - source_object_id="source_object_id", - target_class_id="target_class_id", - target_object_id="target_object_id", +client.filestorage.drives.retrieve( + id="id", ) ``` @@ -11359,39 +10980,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_update
-**association_type_id:** `str` - -
-
- -
-
- -**source_class_id:** `str` - -
-
- -
-
- -**source_object_id:** `str` - -
-
- -
-
- -**target_class_id:** `str` - -
-
- -
-
- -**target_object_id:** `str` +**id:** `str`
@@ -11399,7 +10988,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_update
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -11407,7 +10996,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_update
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -11427,8 +11016,8 @@ client.crm.associations.custom_object_classes_custom_objects_associations_update
-## Crm Scopes -
client.crm.scopes.default_scopes_retrieve() +## Filestorage FieldMapping +
client.filestorage.field_mapping.field_mappings_retrieve(...)
@@ -11440,7 +11029,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_update
-Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes). +Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
@@ -11461,7 +11050,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.scopes.default_scopes_retrieve() +client.filestorage.field_mapping.field_mappings_retrieve() ``` @@ -11477,6 +11066,14 @@ client.crm.scopes.default_scopes_retrieve()
+**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -11489,7 +11086,7 @@ client.crm.scopes.default_scopes_retrieve()
-
client.crm.scopes.linked_account_scopes_retrieve() +
client.filestorage.field_mapping.field_mappings_create(...)
@@ -11501,7 +11098,7 @@ client.crm.scopes.default_scopes_retrieve()
-Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes). +Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
@@ -11522,7 +11119,14 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.scopes.linked_account_scopes_retrieve() +client.filestorage.field_mapping.field_mappings_create( + target_field_name="example_target_field_name", + target_field_description="this is a example description of the target field", + remote_field_traversal_path=["example_remote_field"], + remote_method="GET", + remote_url_path="/example-url-path", + common_model_name="ExampleCommonModel", +) ``` @@ -11538,99 +11142,55 @@ client.crm.scopes.linked_account_scopes_retrieve()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**target_field_name:** `str` — The name of the target field you want this remote field to map to.
- -
+
+
+**target_field_description:** `str` — The description of the target field you want this remote field to map to. +
-
-
client.crm.scopes.linked_account_scopes_create(...)
-#### 📝 Description - -
-
+**remote_field_traversal_path:** `typing.Sequence[typing.Optional[typing.Any]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint. + +
+
-Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes) -
-
+**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from. +
-#### 🔌 Usage -
-
-
- -```python -from merge import Merge -from merge.resources.crm import ( - FieldPermissionDeserializerRequest, - IndividualCommonModelScopeDeserializerRequest, - ModelPermissionDeserializerRequest, -) - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.scopes.linked_account_scopes_create( - common_models=[ - IndividualCommonModelScopeDeserializerRequest( - model_name="Employee", - model_permissions={ - "READ": ModelPermissionDeserializerRequest( - is_enabled=True, - ), - "WRITE": ModelPermissionDeserializerRequest( - is_enabled=False, - ), - }, - field_permissions=FieldPermissionDeserializerRequest( - enabled_fields=["avatar", "home_location"], - disabled_fields=["work_location"], - ), - ), - IndividualCommonModelScopeDeserializerRequest( - model_name="Benefit", - model_permissions={ - "WRITE": ModelPermissionDeserializerRequest( - is_enabled=False, - ) - }, - ), - ], -) - -``` -
-
+**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from. +
-#### ⚙️ Parameters -
+**common_model_name:** `str` — The name of the Common Model that the remote field corresponds to in a given category. + +
+
+
-**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for +**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations.
@@ -11650,8 +11210,7 @@ client.crm.scopes.linked_account_scopes_create(
-## Crm DeleteAccount -
client.crm.delete_account.delete() +
client.filestorage.field_mapping.field_mappings_destroy(...)
@@ -11663,7 +11222,7 @@ client.crm.scopes.linked_account_scopes_create(
-Delete a linked account. +Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
@@ -11684,7 +11243,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.delete_account.delete() +client.filestorage.field_mapping.field_mappings_destroy( + field_mapping_id="field_mapping_id", +) ``` @@ -11700,6 +11261,14 @@ client.crm.delete_account.delete()
+**field_mapping_id:** `str` + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -11712,8 +11281,7 @@ client.crm.delete_account.delete()
-## Crm EngagementTypes -
client.crm.engagement_types.list(...) +
client.filestorage.field_mapping.field_mappings_partial_update(...)
@@ -11725,7 +11293,7 @@ client.crm.delete_account.delete()
-Returns a list of `EngagementType` objects. +Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
@@ -11746,7 +11314,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.engagement_types.list() +client.filestorage.field_mapping.field_mappings_partial_update( + field_mapping_id="field_mapping_id", +) ``` @@ -11762,7 +11332,7 @@ client.crm.engagement_types.list()
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**field_mapping_id:** `str`
@@ -11770,7 +11340,7 @@ client.crm.engagement_types.list()
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**remote_field_traversal_path:** `typing.Optional[typing.Sequence[typing.Optional[typing.Any]]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
@@ -11778,7 +11348,7 @@ client.crm.engagement_types.list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**remote_method:** `typing.Optional[str]` — The method of the remote endpoint where the remote field is coming from.
@@ -11786,7 +11356,7 @@ client.crm.engagement_types.list()
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**remote_url_path:** `typing.Optional[str]` — The path of the remote endpoint where the remote field is coming from.
@@ -11794,47 +11364,68 @@ client.crm.engagement_types.list()
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. -
+
+
client.filestorage.field_mapping.remote_fields_retrieve(...)
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
+#### 📝 Description
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. - +
+
+ +Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/). +
+
+#### 🔌 Usage +
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.filestorage.field_mapping.remote_fields_retrieve() + +``` +
+
+#### ⚙️ Parameters +
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +
+
+ +**common_models:** `typing.Optional[str]` — A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models.
@@ -11842,7 +11433,7 @@ client.crm.engagement_types.list()
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**include_example_values:** `typing.Optional[str]` — If true, will include example values, where available, for remote fields in the 3rd party platform. These examples come from active data from your customers.
@@ -11862,7 +11453,7 @@ client.crm.engagement_types.list()
-
client.crm.engagement_types.retrieve(...) +
client.filestorage.field_mapping.target_fields_retrieve()
@@ -11874,7 +11465,7 @@ client.crm.engagement_types.list()
-Returns an `EngagementType` object with the given `id`. +Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields. Organization-wide Target Fields are additional fields appended to the Merge Common Model for all Linked Accounts in a category. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/target-fields/).
@@ -11895,9 +11486,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.engagement_types.retrieve( - id="id", -) +client.filestorage.field_mapping.target_fields_retrieve() ``` @@ -11913,38 +11502,6 @@ client.crm.engagement_types.retrieve(
-**id:** `str` - -
-
- -
-
- -**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
- -
-
- -**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. - -
-
- -
-
- -**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -11957,7 +11514,8 @@ client.crm.engagement_types.retrieve(
-
client.crm.engagement_types.remote_field_classes_list(...) +## Filestorage Files +
client.filestorage.files.list(...)
@@ -11969,7 +11527,7 @@ client.crm.engagement_types.retrieve(
-Returns a list of `RemoteFieldClass` objects. +Returns a list of `File` objects.
@@ -11990,7 +11548,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.engagement_types.remote_field_classes_list() +client.filestorage.files.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -12006,6 +11566,22 @@ client.crm.engagement_types.remote_field_classes_list()
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. + +
+
+ +
+
+ +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. + +
+
+ +
+
+ **cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -12014,6 +11590,30 @@ client.crm.engagement_types.remote_field_classes_list()
+**drive_id:** `typing.Optional[str]` — Specifying a drive id returns only the files in that drive. Specifying null returns only the files outside the top-level drive. + +
+
+ +
+
+ +**expand:** `typing.Optional[FilesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
+ +
+
+ +**folder_id:** `typing.Optional[str]` — Specifying a folder id returns only the files in that folder. Specifying null returns only the files in root directory. + +
+
+ +
+
+ **include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -12030,7 +11630,7 @@ client.crm.engagement_types.remote_field_classes_list()
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -12038,7 +11638,7 @@ client.crm.engagement_types.remote_field_classes_list()
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**mime_type:** `typing.Optional[str]` — If provided, will only return files with these mime_types. Multiple values can be separated by commas.
@@ -12046,7 +11646,7 @@ client.crm.engagement_types.remote_field_classes_list()
-**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -12054,7 +11654,7 @@ client.crm.engagement_types.remote_field_classes_list()
-**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -12062,7 +11662,7 @@ client.crm.engagement_types.remote_field_classes_list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**name:** `typing.Optional[str]` — If provided, will only return files with this name. This performs an exact match.
@@ -12070,157 +11670,95 @@ client.crm.engagement_types.remote_field_classes_list()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**order_by:** `typing.Optional[FilesListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: created_at, -created_at, modified_at, -modified_at.
- -
- - - -
-
- -## Crm Engagements -
client.crm.engagements.list(...) -
-
- -#### 📝 Description - -
-
-Returns a list of `Engagement` objects. -
-
+**page_size:** `typing.Optional[int]` — Number of results to return per page. +
-#### 🔌 Usage - -
-
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.engagements.list() - -``` -
-
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +
-#### ⚙️ Parameters - -
-
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
- -
-
- -**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. -
-
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value. -
+
+
client.filestorage.files.create(...)
-**expand:** `typing.Optional[EngagementsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - -
-
+#### 📝 Description
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). - -
-
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - +Creates a `File` object with the given values.
- -
-
- -**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. -
+#### 🔌 Usage +
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. - -
-
+```python +from merge import Merge +from merge.resources.filestorage import FileRequest -
-
+client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.filestorage.files.create( + model=FileRequest(), +) -**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. - +``` +
+
+#### ⚙️ Parameters +
-**page_size:** `typing.Optional[int]` — Number of results to return per page. - -
-
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**model:** `FileRequest`
@@ -12228,7 +11766,7 @@ client.crm.engagements.list()
-**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return engagements started after this datetime. +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -12236,7 +11774,7 @@ client.crm.engagements.list()
-**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return engagements started before this datetime. +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -12256,7 +11794,7 @@ client.crm.engagements.list()
-
client.crm.engagements.create(...) +
client.filestorage.files.retrieve(...)
@@ -12268,7 +11806,7 @@ client.crm.engagements.list()
-Creates an `Engagement` object with the given values. +Returns a `File` object with the given `id`.
@@ -12284,14 +11822,13 @@ Creates an `Engagement` object with the given values. ```python from merge import Merge -from merge.resources.crm import EngagementRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.engagements.create( - model=EngagementRequest(), +client.filestorage.files.retrieve( + id="id", ) ``` @@ -12308,7 +11845,7 @@ client.crm.engagements.create(
-**model:** `EngagementRequest` +**id:** `str`
@@ -12316,7 +11853,7 @@ client.crm.engagements.create(
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +**expand:** `typing.Optional[FilesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -12324,7 +11861,15 @@ client.crm.engagements.create(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+ +
+
+ +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -12344,7 +11889,7 @@ client.crm.engagements.create(
-
client.crm.engagements.retrieve(...) +
client.filestorage.files.download_request_meta_retrieve(...)
@@ -12356,7 +11901,7 @@ client.crm.engagements.create(
-Returns an `Engagement` object with the given `id`. +Returns metadata to construct an authenticated file download request for a singular file, allowing you to download file directly from the third-party.
@@ -12377,7 +11922,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.engagements.retrieve( +client.filestorage.files.download_request_meta_retrieve( id="id", ) @@ -12403,31 +11948,7 @@ client.crm.engagements.retrieve(
-**expand:** `typing.Optional[EngagementsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - -
-
- -
-
- -**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
- -
-
- -**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. - -
-
- -
-
- -**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**mime_type:** `typing.Optional[str]` — If provided, specifies the export format of the file to be downloaded. For information on supported export formats, please refer to our export format help center article.
@@ -12447,7 +11968,7 @@ client.crm.engagements.retrieve(
-
client.crm.engagements.partial_update(...) +
client.filestorage.files.download_request_meta_list(...)
@@ -12459,7 +11980,7 @@ client.crm.engagements.retrieve(
-Updates an `Engagement` object with the given `id`. +Returns metadata to construct authenticated file download requests, allowing you to download files directly from the third-party.
@@ -12475,15 +11996,13 @@ Updates an `Engagement` object with the given `id`. ```python from merge import Merge -from merge.resources.crm import PatchedEngagementRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.engagements.partial_update( - id="id", - model=PatchedEngagementRequest(), +client.filestorage.files.download_request_meta_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -12500,7 +12019,7 @@ client.crm.engagements.partial_update(
-**id:** `str` +**created_after:** `typing.Optional[str]` — If provided, will only return objects created after this datetime.
@@ -12508,7 +12027,7 @@ client.crm.engagements.partial_update(
-**model:** `PatchedEngagementRequest` +**created_before:** `typing.Optional[str]` — If provided, will only return objects created before this datetime.
@@ -12516,7 +12035,7 @@ client.crm.engagements.partial_update(
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -12524,7 +12043,7 @@ client.crm.engagements.partial_update(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -12532,70 +12051,39 @@ client.crm.engagements.partial_update(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**mime_types:** `typing.Optional[str]` — A comma-separated list of preferred MIME types in order of priority. If supported by the third-party provider, the file(s) will be returned in the first supported MIME type from the list. The default MIME type is PDF. To see supported MIME types by file type, refer to our export format help center article.
- -
- - - - -
-
client.crm.engagements.meta_patch_retrieve(...)
-#### 📝 Description - -
-
+**modified_after:** `typing.Optional[str]` — If provided, will only return objects modified after this datetime. + +
+
-Returns metadata for `Engagement` PATCHs. -
-
+**modified_before:** `typing.Optional[str]` — If provided, will only return objects modified before this datetime. +
-#### 🔌 Usage -
-
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.engagements.meta_patch_retrieve( - id="id", -) - -``` -
-
+**order_by:** `typing.Optional[FilesDownloadRequestMetaListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: created_at, -created_at, modified_at, -modified_at. +
-#### ⚙️ Parameters - -
-
-
-**id:** `str` +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -12615,7 +12103,7 @@ client.crm.engagements.meta_patch_retrieve(
-
client.crm.engagements.meta_post_retrieve() +
client.filestorage.files.meta_post_retrieve()
@@ -12627,7 +12115,7 @@ client.crm.engagements.meta_patch_retrieve(
-Returns metadata for `Engagement` POSTs. +Returns metadata for `FileStorageFile` POSTs.
@@ -12648,7 +12136,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.engagements.meta_post_retrieve() +client.filestorage.files.meta_post_retrieve() ``` @@ -12676,7 +12164,8 @@ client.crm.engagements.meta_post_retrieve()
-
client.crm.engagements.remote_field_classes_list(...) +## Filestorage Folders +
client.filestorage.folders.list(...)
@@ -12688,7 +12177,7 @@ client.crm.engagements.meta_post_retrieve()
-Returns a list of `RemoteFieldClass` objects. +Returns a list of `Folder` objects.
@@ -12709,7 +12198,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.engagements.remote_field_classes_list() +client.filestorage.folders.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -12725,6 +12216,22 @@ client.crm.engagements.remote_field_classes_list()
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. + +
+
+ +
+
+ +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. + +
+
+ +
+
+ **cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -12733,6 +12240,22 @@ client.crm.engagements.remote_field_classes_list()
+**drive_id:** `typing.Optional[str]` — If provided, will only return folders in this drive. + +
+
+ +
+
+ +**expand:** `typing.Optional[FoldersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
+ +
+
+ **include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -12749,7 +12272,7 @@ client.crm.engagements.remote_field_classes_list()
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -12757,7 +12280,7 @@ client.crm.engagements.remote_field_classes_list()
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -12765,7 +12288,7 @@ client.crm.engagements.remote_field_classes_list()
-**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -12773,7 +12296,7 @@ client.crm.engagements.remote_field_classes_list()
-**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value +**name:** `typing.Optional[str]` — If provided, will only return folders with this name. This performs an exact match.
@@ -12789,6 +12312,22 @@ client.crm.engagements.remote_field_classes_list()
+**parent_folder_id:** `typing.Optional[str]` — If provided, will only return folders in this parent folder. If null, will return folders in root directory. + +
+
+ +
+
+ +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -12801,8 +12340,7 @@ client.crm.engagements.remote_field_classes_list()
-## Crm FieldMapping -
client.crm.field_mapping.field_mappings_retrieve(...) +
client.filestorage.folders.create(...)
@@ -12814,7 +12352,7 @@ client.crm.engagements.remote_field_classes_list()
-Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/). +Creates a `Folder` object with the given values.
@@ -12830,12 +12368,15 @@ Get all Field Mappings for this Linked Account. Field Mappings are mappings betw ```python from merge import Merge +from merge.resources.filestorage import FolderRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.field_mapping.field_mappings_retrieve() +client.filestorage.folders.create( + model=FolderRequest(), +) ``` @@ -12851,7 +12392,23 @@ client.crm.field_mapping.field_mappings_retrieve()
-**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations. +**model:** `FolderRequest` + +
+
+ +
+
+ +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. + +
+
+ +
+
+ +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -12871,7 +12428,7 @@ client.crm.field_mapping.field_mappings_retrieve()
-
client.crm.field_mapping.field_mappings_create(...) +
client.filestorage.folders.retrieve(...)
@@ -12883,7 +12440,7 @@ client.crm.field_mapping.field_mappings_retrieve()
-Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start. +Returns a `Folder` object with the given `id`.
@@ -12904,13 +12461,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.field_mapping.field_mappings_create( - target_field_name="example_target_field_name", - target_field_description="this is a example description of the target field", - remote_field_traversal_path=["example_remote_field"], - remote_method="GET", - remote_url_path="/example-url-path", - common_model_name="ExampleCommonModel", +client.filestorage.folders.retrieve( + id="id", ) ``` @@ -12927,31 +12479,7 @@ client.crm.field_mapping.field_mappings_create(
-**target_field_name:** `str` — The name of the target field you want this remote field to map to. - -
-
- -
-
- -**target_field_description:** `str` — The description of the target field you want this remote field to map to. - -
-
- -
-
- -**remote_field_traversal_path:** `typing.Sequence[typing.Optional[typing.Any]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint. - -
-
- -
-
- -**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from. +**id:** `str`
@@ -12959,7 +12487,7 @@ client.crm.field_mapping.field_mappings_create(
-**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from. +**expand:** `typing.Optional[FoldersRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -12967,7 +12495,7 @@ client.crm.field_mapping.field_mappings_create(
-**common_model_name:** `str` — The name of the Common Model that the remote field corresponds to in a given category. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -12975,7 +12503,7 @@ client.crm.field_mapping.field_mappings_create(
-**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -12995,7 +12523,7 @@ client.crm.field_mapping.field_mappings_create(
-
client.crm.field_mapping.field_mappings_destroy(...) +
client.filestorage.folders.meta_post_retrieve()
@@ -13007,7 +12535,7 @@ client.crm.field_mapping.field_mappings_create(
-Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start. +Returns metadata for `FileStorageFolder` POSTs.
@@ -13028,9 +12556,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.field_mapping.field_mappings_destroy( - field_mapping_id="field_mapping_id", -) +client.filestorage.folders.meta_post_retrieve() ``` @@ -13046,14 +12572,6 @@ client.crm.field_mapping.field_mappings_destroy(
-**field_mapping_id:** `str` - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -13066,7 +12584,8 @@ client.crm.field_mapping.field_mappings_destroy(
-
client.crm.field_mapping.field_mappings_partial_update(...) +## Filestorage GenerateKey +
client.filestorage.generate_key.create(...)
@@ -13078,7 +12597,7 @@ client.crm.field_mapping.field_mappings_destroy(
-Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start. +Create a remote key.
@@ -13099,8 +12618,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.field_mapping.field_mappings_partial_update( - field_mapping_id="field_mapping_id", +client.filestorage.generate_key.create( + name="Remote Deployment Key 1", ) ``` @@ -13117,31 +12636,7 @@ client.crm.field_mapping.field_mappings_partial_update(
-**field_mapping_id:** `str` - -
-
- -
-
- -**remote_field_traversal_path:** `typing.Optional[typing.Sequence[typing.Optional[typing.Any]]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint. - -
-
- -
-
- -**remote_method:** `typing.Optional[str]` — The method of the remote endpoint where the remote field is coming from. - -
-
- -
-
- -**remote_url_path:** `typing.Optional[str]` — The path of the remote endpoint where the remote field is coming from. +**name:** `str` — The name of the remote key
@@ -13161,7 +12656,8 @@ client.crm.field_mapping.field_mappings_partial_update(
-
client.crm.field_mapping.remote_fields_retrieve(...) +## Filestorage Groups +
client.filestorage.groups.list(...)
@@ -13173,7 +12669,7 @@ client.crm.field_mapping.field_mappings_partial_update(
-Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/). +Returns a list of `Group` objects.
@@ -13194,7 +12690,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.field_mapping.remote_fields_retrieve() +client.filestorage.groups.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -13210,7 +12708,7 @@ client.crm.field_mapping.remote_fields_retrieve()
-**common_models:** `typing.Optional[str]` — A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models. +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -13218,7 +12716,7 @@ client.crm.field_mapping.remote_fields_retrieve()
-**include_example_values:** `typing.Optional[str]` — If true, will include example values, where available, for remote fields in the 3rd party platform. These examples come from active data from your customers. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -13226,64 +12724,75 @@ client.crm.field_mapping.remote_fields_retrieve()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
- -
+
+
+**expand:** `typing.Optional[typing.Literal["child_groups"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +
-
-
client.crm.field_mapping.target_fields_retrieve()
-#### 📝 Description +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). + +
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+
-Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields. Organization-wide Target Fields are additional fields appended to the Merge Common Model for all Linked Accounts in a category. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/target-fields/). -
-
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + -#### 🔌 Usage -
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. + +
+
+
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.field_mapping.target_fields_retrieve() - -``` +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +
+ +
+
+ +**page_size:** `typing.Optional[int]` — Number of results to return per page. +
-#### ⚙️ Parameters -
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. + +
+
+
@@ -13299,8 +12808,7 @@ client.crm.field_mapping.target_fields_retrieve()
-## Crm GenerateKey -
client.crm.generate_key.create(...) +
client.filestorage.groups.retrieve(...)
@@ -13312,7 +12820,7 @@ client.crm.field_mapping.target_fields_retrieve()
-Create a remote key. +Returns a `Group` object with the given `id`.
@@ -13333,8 +12841,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.generate_key.create( - name="Remote Deployment Key 1", +client.filestorage.groups.retrieve( + id="id", ) ``` @@ -13351,7 +12859,31 @@ client.crm.generate_key.create(
-**name:** `str` — The name of the remote key +**id:** `str` + +
+
+ +
+
+ +**expand:** `typing.Optional[typing.Literal["child_groups"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
+ +
+
+ +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+ +
+
+ +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -13371,8 +12903,8 @@ client.crm.generate_key.create(
-## Crm Issues -
client.crm.issues.list(...) +## Filestorage Issues +
client.filestorage.issues.list(...)
@@ -13405,7 +12937,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.issues.list() +client.filestorage.issues.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ```
@@ -13550,7 +13084,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-
client.crm.issues.retrieve(...) +
client.filestorage.issues.retrieve(...)
@@ -13583,7 +13117,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.issues.retrieve( +client.filestorage.issues.retrieve( id="id", ) @@ -13621,8 +13155,8 @@ client.crm.issues.retrieve(
-## Crm Leads -
client.crm.leads.list(...) +## Filestorage LinkToken +
client.filestorage.link_token.create(...)
@@ -13634,7 +13168,7 @@ client.crm.issues.retrieve(
-Returns a list of `Lead` objects. +Creates a link token to be used when linking a new end user.
@@ -13650,12 +13184,18 @@ Returns a list of `Lead` objects. ```python from merge import Merge +from merge.resources.filestorage import CategoriesEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.leads.list() +client.filestorage.link_token.create( + end_user_email_address="example@gmail.com", + end_user_organization_name="Test Organization", + end_user_origin_id="12345", + categories=[CategoriesEnum.HRIS, CategoriesEnum.ATS], +) ``` @@ -13671,7 +13211,7 @@ client.crm.leads.list()
-**converted_account_id:** `typing.Optional[str]` — If provided, will only return leads with this account. +**end_user_email_address:** `str` — Your end user's email address. This is purely for identification purposes - setting this value will not cause any emails to be sent.
@@ -13679,7 +13219,7 @@ client.crm.leads.list()
-**converted_contact_id:** `typing.Optional[str]` — If provided, will only return leads with this contact. +**end_user_organization_name:** `str` — Your end user's organization.
@@ -13687,7 +13227,7 @@ client.crm.leads.list()
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**end_user_origin_id:** `str` — This unique identifier typically represents the ID for your end user in your product's database. This value must be distinct from other Linked Accounts' unique identifiers.
@@ -13695,7 +13235,7 @@ client.crm.leads.list()
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link.
@@ -13703,7 +13243,7 @@ client.crm.leads.list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**integration:** `typing.Optional[str]` — The slug of a specific pre-selected integration for this linking flow token. For examples of slugs, see https://docs.merge.dev/guides/merge-link/single-integration/.
@@ -13711,7 +13251,7 @@ client.crm.leads.list()
-**email_addresses:** `typing.Optional[str]` — If provided, will only return contacts matching the email addresses; multiple email_addresses can be separated by commas. +**link_expiry_mins:** `typing.Optional[int]` — An integer number of minutes between [30, 720 or 10080 if for a Magic Link URL] for how long this token is valid. Defaults to 30.
@@ -13719,7 +13259,7 @@ client.crm.leads.list()
-**expand:** `typing.Optional[LeadsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**should_create_magic_link_url:** `typing.Optional[bool]` — Whether to generate a Magic Link URL. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link.
@@ -13727,7 +13267,7 @@ client.crm.leads.list()
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**hide_admin_magic_link:** `typing.Optional[bool]` — Whether to generate a Magic Link URL on the Admin Needed screen during the linking flow. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link.
@@ -13735,7 +13275,7 @@ client.crm.leads.list()
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**common_models:** `typing.Optional[typing.Sequence[CommonModelScopesBodyRequest]]` — An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account.
@@ -13743,7 +13283,14 @@ client.crm.leads.list()
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**category_common_model_scopes:** `typing.Optional[ + typing.Dict[ + str, + typing.Optional[ + typing.Sequence[IndividualCommonModelScopeDeserializerRequest] + ], + ] +]` — When creating a Link Token, you can set permissions for Common Models that will apply to the account that is going to be linked. Any model or field not specified in link token payload will default to existing settings.
@@ -13751,7 +13298,12 @@ client.crm.leads.list()
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**language:** `typing.Optional[LanguageEnum]` + +The following subset of IETF language tags can be used to configure localization. + +* `en` - en +* `de` - de
@@ -13759,7 +13311,7 @@ client.crm.leads.list()
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**are_syncs_disabled:** `typing.Optional[bool]` — The boolean that indicates whether initial, periodic, and force syncs will be disabled.
@@ -13767,7 +13319,7 @@ client.crm.leads.list()
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — A JSON object containing integration-specific configuration options.
@@ -13775,15 +13327,81 @@ client.crm.leads.list()
-**owner_id:** `typing.Optional[str]` — If provided, will only return leads with this owner. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
+ + + + +
+## Filestorage LinkedAccounts +
client.filestorage.linked_accounts.list(...)
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +#### 📝 Description + +
+
+ +
+
+ +List linked accounts for your organization. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.filestorage.linked_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**category:** `typing.Optional[LinkedAccountsListRequestCategory]` + +Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing` + +* `hris` - hris +* `ats` - ats +* `accounting` - accounting +* `ticketing` - ticketing +* `crm` - crm +* `mktg` - mktg +* `filestorage` - filestorage
@@ -13791,7 +13409,7 @@ client.crm.leads.list()
-**phone_numbers:** `typing.Optional[str]` — If provided, will only return contacts matching the phone numbers; multiple phone numbers can be separated by commas. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -13799,7 +13417,87 @@ client.crm.leads.list()
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**end_user_email_address:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given email address. + +
+
+ +
+
+ +**end_user_organization_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given organization name. + +
+
+ +
+
+ +**end_user_origin_id:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given origin ID. + +
+
+ +
+
+ +**end_user_origin_ids:** `typing.Optional[str]` — Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once. + +
+
+ +
+
+ +**id:** `typing.Optional[str]` + +
+
+ +
+
+ +**ids:** `typing.Optional[str]` — Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once. + +
+
+ +
+
+ +**include_duplicates:** `typing.Optional[bool]` — If `true`, will include complete production duplicates of the account specified by the `id` query parameter in the response. `id` must be for a complete production linked account. + +
+
+ +
+
+ +**integration_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given integration name. + +
+
+ +
+
+ +**is_test_account:** `typing.Optional[str]` — If included, will only include test linked accounts. If not included, will only include non-test linked accounts. + +
+
+ +
+
+ +**page_size:** `typing.Optional[int]` — Number of results to return per page. + +
+
+ +
+
+ +**status:** `typing.Optional[str]` — Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED`
@@ -13819,7 +13517,8 @@ client.crm.leads.list()
-
client.crm.leads.create(...) +## Filestorage Passthrough +
client.filestorage.passthrough.create(...)
@@ -13831,7 +13530,7 @@ client.crm.leads.list()
-Creates a `Lead` object with the given values. +Pull data from an endpoint not currently supported by Merge.
@@ -13847,14 +13546,17 @@ Creates a `Lead` object with the given values. ```python from merge import Merge -from merge.resources.crm import LeadRequest +from merge.resources.filestorage import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.leads.create( - model=LeadRequest(), +client.filestorage.passthrough.create( + request=DataPassthroughRequest( + method=MethodEnum.GET, + path="/scooters", + ), ) ``` @@ -13871,23 +13573,7 @@ client.crm.leads.create(
-**model:** `LeadRequest` - -
-
- -
-
- -**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. - -
-
- -
-
- -**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**request:** `DataPassthroughRequest`
@@ -13907,7 +13593,8 @@ client.crm.leads.create(
-
client.crm.leads.retrieve(...) +## Filestorage RegenerateKey +
client.filestorage.regenerate_key.create(...)
@@ -13919,7 +13606,7 @@ client.crm.leads.create(
-Returns a `Lead` object with the given `id`. +Exchange remote keys.
@@ -13940,8 +13627,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.leads.retrieve( - id="id", +client.filestorage.regenerate_key.create( + name="Remote Deployment Key 1", ) ``` @@ -13958,7 +13645,7 @@ client.crm.leads.retrieve(
-**id:** `str` +**name:** `str` — The name of the remote key
@@ -13966,23 +13653,71 @@ client.crm.leads.retrieve(
-**expand:** `typing.Optional[LeadsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
+ + + +
+ +## Filestorage SyncStatus +
client.filestorage.sync_status.list(...)
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - +#### 📝 Description + +
+
+ +
+
+ +Get sync status for the current sync and the most recently finished sync. `last_sync_start` represents the most recent time any sync began. `last_sync_finished` represents the most recent time any sync completed. These timestamps may correspond to different sync instances which may result in a sync start time being later than a separate sync completed time. To ensure you are retrieving the latest available data reference the `last_sync_finished` timestamp where `last_sync_result` is `DONE`. Possible values for `status` and `last_sync_result` are `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses). +
+
+#### 🔌 Usage +
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.filestorage.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -13990,7 +13725,7 @@ client.crm.leads.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -14010,7 +13745,8 @@ client.crm.leads.retrieve(
-
client.crm.leads.meta_post_retrieve() +## Filestorage ForceResync +
client.filestorage.force_resync.sync_status_resync_create()
@@ -14022,7 +13758,7 @@ client.crm.leads.retrieve(
-Returns metadata for `Lead` POSTs. +Force re-sync of all models. This endpoint is available for monthly, quarterly, and highest sync frequency customers on the Professional or Enterprise plans. Doing so will consume a sync credit for the relevant linked account. Force re-syncs can also be triggered manually in the Merge Dashboard and is available for all customers.
@@ -14043,7 +13779,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.leads.meta_post_retrieve() +client.filestorage.force_resync.sync_status_resync_create() ``` @@ -14071,7 +13807,8 @@ client.crm.leads.meta_post_retrieve()
-
client.crm.leads.remote_field_classes_list(...) +## Filestorage Users +
client.filestorage.users.list(...)
@@ -14083,7 +13820,7 @@ client.crm.leads.meta_post_retrieve()
-Returns a list of `RemoteFieldClass` objects. +Returns a list of `User` objects.
@@ -14104,7 +13841,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.leads.remote_field_classes_list() +client.filestorage.users.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -14120,6 +13859,22 @@ client.crm.leads.remote_field_classes_list()
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. + +
+
+ +
+
+ +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. + +
+
+ +
+
+ **cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -14144,7 +13899,7 @@ client.crm.leads.remote_field_classes_list()
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -14152,7 +13907,7 @@ client.crm.leads.remote_field_classes_list()
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**is_me:** `typing.Optional[str]` — If provided, will only return the user object for requestor.
@@ -14160,7 +13915,7 @@ client.crm.leads.remote_field_classes_list()
-**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -14168,7 +13923,7 @@ client.crm.leads.remote_field_classes_list()
-**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -14184,6 +13939,14 @@ client.crm.leads.remote_field_classes_list()
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -14196,8 +13959,7 @@ client.crm.leads.remote_field_classes_list()
-## Crm LinkToken -
client.crm.link_token.create(...) +
client.filestorage.users.retrieve(...)
@@ -14209,7 +13971,7 @@ client.crm.leads.remote_field_classes_list()
-Creates a link token to be used when linking a new end user. +Returns a `User` object with the given `id`.
@@ -14225,17 +13987,13 @@ Creates a link token to be used when linking a new end user. ```python from merge import Merge -from merge.resources.crm import CategoriesEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.link_token.create( - end_user_email_address="example@gmail.com", - end_user_organization_name="Test Organization", - end_user_origin_id="12345", - categories=[CategoriesEnum.HRIS, CategoriesEnum.ATS], +client.filestorage.users.retrieve( + id="id", ) ``` @@ -14252,7 +14010,7 @@ client.crm.link_token.create(
-**end_user_email_address:** `str` — Your end user's email address. This is purely for identification purposes - setting this value will not cause any emails to be sent. +**id:** `str`
@@ -14260,7 +14018,7 @@ client.crm.link_token.create(
-**end_user_organization_name:** `str` — Your end user's organization. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -14268,7 +14026,7 @@ client.crm.link_token.create(
-**end_user_origin_id:** `str` — This unique identifier typically represents the ID for your end user in your product's database. This value must be distinct from other Linked Accounts' unique identifiers. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -14276,95 +14034,65 @@ client.crm.link_token.create(
-**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
- -
-
- -**integration:** `typing.Optional[str]` — The slug of a specific pre-selected integration for this linking flow token. For examples of slugs, see https://docs.merge.dev/guides/merge-link/single-integration/. -
-
-
-**link_expiry_mins:** `typing.Optional[int]` — An integer number of minutes between [30, 720 or 10080 if for a Magic Link URL] for how long this token is valid. Defaults to 30. -
+
+## Filestorage WebhookReceivers +
client.filestorage.webhook_receivers.list()
-**should_create_magic_link_url:** `typing.Optional[bool]` — Whether to generate a Magic Link URL. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link. - -
-
+#### 📝 Description
-**hide_admin_magic_link:** `typing.Optional[bool]` — Whether to generate a Magic Link URL on the Admin Needed screen during the linking flow. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link. - -
-
-
-**common_models:** `typing.Optional[typing.Sequence[CommonModelScopesBodyRequest]]` — An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account. - +Returns a list of `WebhookReceiver` objects. +
+
+#### 🔌 Usage +
-**category_common_model_scopes:** `typing.Optional[ - typing.Dict[ - str, - typing.Optional[ - typing.Sequence[IndividualCommonModelScopeDeserializerRequest] - ], - ] -]` — When creating a Link Token, you can set permissions for Common Models that will apply to the account that is going to be linked. Any model or field not specified in link token payload will default to existing settings. - -
-
-
-**language:** `typing.Optional[EndUserDetailsRequestLanguage]` +```python +from merge import Merge -The following subset of IETF language tags can be used to configure localization. +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.filestorage.webhook_receivers.list() -* `en` - en -* `de` - de - +```
- -
-
- -**are_syncs_disabled:** `typing.Optional[bool]` — The boolean that indicates whether initial, periodic, and force syncs will be disabled. -
+#### ⚙️ Parameters +
-**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — A JSON object containing integration-specific configuration options. - -
-
-
@@ -14380,8 +14108,7 @@ The following subset of IETF language tags can be used to configure localization
-## Crm LinkedAccounts -
client.crm.linked_accounts.list(...) +
client.filestorage.webhook_receivers.create(...)
@@ -14393,7 +14120,7 @@ The following subset of IETF language tags can be used to configure localization
-List linked accounts for your organization. +Creates a `WebhookReceiver` object with the given values.
@@ -14414,7 +14141,10 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.linked_accounts.list() +client.filestorage.webhook_receivers.create( + event="event", + is_active=True, +) ``` @@ -14430,17 +14160,7 @@ client.crm.linked_accounts.list()
-**category:** `typing.Optional[LinkedAccountsListRequestCategory]` - -Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing` - -* `hris` - hris -* `ats` - ats -* `accounting` - accounting -* `ticketing` - ticketing -* `crm` - crm -* `mktg` - mktg -* `filestorage` - filestorage +**event:** `str`
@@ -14448,7 +14168,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**is_active:** `bool`
@@ -14456,7 +14176,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**end_user_email_address:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given email address. +**key:** `typing.Optional[str]`
@@ -14464,79 +14184,133 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**end_user_organization_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given organization name. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**end_user_origin_id:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given origin ID. -
+
+## Ats AccountDetails +
client.ats.account_details.retrieve()
-**end_user_origin_ids:** `typing.Optional[str]` — Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once. - -
-
+#### 📝 Description
-**id:** `typing.Optional[str]` - +
+
+ +Get details for a linked account.
+
+
+ +#### 🔌 Usage
-**ids:** `typing.Optional[str]` — Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ats.account_details.retrieve() + +``` +
+
+#### ⚙️ Parameters +
-**include_duplicates:** `typing.Optional[bool]` — If `true`, will include complete production duplicates of the account specified by the `id` query parameter in the response. `id` must be for a complete production linked account. +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
-
-
-**integration_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given integration name. -
+
+## Ats AccountToken +
client.ats.account_token.retrieve(...)
-**is_test_account:** `typing.Optional[str]` — If included, will only include test linked accounts. If not included, will only include non-test linked accounts. - +#### 📝 Description + +
+
+ +
+
+ +Returns the account token for the end user with the provided public token.
+
+
+ +#### 🔌 Usage
-**page_size:** `typing.Optional[int]` — Number of results to return per page. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ats.account_token.retrieve( + public_token="public_token", +) + +``` +
+
+#### ⚙️ Parameters +
-**status:** `typing.Optional[str]` — Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED` +
+
+ +**public_token:** `str`
@@ -14556,8 +14330,8 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-## Crm Notes -
client.crm.notes.list(...) +## Ats Activities +
client.ats.activities.list(...)
@@ -14569,7 +14343,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-Returns a list of `Note` objects. +Returns a list of `Activity` objects.
@@ -14590,7 +14364,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.notes.list() +client.ats.activities.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -14606,22 +14382,6 @@ client.crm.notes.list()
-**account_id:** `typing.Optional[str]` — If provided, will only return notes with this account. - -
-
- -
-
- -**contact_id:** `typing.Optional[str]` — If provided, will only return notes with this contact. - -
-
- -
-
- **created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -14646,7 +14406,7 @@ client.crm.notes.list()
-**expand:** `typing.Optional[NotesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[typing.Literal["user"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -14670,7 +14430,7 @@ client.crm.notes.list()
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -14678,7 +14438,7 @@ client.crm.notes.list()
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -14686,7 +14446,7 @@ client.crm.notes.list()
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -14694,7 +14454,7 @@ client.crm.notes.list()
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -14702,7 +14462,7 @@ client.crm.notes.list()
-**opportunity_id:** `typing.Optional[str]` — If provided, will only return notes with this opportunity. +**remote_fields:** `typing.Optional[ActivitiesListRequestRemoteFields]` — Deprecated. Use show_enum_origins.
@@ -14710,7 +14470,7 @@ client.crm.notes.list()
-**owner_id:** `typing.Optional[str]` — If provided, will only return notes with this owner. +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -14718,7 +14478,7 @@ client.crm.notes.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**show_enum_origins:** `typing.Optional[ActivitiesListRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
@@ -14726,7 +14486,7 @@ client.crm.notes.list()
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**user_id:** `typing.Optional[str]` — If provided, will only return activities done by this user.
@@ -14746,7 +14506,7 @@ client.crm.notes.list()
-
client.crm.notes.create(...) +
client.ats.activities.create(...)
@@ -14758,7 +14518,7 @@ client.crm.notes.list()
-Creates a `Note` object with the given values. +Creates an `Activity` object with the given values.
@@ -14774,14 +14534,15 @@ Creates a `Note` object with the given values. ```python from merge import Merge -from merge.resources.crm import NoteRequest +from merge.resources.ats import ActivityRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.notes.create( - model=NoteRequest(), +client.ats.activities.create( + model=ActivityRequest(), + remote_user_id="remote_user_id", ) ``` @@ -14798,7 +14559,15 @@ client.crm.notes.create(
-**model:** `NoteRequest` +**model:** `ActivityRequest` + +
+
+ +
+
+ +**remote_user_id:** `str`
@@ -14834,7 +14603,7 @@ client.crm.notes.create(
-
client.crm.notes.retrieve(...) +
client.ats.activities.retrieve(...)
@@ -14846,7 +14615,7 @@ client.crm.notes.create(
-Returns a `Note` object with the given `id`. +Returns an `Activity` object with the given `id`.
@@ -14867,7 +14636,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.notes.retrieve( +client.ats.activities.retrieve( id="id", ) @@ -14893,7 +14662,7 @@ client.crm.notes.retrieve(
-**expand:** `typing.Optional[NotesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[typing.Literal["user"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -14909,14 +14678,6 @@ client.crm.notes.retrieve(
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. - -
-
- -
-
- **include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -14925,64 +14686,19 @@ client.crm.notes.retrieve(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**remote_fields:** `typing.Optional[ActivitiesRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins.
- -
- - - -
-
-
client.crm.notes.meta_post_retrieve()
-#### 📝 Description - -
-
- -
-
- -Returns metadata for `Note` POSTs. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.notes.meta_post_retrieve() - -``` -
-
+**show_enum_origins:** `typing.Optional[ActivitiesRetrieveRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) +
-#### ⚙️ Parameters - -
-
-
@@ -14998,7 +14714,7 @@ client.crm.notes.meta_post_retrieve()
-
client.crm.notes.remote_field_classes_list(...) +
client.ats.activities.meta_post_retrieve()
@@ -15010,7 +14726,7 @@ client.crm.notes.meta_post_retrieve()
-Returns a list of `RemoteFieldClass` objects. +Returns metadata for `Activity` POSTs.
@@ -15031,7 +14747,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.notes.remote_field_classes_list() +client.ats.activities.meta_post_retrieve() ``` @@ -15047,70 +14763,6 @@ client.crm.notes.remote_field_classes_list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. - -
-
- -
-
- -**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). - -
-
- -
-
- -**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
- -
-
- -**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. - -
-
- -
-
- -**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
- -
-
- -**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value - -
-
- -
-
- -**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value - -
-
- -
-
- -**page_size:** `typing.Optional[int]` — Number of results to return per page. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -15123,8 +14775,8 @@ client.crm.notes.remote_field_classes_list()
-## Crm Opportunities -
client.crm.opportunities.list(...) +## Ats Applications +
client.ats.applications.list(...)
@@ -15136,7 +14788,7 @@ client.crm.notes.remote_field_classes_list()
-Returns a list of `Opportunity` objects. +Returns a list of `Application` objects.
@@ -15157,7 +14809,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.opportunities.list() +client.ats.applications.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -15173,7 +14827,7 @@ client.crm.opportunities.list()
-**account_id:** `typing.Optional[str]` — If provided, will only return opportunities with this account. +**candidate_id:** `typing.Optional[str]` — If provided, will only return applications for this candidate.
@@ -15197,7 +14851,7 @@ client.crm.opportunities.list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**credited_to_id:** `typing.Optional[str]` — If provided, will only return applications credited to this user.
@@ -15205,7 +14859,7 @@ client.crm.opportunities.list()
-**expand:** `typing.Optional[OpportunitiesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**current_stage_id:** `typing.Optional[str]` — If provided, will only return applications at this interview stage.
@@ -15213,7 +14867,7 @@ client.crm.opportunities.list()
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -15221,7 +14875,7 @@ client.crm.opportunities.list()
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**expand:** `typing.Optional[ApplicationsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -15229,7 +14883,7 @@ client.crm.opportunities.list()
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -15237,7 +14891,7 @@ client.crm.opportunities.list()
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -15245,7 +14899,7 @@ client.crm.opportunities.list()
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -15253,7 +14907,7 @@ client.crm.opportunities.list()
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**job_id:** `typing.Optional[str]` — If provided, will only return applications for this job.
@@ -15261,7 +14915,7 @@ client.crm.opportunities.list()
-**owner_id:** `typing.Optional[str]` — If provided, will only return opportunities with this owner. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -15269,7 +14923,7 @@ client.crm.opportunities.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -15277,7 +14931,7 @@ client.crm.opportunities.list()
-**remote_created_after:** `typing.Optional[dt.datetime]` — If provided, will only return opportunities created in the third party platform after this datetime. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -15285,7 +14939,7 @@ client.crm.opportunities.list()
-**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins. +**reject_reason_id:** `typing.Optional[str]` — If provided, will only return applications with this reject reason.
@@ -15301,29 +14955,7 @@ client.crm.opportunities.list()
-**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) - -
-
- -
-
- -**stage_id:** `typing.Optional[str]` — If provided, will only return opportunities with this stage. - -
-
- -
-
- -**status:** `typing.Optional[OpportunitiesListRequestStatus]` - -If provided, will only return opportunities with this status. Options: ('OPEN', 'WON', 'LOST') - -* `OPEN` - OPEN -* `WON` - WON -* `LOST` - LOST +**source:** `typing.Optional[str]` — If provided, will only return applications with this source.
@@ -15343,7 +14975,7 @@ If provided, will only return opportunities with this status. Options: ('OPEN',
-
client.crm.opportunities.create(...) +
client.ats.applications.create(...)
@@ -15355,7 +14987,10 @@ If provided, will only return opportunities with this status. Options: ('OPEN',
-Creates an `Opportunity` object with the given values. +Creates an `Application` object with the given values. +For certain integrations, but not all, our API detects duplicate candidates and will associate applications with existing records in the third-party. New candidates are created and automatically linked to the application. + +See our [Help Center article](https://help.merge.dev/en/articles/10012366-updates-to-post-applications-oct-2024) for detailed support per integration.
@@ -15371,14 +15006,15 @@ Creates an `Opportunity` object with the given values. ```python from merge import Merge -from merge.resources.crm import OpportunityRequest +from merge.resources.ats import ApplicationRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.opportunities.create( - model=OpportunityRequest(), +client.ats.applications.create( + model=ApplicationRequest(), + remote_user_id="remote_user_id", ) ``` @@ -15395,7 +15031,15 @@ client.crm.opportunities.create(
-**model:** `OpportunityRequest` +**model:** `ApplicationRequest` + +
+
+ +
+
+ +**remote_user_id:** `str`
@@ -15431,7 +15075,7 @@ client.crm.opportunities.create(
-
client.crm.opportunities.retrieve(...) +
client.ats.applications.retrieve(...)
@@ -15443,7 +15087,7 @@ client.crm.opportunities.create(
-Returns an `Opportunity` object with the given `id`. +Returns an `Application` object with the given `id`.
@@ -15464,7 +15108,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.opportunities.retrieve( +client.ats.applications.retrieve( id="id", ) @@ -15490,7 +15134,7 @@ client.crm.opportunities.retrieve(
-**expand:** `typing.Optional[OpportunitiesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[ApplicationsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -15506,14 +15150,6 @@ client.crm.opportunities.retrieve(
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. - -
-
- -
-
- **include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -15522,22 +15158,6 @@ client.crm.opportunities.retrieve(
-**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins. - -
-
- -
-
- -**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -15550,7 +15170,7 @@ client.crm.opportunities.retrieve(
-
client.crm.opportunities.partial_update(...) +
client.ats.applications.change_stage_create(...)
@@ -15562,7 +15182,7 @@ client.crm.opportunities.retrieve(
-Updates an `Opportunity` object with the given `id`. +Updates the `current_stage` field of an `Application` object
@@ -15578,15 +15198,13 @@ Updates an `Opportunity` object with the given `id`. ```python from merge import Merge -from merge.resources.crm import PatchedOpportunityRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.opportunities.partial_update( +client.ats.applications.change_stage_create( id="id", - model=PatchedOpportunityRequest(), ) ``` @@ -15611,14 +15229,6 @@ client.crm.opportunities.partial_update(
-**model:** `PatchedOpportunityRequest` - -
-
- -
-
- **is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -15635,70 +15245,15 @@ client.crm.opportunities.partial_update(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**job_interview_stage:** `typing.Optional[str]` — The interview stage to move the application to.
- -
- - -
-
- -
client.crm.opportunities.meta_patch_retrieve(...)
-#### 📝 Description - -
-
- -
-
- -Returns metadata for `Opportunity` PATCHs. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.opportunities.meta_patch_retrieve( - id="id", -) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**id:** `str` +**remote_user_id:** `typing.Optional[str]`
@@ -15718,68 +15273,7 @@ client.crm.opportunities.meta_patch_retrieve(
-
client.crm.opportunities.meta_post_retrieve() -
-
- -#### 📝 Description - -
-
- -
-
- -Returns metadata for `Opportunity` POSTs. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.opportunities.meta_post_retrieve() - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.crm.opportunities.remote_field_classes_list(...) +
client.ats.applications.meta_post_retrieve(...)
@@ -15791,7 +15285,7 @@ client.crm.opportunities.meta_post_retrieve()
-Returns a list of `RemoteFieldClass` objects. +Returns metadata for `Application` POSTs.
@@ -15812,7 +15306,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.opportunities.remote_field_classes_list() +client.ats.applications.meta_post_retrieve() ``` @@ -15828,63 +15322,7 @@ client.crm.opportunities.remote_field_classes_list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. - -
-
- -
-
- -**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). - -
-
- -
-
- -**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
- -
-
- -**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. - -
-
- -
-
- -**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
- -
-
- -**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value - -
-
- -
-
- -**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value - -
-
- -
-
- -**page_size:** `typing.Optional[int]` — Number of results to return per page. +**application_remote_template_id:** `typing.Optional[str]` — The template ID associated with the nested application in the request.
@@ -15904,8 +15342,8 @@ client.crm.opportunities.remote_field_classes_list()
-## Crm Passthrough -
client.crm.passthrough.create(...) +## Ats AsyncPassthrough +
client.ats.async_passthrough.create(...)
@@ -15917,7 +15355,7 @@ client.crm.opportunities.remote_field_classes_list()
-Pull data from an endpoint not currently supported by Merge. +Asynchronously pull data from an endpoint not currently supported by Merge.
@@ -15933,13 +15371,13 @@ Pull data from an endpoint not currently supported by Merge. ```python from merge import Merge -from merge.resources.crm import DataPassthroughRequest, MethodEnum +from merge.resources.ats import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.passthrough.create( +client.ats.async_passthrough.create( request=DataPassthroughRequest( method=MethodEnum.GET, path="/scooters", @@ -15980,8 +15418,7 @@ client.crm.passthrough.create(
-## Crm RegenerateKey -
client.crm.regenerate_key.create(...) +
client.ats.async_passthrough.retrieve(...)
@@ -15993,7 +15430,7 @@ client.crm.passthrough.create(
-Exchange remote keys. +Retrieves data from earlier async-passthrough POST request
@@ -16014,8 +15451,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.regenerate_key.create( - name="Remote Deployment Key 1", +client.ats.async_passthrough.retrieve( + async_passthrough_receipt_id="async_passthrough_receipt_id", ) ``` @@ -16032,7 +15469,7 @@ client.crm.regenerate_key.create(
-**name:** `str` — The name of the remote key +**async_passthrough_receipt_id:** `str`
@@ -16052,8 +15489,8 @@ client.crm.regenerate_key.create(
-## Crm Stages -
client.crm.stages.list(...) +## Ats Attachments +
client.ats.attachments.list(...)
@@ -16065,7 +15502,7 @@ client.crm.regenerate_key.create(
-Returns a list of `Stage` objects. +Returns a list of `Attachment` objects.
@@ -16086,7 +15523,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.stages.list() +client.ats.attachments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -16102,6 +15541,14 @@ client.crm.stages.list()
+**candidate_id:** `typing.Optional[str]` — If provided, will only return attachments for this candidate. + +
+
+ +
+
+ **created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -16126,7 +15573,7 @@ client.crm.stages.list()
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**expand:** `typing.Optional[typing.Literal["candidate"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -16134,7 +15581,7 @@ client.crm.stages.list()
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -16142,7 +15589,7 @@ client.crm.stages.list()
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -16182,6 +15629,14 @@ client.crm.stages.list()
+**remote_fields:** `typing.Optional[typing.Literal["attachment_type"]]` — Deprecated. Use show_enum_origins. + +
+
+ +
+
+ **remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -16190,6 +15645,14 @@ client.crm.stages.list()
+**show_enum_origins:** `typing.Optional[typing.Literal["attachment_type"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -16202,7 +15665,7 @@ client.crm.stages.list()
-
client.crm.stages.retrieve(...) +
client.ats.attachments.create(...)
@@ -16214,7 +15677,7 @@ client.crm.stages.list()
-Returns a `Stage` object with the given `id`. +Creates an `Attachment` object with the given values.
@@ -16230,13 +15693,15 @@ Returns a `Stage` object with the given `id`. ```python from merge import Merge +from merge.resources.ats import AttachmentRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.stages.retrieve( - id="id", +client.ats.attachments.create( + model=AttachmentRequest(), + remote_user_id="remote_user_id", ) ``` @@ -16253,7 +15718,7 @@ client.crm.stages.retrieve(
-**id:** `str` +**model:** `AttachmentRequest`
@@ -16261,7 +15726,7 @@ client.crm.stages.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**remote_user_id:** `str`
@@ -16269,7 +15734,7 @@ client.crm.stages.retrieve(
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -16277,7 +15742,7 @@ client.crm.stages.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -16297,7 +15762,7 @@ client.crm.stages.retrieve(
-
client.crm.stages.remote_field_classes_list(...) +
client.ats.attachments.retrieve(...)
@@ -16309,7 +15774,7 @@ client.crm.stages.retrieve(
-Returns a list of `RemoteFieldClass` objects. +Returns an `Attachment` object with the given `id`.
@@ -16330,7 +15795,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.stages.remote_field_classes_list() +client.ats.attachments.retrieve( + id="id", +) ``` @@ -16346,7 +15813,7 @@ client.crm.stages.remote_field_classes_list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**id:** `str`
@@ -16354,7 +15821,7 @@ client.crm.stages.remote_field_classes_list()
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**expand:** `typing.Optional[typing.Literal["candidate"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -16370,7 +15837,7 @@ client.crm.stages.remote_field_classes_list()
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -16378,7 +15845,7 @@ client.crm.stages.remote_field_classes_list()
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**remote_fields:** `typing.Optional[typing.Literal["attachment_type"]]` — Deprecated. Use show_enum_origins.
@@ -16386,7 +15853,7 @@ client.crm.stages.remote_field_classes_list()
-**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value +**show_enum_origins:** `typing.Optional[typing.Literal["attachment_type"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
@@ -16394,19 +15861,64 @@ client.crm.stages.remote_field_classes_list()
-**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
+ + + +
+ +
client.ats.attachments.meta_post_retrieve()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. - +#### 📝 Description + +
+
+ +
+
+ +Returns metadata for `Attachment` POSTs. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ats.attachments.meta_post_retrieve() + +``` +
+
+#### ⚙️ Parameters + +
+
+
@@ -16422,8 +15934,8 @@ client.crm.stages.remote_field_classes_list()
-## Crm SyncStatus -
client.crm.sync_status.list(...) +## Ats AuditTrail +
client.ats.audit_trail.list(...)
@@ -16435,7 +15947,7 @@ client.crm.stages.remote_field_classes_list()
-Get sync status for the current sync and the most recently finished sync. `last_sync_start` represents the most recent time any sync began. `last_sync_finished` represents the most recent time any sync completed. These timestamps may correspond to different sync instances which may result in a sync start time being later than a separate sync completed time. To ensure you are retrieving the latest available data reference the `last_sync_finished` timestamp where `last_sync_result` is `DONE`. Possible values for `status` and `last_sync_result` are `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses). +Gets a list of audit trail events.
@@ -16456,7 +15968,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.sync_status.list() +client.ats.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -16480,6 +15994,22 @@ client.crm.sync_status.list()
+**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time + +
+
+ +
+
+ +**event_type:** `typing.Optional[str]` — If included, will only include events with the given event type. Possible values include: `CREATED_REMOTE_PRODUCTION_API_KEY`, `DELETED_REMOTE_PRODUCTION_API_KEY`, `CREATED_TEST_API_KEY`, `DELETED_TEST_API_KEY`, `REGENERATED_PRODUCTION_API_KEY`, `REGENERATED_WEBHOOK_SIGNATURE`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_LINKED_ACCOUNT`, `DELETED_ALL_COMMON_MODELS_FOR_LINKED_ACCOUNT`, `CREATED_DESTINATION`, `DELETED_DESTINATION`, `CHANGED_DESTINATION`, `CHANGED_SCOPES`, `CHANGED_PERSONAL_INFORMATION`, `CHANGED_ORGANIZATION_SETTINGS`, `ENABLED_INTEGRATION`, `DISABLED_INTEGRATION`, `ENABLED_CATEGORY`, `DISABLED_CATEGORY`, `CHANGED_PASSWORD`, `RESET_PASSWORD`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `CREATED_INTEGRATION_WIDE_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_FIELD_MAPPING`, `CHANGED_INTEGRATION_WIDE_FIELD_MAPPING`, `CHANGED_LINKED_ACCOUNT_FIELD_MAPPING`, `DELETED_INTEGRATION_WIDE_FIELD_MAPPING`, `DELETED_LINKED_ACCOUNT_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `FORCED_LINKED_ACCOUNT_RESYNC`, `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`, `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`, `END_USER_CREDENTIALS_ACCESSED` + +
+
+ +
+
+ **page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -16488,6 +16018,22 @@ client.crm.sync_status.list()
+**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time + +
+
+ +
+
+ +**user_email:** `typing.Optional[str]` — If provided, this will return events associated with the specified user email. Please note that the email address reflects the user's email at the time of the event, and may not be their current email. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -16500,8 +16046,8 @@ client.crm.sync_status.list()
-## Crm ForceResync -
client.crm.force_resync.sync_status_resync_create() +## Ats AvailableActions +
client.ats.available_actions.retrieve()
@@ -16513,7 +16059,7 @@ client.crm.sync_status.list()
-Force re-sync of all models. This endpoint is available for monthly, quarterly, and highest sync frequency customers on the Professional or Enterprise plans. Doing so will consume a sync credit for the relevant linked account. Force re-syncs can also be triggered manually in the Merge Dashboard and is available for all customers. +Returns a list of models and actions available for an account.
@@ -16534,7 +16080,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.force_resync.sync_status_resync_create() +client.ats.available_actions.retrieve() ``` @@ -16562,8 +16108,8 @@ client.crm.force_resync.sync_status_resync_create()
-## Crm Tasks -
client.crm.tasks.list(...) +## Ats Candidates +
client.ats.candidates.list(...)
@@ -16575,7 +16121,7 @@ client.crm.force_resync.sync_status_resync_create()
-Returns a list of `Task` objects. +Returns a list of `Candidate` objects.
@@ -16596,7 +16142,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.tasks.list() +client.ats.candidates.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -16636,7 +16184,23 @@ client.crm.tasks.list()
-**expand:** `typing.Optional[TasksListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**email_addresses:** `typing.Optional[str]` — If provided, will only return candidates with these email addresses; multiple addresses can be separated by commas. + +
+
+ +
+
+ +**expand:** `typing.Optional[CandidatesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
+ +
+
+ +**first_name:** `typing.Optional[str]` — If provided, will only return candidates with this first name.
@@ -16660,7 +16224,7 @@ client.crm.tasks.list()
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -16668,7 +16232,7 @@ client.crm.tasks.list()
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**last_name:** `typing.Optional[str]` — If provided, will only return candidates with this last name.
@@ -16708,6 +16272,14 @@ client.crm.tasks.list()
+**tags:** `typing.Optional[str]` — If provided, will only return candidates with these tags; multiple tags can be separated by commas. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -16720,7 +16292,7 @@ client.crm.tasks.list()
-
client.crm.tasks.create(...) +
client.ats.candidates.create(...)
@@ -16732,7 +16304,7 @@ client.crm.tasks.list()
-Creates a `Task` object with the given values. +Creates a `Candidate` object with the given values.
@@ -16748,14 +16320,15 @@ Creates a `Task` object with the given values. ```python from merge import Merge -from merge.resources.crm import TaskRequest +from merge.resources.ats import CandidateRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.tasks.create( - model=TaskRequest(), +client.ats.candidates.create( + model=CandidateRequest(), + remote_user_id="remote_user_id", ) ``` @@ -16772,7 +16345,15 @@ client.crm.tasks.create(
-**model:** `TaskRequest` +**model:** `CandidateRequest` + +
+
+ +
+
+ +**remote_user_id:** `str`
@@ -16808,7 +16389,7 @@ client.crm.tasks.create(
-
client.crm.tasks.retrieve(...) +
client.ats.candidates.retrieve(...)
@@ -16820,7 +16401,7 @@ client.crm.tasks.create(
-Returns a `Task` object with the given `id`. +Returns a `Candidate` object with the given `id`.
@@ -16841,7 +16422,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.tasks.retrieve( +client.ats.candidates.retrieve( id="id", ) @@ -16867,7 +16448,105 @@ client.crm.tasks.retrieve(
-**expand:** `typing.Optional[TasksRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[CandidatesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
+ +
+
+ +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+ +
+
+ +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+ +
+ + + + +
+ +
client.ats.candidates.partial_update(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Updates a `Candidate` object with the given `id`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from merge import Merge +from merge.resources.ats import PatchedCandidateRequest + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ats.candidates.partial_update( + id="id", + model=PatchedCandidateRequest(), + remote_user_id="remote_user_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `str` + +
+
+ +
+
+ +**model:** `PatchedCandidateRequest`
@@ -16875,7 +16554,7 @@ client.crm.tasks.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**remote_user_id:** `str`
@@ -16883,7 +16562,7 @@ client.crm.tasks.retrieve(
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -16891,7 +16570,7 @@ client.crm.tasks.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -16911,7 +16590,7 @@ client.crm.tasks.retrieve(
-
client.crm.tasks.partial_update(...) +
client.ats.candidates.ignore_create(...)
@@ -16923,7 +16602,7 @@ client.crm.tasks.retrieve(
-Updates a `Task` object with the given `id`. +Ignores a specific row based on the `model_id` in the url. These records will have their properties set to null, and will not be updated in future syncs. The "reason" and "message" fields in the request body will be stored for audit purposes.
@@ -16939,15 +16618,15 @@ Updates a `Task` object with the given `id`. ```python from merge import Merge -from merge.resources.crm import PatchedTaskRequest +from merge.resources.ats import ReasonEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.tasks.partial_update( - id="id", - model=PatchedTaskRequest(), +client.ats.candidates.ignore_create( + model_id="model_id", + reason=ReasonEnum.GENERAL_CUSTOMER_REQUEST, ) ``` @@ -16964,15 +16643,7 @@ client.crm.tasks.partial_update(
-**id:** `str` - -
-
- -
-
- -**model:** `PatchedTaskRequest` +**model_id:** `str`
@@ -16980,7 +16651,7 @@ client.crm.tasks.partial_update(
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +**reason:** `IgnoreCommonModelRequestReason`
@@ -16988,7 +16659,7 @@ client.crm.tasks.partial_update(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**message:** `typing.Optional[str]`
@@ -17008,7 +16679,7 @@ client.crm.tasks.partial_update(
-
client.crm.tasks.meta_patch_retrieve(...) +
client.ats.candidates.meta_patch_retrieve(...)
@@ -17020,7 +16691,7 @@ client.crm.tasks.partial_update(
-Returns metadata for `Task` PATCHs. +Returns metadata for `Candidate` PATCHs.
@@ -17041,7 +16712,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.tasks.meta_patch_retrieve( +client.ats.candidates.meta_patch_retrieve( id="id", ) @@ -17079,7 +16750,7 @@ client.crm.tasks.meta_patch_retrieve(
-
client.crm.tasks.meta_post_retrieve() +
client.ats.candidates.meta_post_retrieve()
@@ -17091,7 +16762,7 @@ client.crm.tasks.meta_patch_retrieve(
-Returns metadata for `Task` POSTs. +Returns metadata for `Candidate` POSTs.
@@ -17112,7 +16783,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.tasks.meta_post_retrieve() +client.ats.candidates.meta_post_retrieve() ``` @@ -17140,7 +16811,8 @@ client.crm.tasks.meta_post_retrieve()
-
client.crm.tasks.remote_field_classes_list(...) +## Ats Scopes +
client.ats.scopes.default_scopes_retrieve()
@@ -17152,7 +16824,7 @@ client.crm.tasks.meta_post_retrieve()
-Returns a list of `RemoteFieldClass` objects. +Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
@@ -17173,7 +16845,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.tasks.remote_field_classes_list() +client.ats.scopes.default_scopes_retrieve() ``` @@ -17189,67 +16861,64 @@ client.crm.tasks.remote_field_classes_list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). -
+
+
client.ats.scopes.linked_account_scopes_retrieve()
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
+#### 📝 Description
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. - -
-
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - +Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes). +
+
+#### 🔌 Usage +
-**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value - -
-
-
-**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value - +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ats.scopes.linked_account_scopes_retrieve() + +```
+ + + +#### ⚙️ Parameters
-**page_size:** `typing.Optional[int]` — Number of results to return per page. - -
-
-
@@ -17265,8 +16934,7 @@ client.crm.tasks.remote_field_classes_list()
-## Crm Users -
client.crm.users.list(...) +
client.ats.scopes.linked_account_scopes_create(...)
@@ -17278,7 +16946,7 @@ client.crm.tasks.remote_field_classes_list()
-Returns a list of `User` objects. +Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes)
@@ -17294,12 +16962,43 @@ Returns a list of `User` objects. ```python from merge import Merge +from merge.resources.ats import ( + FieldPermissionDeserializerRequest, + IndividualCommonModelScopeDeserializerRequest, + ModelPermissionDeserializerRequest, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.users.list() +client.ats.scopes.linked_account_scopes_create( + common_models=[ + IndividualCommonModelScopeDeserializerRequest( + model_name="Employee", + model_permissions={ + "READ": ModelPermissionDeserializerRequest( + is_enabled=True, + ), + "WRITE": ModelPermissionDeserializerRequest( + is_enabled=False, + ), + }, + field_permissions=FieldPermissionDeserializerRequest( + enabled_fields=["avatar", "home_location"], + disabled_fields=["work_location"], + ), + ), + IndividualCommonModelScopeDeserializerRequest( + model_name="Benefit", + model_permissions={ + "WRITE": ModelPermissionDeserializerRequest( + is_enabled=False, + ) + }, + ), + ], +) ``` @@ -17315,7 +17014,7 @@ client.crm.users.list()
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for
@@ -17323,91 +17022,65 @@ client.crm.users.list()
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
- -
-
- -**cursor:** `typing.Optional[str]` — The pagination cursor value. -
-
-
-**email:** `typing.Optional[str]` — If provided, will only return users with this email. -
+
+## Ats DeleteAccount +
client.ats.delete_account.delete()
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). - -
-
+#### 📝 Description
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
-
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. - +Delete a linked account.
- -
-
- -**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). -
+#### 🔌 Usage +
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. - -
-
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. - -
-
+```python +from merge import Merge -
-
+client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ats.delete_account.delete() -**page_size:** `typing.Optional[int]` — Number of results to return per page. - +``` +
+
+#### ⚙️ Parameters +
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. - -
-
-
@@ -17423,7 +17096,8 @@ client.crm.users.list()
-
client.crm.users.retrieve(...) +## Ats Departments +
client.ats.departments.list(...)
@@ -17435,7 +17109,7 @@ client.crm.users.list()
-Returns a `User` object with the given `id`. +Returns a list of `Department` objects.
@@ -17456,8 +17130,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.users.retrieve( - id="id", +client.ats.departments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -17474,7 +17148,7 @@ client.crm.users.retrieve(
-**id:** `str` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -17482,7 +17156,7 @@ client.crm.users.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -17490,7 +17164,23 @@ client.crm.users.retrieve(
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**cursor:** `typing.Optional[str]` — The pagination cursor value. + +
+
+ +
+
+ +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). + +
+
+ +
+
+ +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -17506,6 +17196,38 @@ client.crm.users.retrieve(
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. + +
+
+ +
+
+ +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. + +
+
+ +
+
+ +**page_size:** `typing.Optional[int]` — Number of results to return per page. + +
+
+ +
+
+ +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -17518,7 +17240,7 @@ client.crm.users.retrieve(
-
client.crm.users.ignore_create(...) +
client.ats.departments.retrieve(...)
@@ -17530,7 +17252,7 @@ client.crm.users.retrieve(
-Ignores a specific row based on the `model_id` in the url. These records will have their properties set to null, and will not be updated in future syncs. The "reason" and "message" fields in the request body will be stored for audit purposes. +Returns a `Department` object with the given `id`.
@@ -17546,17 +17268,13 @@ Ignores a specific row based on the `model_id` in the url. These records will ha ```python from merge import Merge -from merge.resources.crm import IgnoreCommonModelRequest, ReasonEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.users.ignore_create( - model_id="model_id", - request=IgnoreCommonModelRequest( - reason=ReasonEnum.GENERAL_CUSTOMER_REQUEST, - ), +client.ats.departments.retrieve( + id="id", ) ``` @@ -17573,7 +17291,7 @@ client.crm.users.ignore_create(
-**model_id:** `str` +**id:** `str`
@@ -17581,7 +17299,15 @@ client.crm.users.ignore_create(
-**request:** `IgnoreCommonModelRequest` +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+ +
+
+ +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -17601,7 +17327,8 @@ client.crm.users.ignore_create(
-
client.crm.users.remote_field_classes_list(...) +## Ats Eeocs +
client.ats.eeocs.list(...)
@@ -17613,7 +17340,7 @@ client.crm.users.ignore_create(
-Returns a list of `RemoteFieldClass` objects. +Returns a list of `EEOC` objects.
@@ -17634,7 +17361,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.users.remote_field_classes_list() +client.ats.eeocs.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -17650,7 +17379,7 @@ client.crm.users.remote_field_classes_list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**candidate_id:** `typing.Optional[str]` — If provided, will only return EEOC info for this candidate.
@@ -17658,7 +17387,7 @@ client.crm.users.remote_field_classes_list()
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -17666,7 +17395,7 @@ client.crm.users.remote_field_classes_list()
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -17674,7 +17403,7 @@ client.crm.users.remote_field_classes_list()
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -17682,7 +17411,7 @@ client.crm.users.remote_field_classes_list()
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**expand:** `typing.Optional[typing.Literal["candidate"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -17690,7 +17419,7 @@ client.crm.users.remote_field_classes_list()
-**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -17698,7 +17427,7 @@ client.crm.users.remote_field_classes_list()
-**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -17706,7 +17435,7 @@ client.crm.users.remote_field_classes_list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -17714,65 +17443,51 @@ client.crm.users.remote_field_classes_list()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
- -
+
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +
-
-## Crm WebhookReceivers -
client.crm.webhook_receivers.list()
-#### 📝 Description - -
-
+**page_size:** `typing.Optional[int]` — Number of results to return per page. + +
+
-Returns a list of `WebhookReceiver` objects. -
-
+**remote_fields:** `typing.Optional[EeocsListRequestRemoteFields]` — Deprecated. Use show_enum_origins. +
-#### 🔌 Usage -
-
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.webhook_receivers.list() - -``` -
-
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +
-#### ⚙️ Parameters -
+**show_enum_origins:** `typing.Optional[EeocsListRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) + +
+
+
@@ -17788,7 +17503,7 @@ client.crm.webhook_receivers.list()
-
client.crm.webhook_receivers.create(...) +
client.ats.eeocs.retrieve(...)
@@ -17800,7 +17515,7 @@ client.crm.webhook_receivers.list()
-Creates a `WebhookReceiver` object with the given values. +Returns an `EEOC` object with the given `id`.
@@ -17821,9 +17536,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.webhook_receivers.create( - event="event", - is_active=True, +client.ats.eeocs.retrieve( + id="id", ) ``` @@ -17840,7 +17554,7 @@ client.crm.webhook_receivers.create(
-**event:** `str` +**id:** `str`
@@ -17848,7 +17562,7 @@ client.crm.webhook_receivers.create(
-**is_active:** `bool` +**expand:** `typing.Optional[typing.Literal["candidate"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -17856,7 +17570,31 @@ client.crm.webhook_receivers.create(
-**key:** `typing.Optional[str]` +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+ +
+
+ +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
+ +
+
+ +**remote_fields:** `typing.Optional[EeocsRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins. + +
+
+ +
+
+ +**show_enum_origins:** `typing.Optional[EeocsRetrieveRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
@@ -17876,8 +17614,8 @@ client.crm.webhook_receivers.create(
-## Filestorage AccountDetails -
client.filestorage.account_details.retrieve() +## Ats FieldMapping +
client.ats.field_mapping.field_mappings_retrieve(...)
@@ -17889,7 +17627,7 @@ client.crm.webhook_receivers.create(
-Get details for a linked account. +Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
@@ -17910,7 +17648,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.account_details.retrieve() +client.ats.field_mapping.field_mappings_retrieve() ``` @@ -17926,6 +17664,14 @@ client.filestorage.account_details.retrieve()
+**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -17938,8 +17684,7 @@ client.filestorage.account_details.retrieve()
-## Filestorage AccountToken -
client.filestorage.account_token.retrieve(...) +
client.ats.field_mapping.field_mappings_create(...)
@@ -17951,7 +17696,7 @@ client.filestorage.account_details.retrieve()
-Returns the account token for the end user with the provided public token. +Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
@@ -17972,8 +17717,13 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.account_token.retrieve( - public_token="public_token", +client.ats.field_mapping.field_mappings_create( + target_field_name="example_target_field_name", + target_field_description="this is a example description of the target field", + remote_field_traversal_path=["example_remote_field"], + remote_method="GET", + remote_url_path="/example-url-path", + common_model_name="ExampleCommonModel", ) ``` @@ -17990,7 +17740,7 @@ client.filestorage.account_token.retrieve(
-**public_token:** `str` +**target_field_name:** `str` — The name of the target field you want this remote field to map to.
@@ -17998,75 +17748,47 @@ client.filestorage.account_token.retrieve(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**target_field_description:** `str` — The description of the target field you want this remote field to map to.
- -
+
+
+**remote_field_traversal_path:** `typing.Sequence[typing.Optional[typing.Any]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint. +
-
-## Filestorage AsyncPassthrough -
client.filestorage.async_passthrough.create(...)
-#### 📝 Description - -
-
+**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from. + +
+
-Asynchronously pull data from an endpoint not currently supported by Merge. -
-
+**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from. +
-#### 🔌 Usage - -
-
-
-```python -from merge import Merge -from merge.resources.filestorage import DataPassthroughRequest, MethodEnum - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.filestorage.async_passthrough.create( - request=DataPassthroughRequest( - method=MethodEnum.GET, - path="/scooters", - ), -) - -``` -
-
+**common_model_name:** `str` — The name of the Common Model that the remote field corresponds to in a given category. +
-#### ⚙️ Parameters - -
-
-
-**request:** `DataPassthroughRequest` +**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations.
@@ -18086,7 +17808,7 @@ client.filestorage.async_passthrough.create(
-
client.filestorage.async_passthrough.retrieve(...) +
client.ats.field_mapping.field_mappings_destroy(...)
@@ -18098,7 +17820,7 @@ client.filestorage.async_passthrough.create(
-Retrieves data from earlier async-passthrough POST request +Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
@@ -18119,8 +17841,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.async_passthrough.retrieve( - async_passthrough_receipt_id="async_passthrough_receipt_id", +client.ats.field_mapping.field_mappings_destroy( + field_mapping_id="field_mapping_id", ) ``` @@ -18137,7 +17859,7 @@ client.filestorage.async_passthrough.retrieve(
-**async_passthrough_receipt_id:** `str` +**field_mapping_id:** `str`
@@ -18157,8 +17879,7 @@ client.filestorage.async_passthrough.retrieve(
-## Filestorage AuditTrail -
client.filestorage.audit_trail.list(...) +
client.ats.field_mapping.field_mappings_partial_update(...)
@@ -18170,7 +17891,7 @@ client.filestorage.async_passthrough.retrieve(
-Gets a list of audit trail events. +Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
@@ -18191,7 +17912,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.audit_trail.list() +client.ats.field_mapping.field_mappings_partial_update( + field_mapping_id="field_mapping_id", +) ``` @@ -18207,23 +17930,7 @@ client.filestorage.audit_trail.list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. - -
-
- -
-
- -**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time - -
-
- -
-
- -**event_type:** `typing.Optional[str]` — If included, will only include events with the given event type. Possible values include: `CREATED_REMOTE_PRODUCTION_API_KEY`, `DELETED_REMOTE_PRODUCTION_API_KEY`, `CREATED_TEST_API_KEY`, `DELETED_TEST_API_KEY`, `REGENERATED_PRODUCTION_API_KEY`, `REGENERATED_WEBHOOK_SIGNATURE`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_LINKED_ACCOUNT`, `DELETED_ALL_COMMON_MODELS_FOR_LINKED_ACCOUNT`, `CREATED_DESTINATION`, `DELETED_DESTINATION`, `CHANGED_DESTINATION`, `CHANGED_SCOPES`, `CHANGED_PERSONAL_INFORMATION`, `CHANGED_ORGANIZATION_SETTINGS`, `ENABLED_INTEGRATION`, `DISABLED_INTEGRATION`, `ENABLED_CATEGORY`, `DISABLED_CATEGORY`, `CHANGED_PASSWORD`, `RESET_PASSWORD`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `CREATED_INTEGRATION_WIDE_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_FIELD_MAPPING`, `CHANGED_INTEGRATION_WIDE_FIELD_MAPPING`, `CHANGED_LINKED_ACCOUNT_FIELD_MAPPING`, `DELETED_INTEGRATION_WIDE_FIELD_MAPPING`, `DELETED_LINKED_ACCOUNT_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `FORCED_LINKED_ACCOUNT_RESYNC`, `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`, `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`, `END_USER_CREDENTIALS_ACCESSED` +**field_mapping_id:** `str`
@@ -18231,7 +17938,7 @@ client.filestorage.audit_trail.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**remote_field_traversal_path:** `typing.Optional[typing.Sequence[typing.Optional[typing.Any]]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
@@ -18239,7 +17946,7 @@ client.filestorage.audit_trail.list()
-**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time +**remote_method:** `typing.Optional[str]` — The method of the remote endpoint where the remote field is coming from.
@@ -18247,7 +17954,7 @@ client.filestorage.audit_trail.list()
-**user_email:** `typing.Optional[str]` — If provided, this will return events associated with the specified user email. Please note that the email address reflects the user's email at the time of the event, and may not be their current email. +**remote_url_path:** `typing.Optional[str]` — The path of the remote endpoint where the remote field is coming from.
@@ -18267,8 +17974,7 @@ client.filestorage.audit_trail.list()
-## Filestorage AvailableActions -
client.filestorage.available_actions.retrieve() +
client.ats.field_mapping.remote_fields_retrieve(...)
@@ -18280,7 +17986,7 @@ client.filestorage.audit_trail.list()
-Returns a list of models and actions available for an account. +Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
@@ -18301,7 +18007,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.available_actions.retrieve() +client.ats.field_mapping.remote_fields_retrieve() ``` @@ -18317,6 +18023,22 @@ client.filestorage.available_actions.retrieve()
+**common_models:** `typing.Optional[str]` — A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models. + +
+
+ +
+
+ +**include_example_values:** `typing.Optional[str]` — If true, will include example values, where available, for remote fields in the 3rd party platform. These examples come from active data from your customers. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -18329,8 +18051,7 @@ client.filestorage.available_actions.retrieve()
-## Filestorage Scopes -
client.filestorage.scopes.default_scopes_retrieve() +
client.ats.field_mapping.target_fields_retrieve()
@@ -18342,7 +18063,7 @@ client.filestorage.available_actions.retrieve()
-Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes). +Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields. Organization-wide Target Fields are additional fields appended to the Merge Common Model for all Linked Accounts in a category. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/target-fields/).
@@ -18363,7 +18084,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.scopes.default_scopes_retrieve() +client.ats.field_mapping.target_fields_retrieve() ``` @@ -18391,7 +18112,8 @@ client.filestorage.scopes.default_scopes_retrieve()
-
client.filestorage.scopes.linked_account_scopes_retrieve() +## Ats GenerateKey +
client.ats.generate_key.create(...)
@@ -18403,7 +18125,7 @@ client.filestorage.scopes.default_scopes_retrieve()
-Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes). +Create a remote key.
@@ -18424,7 +18146,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.scopes.linked_account_scopes_retrieve() +client.ats.generate_key.create( + name="Remote Deployment Key 1", +) ``` @@ -18440,6 +18164,14 @@ client.filestorage.scopes.linked_account_scopes_retrieve()
+**name:** `str` — The name of the remote key + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -18452,7 +18184,8 @@ client.filestorage.scopes.linked_account_scopes_retrieve()
-
client.filestorage.scopes.linked_account_scopes_create(...) +## Ats Interviews +
client.ats.interviews.list(...)
@@ -18464,7 +18197,7 @@ client.filestorage.scopes.linked_account_scopes_retrieve()
-Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes) +Returns a list of `ScheduledInterview` objects.
@@ -18480,42 +18213,13 @@ Update permissions for any Common Model or field for a single Linked Account. An ```python from merge import Merge -from merge.resources.filestorage import ( - FieldPermissionDeserializerRequest, - IndividualCommonModelScopeDeserializerRequest, - ModelPermissionDeserializerRequest, -) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.scopes.linked_account_scopes_create( - common_models=[ - IndividualCommonModelScopeDeserializerRequest( - model_name="Employee", - model_permissions={ - "READ": ModelPermissionDeserializerRequest( - is_enabled=True, - ), - "WRITE": ModelPermissionDeserializerRequest( - is_enabled=False, - ), - }, - field_permissions=FieldPermissionDeserializerRequest( - enabled_fields=["avatar", "home_location"], - disabled_fields=["work_location"], - ), - ), - IndividualCommonModelScopeDeserializerRequest( - model_name="Benefit", - model_permissions={ - "WRITE": ModelPermissionDeserializerRequest( - is_enabled=False, - ) - }, - ), - ], +client.ats.interviews.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -18532,7 +18236,7 @@ client.filestorage.scopes.linked_account_scopes_create(
-**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for +**application_id:** `typing.Optional[str]` — If provided, will only return interviews for this application.
@@ -18540,131 +18244,103 @@ client.filestorage.scopes.linked_account_scopes_create(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
- -
+
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +
-
-## Filestorage DeleteAccount -
client.filestorage.delete_account.delete()
-#### 📝 Description - -
-
+**cursor:** `typing.Optional[str]` — The pagination cursor value. + +
+
-Delete a linked account. -
-
+**expand:** `typing.Optional[InterviewsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +
-#### 🔌 Usage -
-
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.filestorage.delete_account.delete() - -``` -
-
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +
-#### ⚙️ Parameters - -
-
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
-
-
+
+
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +
-
-## Filestorage Drives -
client.filestorage.drives.list(...)
-#### 📝 Description - -
-
+**job_id:** `typing.Optional[str]` — If provided, wll only return interviews organized for this job. + +
+
-Returns a list of `Drive` objects. -
-
+**job_interview_stage_id:** `typing.Optional[str]` — If provided, will only return interviews at this stage. +
-#### 🔌 Usage -
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. + +
+
+
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.filestorage.drives.list() - -``` -
-
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. + -#### ⚙️ Parameters -
+**organizer_id:** `typing.Optional[str]` — If provided, will only return interviews organized by this user. + +
+
+
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -18672,7 +18348,7 @@ client.filestorage.drives.list()
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins.
@@ -18680,7 +18356,7 @@ client.filestorage.drives.list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -18688,7 +18364,7 @@ client.filestorage.drives.list()
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
@@ -18696,31 +18372,72 @@ client.filestorage.drives.list()
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ + + + + + +
+
client.ats.interviews.create(...)
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - +#### 📝 Description + +
+
+ +
+
+ +Creates a `ScheduledInterview` object with the given values. +
+
+#### 🔌 Usage +
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. - +
+
+ +```python +from merge import Merge +from merge.resources.ats import ScheduledInterviewRequest + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ats.interviews.create( + model=ScheduledInterviewRequest(), + remote_user_id="remote_user_id", +) + +``` +
+
+#### ⚙️ Parameters +
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +
+
+ +**model:** `ScheduledInterviewRequest`
@@ -18728,7 +18445,7 @@ client.filestorage.drives.list()
-**name:** `typing.Optional[str]` — If provided, will only return drives with this name. This performs an exact match. +**remote_user_id:** `str`
@@ -18736,7 +18453,7 @@ client.filestorage.drives.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -18744,7 +18461,7 @@ client.filestorage.drives.list()
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -18764,7 +18481,7 @@ client.filestorage.drives.list()
-
client.filestorage.drives.retrieve(...) +
client.ats.interviews.retrieve(...)
@@ -18776,7 +18493,7 @@ client.filestorage.drives.list()
-Returns a `Drive` object with the given `id`. +Returns a `ScheduledInterview` object with the given `id`.
@@ -18797,7 +18514,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.drives.retrieve( +client.ats.interviews.retrieve( id="id", ) @@ -18823,6 +18540,14 @@ client.filestorage.drives.retrieve(
+**expand:** `typing.Optional[InterviewsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
+ +
+
+ **include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -18839,6 +18564,22 @@ client.filestorage.drives.retrieve(
+**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins. + +
+
+ +
+
+ +**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -18851,8 +18592,7 @@ client.filestorage.drives.retrieve(
-## Filestorage FieldMapping -
client.filestorage.field_mapping.field_mappings_retrieve(...) +
client.ats.interviews.meta_post_retrieve()
@@ -18864,7 +18604,7 @@ client.filestorage.drives.retrieve(
-Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/). +Returns metadata for `ScheduledInterview` POSTs.
@@ -18885,7 +18625,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.field_mapping.field_mappings_retrieve() +client.ats.interviews.meta_post_retrieve() ``` @@ -18901,14 +18641,6 @@ client.filestorage.field_mapping.field_mappings_retrieve()
-**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -18921,7 +18653,8 @@ client.filestorage.field_mapping.field_mappings_retrieve()
-
client.filestorage.field_mapping.field_mappings_create(...) +## Ats Issues +
client.ats.issues.list(...)
@@ -18933,7 +18666,7 @@ client.filestorage.field_mapping.field_mappings_retrieve()
-Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start. +Gets all issues for Organization.
@@ -18954,13 +18687,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.field_mapping.field_mappings_create( - target_field_name="example_target_field_name", - target_field_description="this is a example description of the target field", - remote_field_traversal_path=["example_remote_field"], - remote_method="GET", - remote_url_path="/example-url-path", - common_model_name="ExampleCommonModel", +client.ats.issues.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -18977,7 +18705,7 @@ client.filestorage.field_mapping.field_mappings_create(
-**target_field_name:** `str` — The name of the target field you want this remote field to map to. +**account_token:** `typing.Optional[str]`
@@ -18985,7 +18713,7 @@ client.filestorage.field_mapping.field_mappings_create(
-**target_field_description:** `str` — The description of the target field you want this remote field to map to. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -18993,7 +18721,7 @@ client.filestorage.field_mapping.field_mappings_create(
-**remote_field_traversal_path:** `typing.Sequence[typing.Optional[typing.Any]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint. +**end_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred before this time
@@ -19001,7 +18729,7 @@ client.filestorage.field_mapping.field_mappings_create(
-**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from. +**end_user_organization_name:** `typing.Optional[str]`
@@ -19009,7 +18737,7 @@ client.filestorage.field_mapping.field_mappings_create(
-**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from. +**first_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was after this datetime.
@@ -19017,7 +18745,7 @@ client.filestorage.field_mapping.field_mappings_create(
-**common_model_name:** `str` — The name of the Common Model that the remote field corresponds to in a given category. +**first_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was before this datetime.
@@ -19025,7 +18753,68 @@ client.filestorage.field_mapping.field_mappings_create(
-**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations. +**include_muted:** `typing.Optional[str]` — If true, will include muted issues + +
+
+ +
+
+ +**integration_name:** `typing.Optional[str]` + +
+
+ +
+
+ +**last_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was after this datetime. + +
+
+ +
+
+ +**last_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was before this datetime. + +
+
+ +
+
+ +**linked_account_id:** `typing.Optional[str]` — If provided, will only include issues pertaining to the linked account passed in. + +
+
+ +
+
+ +**page_size:** `typing.Optional[int]` — Number of results to return per page. + +
+
+ +
+
+ +**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time + +
+
+ +
+
+ +**status:** `typing.Optional[IssuesListRequestStatus]` + +Status of the issue. Options: ('ONGOING', 'RESOLVED') + +* `ONGOING` - ONGOING +* `RESOLVED` - RESOLVED
@@ -19045,7 +18834,7 @@ client.filestorage.field_mapping.field_mappings_create(
-
client.filestorage.field_mapping.field_mappings_destroy(...) +
client.ats.issues.retrieve(...)
@@ -19057,7 +18846,7 @@ client.filestorage.field_mapping.field_mappings_create(
-Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start. +Get a specific issue.
@@ -19078,8 +18867,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.field_mapping.field_mappings_destroy( - field_mapping_id="field_mapping_id", +client.ats.issues.retrieve( + id="id", ) ``` @@ -19096,7 +18885,7 @@ client.filestorage.field_mapping.field_mappings_destroy(
-**field_mapping_id:** `str` +**id:** `str`
@@ -19116,7 +18905,8 @@ client.filestorage.field_mapping.field_mappings_destroy(
-
client.filestorage.field_mapping.field_mappings_partial_update(...) +## Ats JobInterviewStages +
client.ats.job_interview_stages.list(...)
@@ -19128,7 +18918,7 @@ client.filestorage.field_mapping.field_mappings_destroy(
-Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start. +Returns a list of `JobInterviewStage` objects.
@@ -19149,8 +18939,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.field_mapping.field_mappings_partial_update( - field_mapping_id="field_mapping_id", +client.ats.job_interview_stages.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -19167,7 +18957,7 @@ client.filestorage.field_mapping.field_mappings_partial_update(
-**field_mapping_id:** `str` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -19175,7 +18965,7 @@ client.filestorage.field_mapping.field_mappings_partial_update(
-**remote_field_traversal_path:** `typing.Optional[typing.Sequence[typing.Optional[typing.Any]]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -19183,7 +18973,7 @@ client.filestorage.field_mapping.field_mappings_partial_update(
-**remote_method:** `typing.Optional[str]` — The method of the remote endpoint where the remote field is coming from. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -19191,7 +18981,7 @@ client.filestorage.field_mapping.field_mappings_partial_update(
-**remote_url_path:** `typing.Optional[str]` — The path of the remote endpoint where the remote field is coming from. +**expand:** `typing.Optional[typing.Literal["job"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -19199,68 +18989,55 @@ client.filestorage.field_mapping.field_mappings_partial_update(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
- -
+
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +
-
-
client.filestorage.field_mapping.remote_fields_retrieve(...)
-#### 📝 Description - -
-
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
-Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/). -
-
+**job_id:** `typing.Optional[str]` — If provided, will only return interview stages for this job. +
-#### 🔌 Usage - -
-
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.filestorage.field_mapping.remote_fields_retrieve() - -``` -
-
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +
-#### ⚙️ Parameters -
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. + +
+
+
-**common_models:** `typing.Optional[str]` — A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -19268,7 +19045,7 @@ client.filestorage.field_mapping.remote_fields_retrieve()
-**include_example_values:** `typing.Optional[str]` — If true, will include example values, where available, for remote fields in the 3rd party platform. These examples come from active data from your customers. +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -19288,7 +19065,7 @@ client.filestorage.field_mapping.remote_fields_retrieve()
-
client.filestorage.field_mapping.target_fields_retrieve() +
client.ats.job_interview_stages.retrieve(...)
@@ -19300,7 +19077,7 @@ client.filestorage.field_mapping.remote_fields_retrieve()
-Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields. Organization-wide Target Fields are additional fields appended to the Merge Common Model for all Linked Accounts in a category. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/target-fields/). +Returns a `JobInterviewStage` object with the given `id`.
@@ -19321,7 +19098,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.field_mapping.target_fields_retrieve() +client.ats.job_interview_stages.retrieve( + id="id", +) ``` @@ -19337,6 +19116,38 @@ client.filestorage.field_mapping.target_fields_retrieve()
+**id:** `str` + +
+
+ +
+
+ +**expand:** `typing.Optional[typing.Literal["job"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
+ +
+
+ +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+ +
+
+ +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -19349,8 +19160,8 @@ client.filestorage.field_mapping.target_fields_retrieve()
-## Filestorage Files -
client.filestorage.files.list(...) +## Ats JobPostings +
client.ats.job_postings.list(...)
@@ -19362,7 +19173,7 @@ client.filestorage.field_mapping.target_fields_retrieve()
-Returns a list of `File` objects. +Returns a list of `JobPosting` objects.
@@ -19383,7 +19194,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.files.list() +client.ats.job_postings.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -19423,23 +19236,7 @@ client.filestorage.files.list()
-**drive_id:** `typing.Optional[str]` — Specifying a drive id returns only the files in that drive. Specifying null returns only the files outside the top-level drive. - -
-
- -
-
- -**expand:** `typing.Optional[FilesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - -
-
- -
-
- -**folder_id:** `typing.Optional[str]` — Specifying a folder id returns only the files in that folder. Specifying null returns only the files in root directory. +**expand:** `typing.Optional[typing.Literal["job"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -19471,14 +19268,6 @@ client.filestorage.files.list()
-**mime_type:** `typing.Optional[str]` — If provided, will only return files with these mime_types. Multiple values can be separated by commas. - -
-
- -
-
- **modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -19495,7 +19284,7 @@ client.filestorage.files.list()
-**name:** `typing.Optional[str]` — If provided, will only return files with this name. This performs an exact match. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -19503,7 +19292,7 @@ client.filestorage.files.list()
-**order_by:** `typing.Optional[FilesListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: created_at, -created_at, modified_at, -modified_at. +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -19511,15 +19300,15 @@ client.filestorage.files.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. - -
-
+**status:** `typing.Optional[JobPostingsListRequestStatus]` -
-
+If provided, will only return Job Postings with this status. Options: ('PUBLISHED', 'CLOSED', 'DRAFT', 'INTERNAL', 'PENDING') -**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +* `PUBLISHED` - PUBLISHED +* `CLOSED` - CLOSED +* `DRAFT` - DRAFT +* `INTERNAL` - INTERNAL +* `PENDING` - PENDING
@@ -19539,7 +19328,7 @@ client.filestorage.files.list()
-
client.filestorage.files.create(...) +
client.ats.job_postings.retrieve(...)
@@ -19551,7 +19340,7 @@ client.filestorage.files.list()
-Creates a `File` object with the given values. +Returns a `JobPosting` object with the given `id`.
@@ -19567,14 +19356,13 @@ Creates a `File` object with the given values. ```python from merge import Merge -from merge.resources.filestorage import FileRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.files.create( - model=FileRequest(), +client.ats.job_postings.retrieve( + id="id", ) ``` @@ -19591,7 +19379,7 @@ client.filestorage.files.create(
-**model:** `FileRequest` +**id:** `str`
@@ -19599,7 +19387,7 @@ client.filestorage.files.create(
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +**expand:** `typing.Optional[typing.Literal["job"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -19607,7 +19395,15 @@ client.filestorage.files.create(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+ +
+
+ +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -19627,7 +19423,8 @@ client.filestorage.files.create(
-
client.filestorage.files.retrieve(...) +## Ats Jobs +
client.ats.jobs.list(...)
@@ -19639,7 +19436,7 @@ client.filestorage.files.create(
-Returns a `File` object with the given `id`. +Returns a list of `Job` objects.
@@ -19660,8 +19457,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.files.retrieve( - id="id", +client.ats.jobs.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -19678,7 +19475,7 @@ client.filestorage.files.retrieve(
-**id:** `str` +**code:** `typing.Optional[str]` — If provided, will only return jobs with this code.
@@ -19686,7 +19483,39 @@ client.filestorage.files.retrieve(
-**expand:** `typing.Optional[FilesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. + +
+
+ +
+
+ +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` — The pagination cursor value. + +
+
+ +
+
+ +**expand:** `typing.Optional[JobsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
+ +
+
+ +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -19710,6 +19539,78 @@ client.filestorage.files.retrieve(
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. + +
+
+ +
+
+ +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. + +
+
+ +
+
+ +**offices:** `typing.Optional[str]` — If provided, will only return jobs for this office; multiple offices can be separated by commas. + +
+
+ +
+
+ +**page_size:** `typing.Optional[int]` — Number of results to return per page. + +
+
+ +
+
+ +**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins. + +
+
+ +
+
+ +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. + +
+
+ +
+
+ +**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) + +
+
+ +
+
+ +**status:** `typing.Optional[JobsListRequestStatus]` + +If provided, will only return jobs with this status. Options: ('OPEN', 'CLOSED', 'DRAFT', 'ARCHIVED', 'PENDING') + +* `OPEN` - OPEN +* `CLOSED` - CLOSED +* `DRAFT` - DRAFT +* `ARCHIVED` - ARCHIVED +* `PENDING` - PENDING + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -19722,7 +19623,7 @@ client.filestorage.files.retrieve(
-
client.filestorage.files.download_request_meta_retrieve(...) +
client.ats.jobs.retrieve(...)
@@ -19734,7 +19635,7 @@ client.filestorage.files.retrieve(
-Returns metadata to construct an authenticated file download request for a singular file, allowing you to download file directly from the third-party. +Returns a `Job` object with the given `id`.
@@ -19755,7 +19656,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.files.download_request_meta_retrieve( +client.ats.jobs.retrieve( id="id", ) @@ -19781,7 +19682,39 @@ client.filestorage.files.download_request_meta_retrieve(
-**mime_type:** `typing.Optional[str]` — If provided, specifies the export format of the file to be downloaded. For information on supported export formats, please refer to our export format help center article. +**expand:** `typing.Optional[JobsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
+ +
+
+ +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+ +
+
+ +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
+ +
+
+ +**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins. + +
+
+ +
+
+ +**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
@@ -19801,7 +19734,7 @@ client.filestorage.files.download_request_meta_retrieve(
-
client.filestorage.files.download_request_meta_list(...) +
client.ats.jobs.screening_questions_list(...)
@@ -19813,7 +19746,7 @@ client.filestorage.files.download_request_meta_retrieve(
-Returns metadata to construct authenticated file download requests, allowing you to download files directly from the third-party. +Returns a list of `ScreeningQuestion` objects.
@@ -19834,7 +19767,10 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.files.download_request_meta_list() +client.ats.jobs.screening_questions_list( + job_id="job_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -19850,15 +19786,7 @@ client.filestorage.files.download_request_meta_list()
-**created_after:** `typing.Optional[str]` — If provided, will only return objects created after this datetime. - -
-
- -
-
- -**created_before:** `typing.Optional[str]` — If provided, will only return objects created before this datetime. +**job_id:** `str`
@@ -19874,15 +19802,7 @@ client.filestorage.files.download_request_meta_list()
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). - -
-
- -
-
- -**mime_types:** `typing.Optional[str]` — A comma-separated list of preferred MIME types in order of priority. If supported by the third-party provider, the file(s) will be returned in the first supported MIME type from the list. The default MIME type is PDF. To see supported MIME types by file type, refer to our export format help center article. +**expand:** `typing.Optional[JobsScreeningQuestionsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -19890,7 +19810,7 @@ client.filestorage.files.download_request_meta_list()
-**modified_after:** `typing.Optional[str]` — If provided, will only return objects modified after this datetime. +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -19898,7 +19818,7 @@ client.filestorage.files.download_request_meta_list()
-**modified_before:** `typing.Optional[str]` — If provided, will only return objects modified before this datetime. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -19906,7 +19826,7 @@ client.filestorage.files.download_request_meta_list()
-**order_by:** `typing.Optional[FilesDownloadRequestMetaListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: created_at, -created_at, modified_at, -modified_at. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -19934,7 +19854,8 @@ client.filestorage.files.download_request_meta_list()
-
client.filestorage.files.meta_post_retrieve() +## Ats LinkToken +
client.ats.link_token.create(...)
@@ -19946,7 +19867,7 @@ client.filestorage.files.download_request_meta_list()
-Returns metadata for `FileStorageFile` POSTs. +Creates a link token to be used when linking a new end user.
@@ -19962,12 +19883,18 @@ Returns metadata for `FileStorageFile` POSTs. ```python from merge import Merge +from merge.resources.ats import CategoriesEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.files.meta_post_retrieve() +client.ats.link_token.create( + end_user_email_address="example@gmail.com", + end_user_organization_name="Test Organization", + end_user_origin_id="12345", + categories=[CategoriesEnum.HRIS, CategoriesEnum.ATS], +) ``` @@ -19983,6 +19910,122 @@ client.filestorage.files.meta_post_retrieve()
+**end_user_email_address:** `str` — Your end user's email address. This is purely for identification purposes - setting this value will not cause any emails to be sent. + +
+
+ +
+
+ +**end_user_organization_name:** `str` — Your end user's organization. + +
+
+ +
+
+ +**end_user_origin_id:** `str` — This unique identifier typically represents the ID for your end user in your product's database. This value must be distinct from other Linked Accounts' unique identifiers. + +
+
+ +
+
+ +**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link. + +
+
+ +
+
+ +**integration:** `typing.Optional[str]` — The slug of a specific pre-selected integration for this linking flow token. For examples of slugs, see https://docs.merge.dev/guides/merge-link/single-integration/. + +
+
+ +
+
+ +**link_expiry_mins:** `typing.Optional[int]` — An integer number of minutes between [30, 720 or 10080 if for a Magic Link URL] for how long this token is valid. Defaults to 30. + +
+
+ +
+
+ +**should_create_magic_link_url:** `typing.Optional[bool]` — Whether to generate a Magic Link URL. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link. + +
+
+ +
+
+ +**hide_admin_magic_link:** `typing.Optional[bool]` — Whether to generate a Magic Link URL on the Admin Needed screen during the linking flow. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link. + +
+
+ +
+
+ +**common_models:** `typing.Optional[typing.Sequence[CommonModelScopesBodyRequest]]` — An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account. + +
+
+ +
+
+ +**category_common_model_scopes:** `typing.Optional[ + typing.Dict[ + str, + typing.Optional[ + typing.Sequence[IndividualCommonModelScopeDeserializerRequest] + ], + ] +]` — When creating a Link Token, you can set permissions for Common Models that will apply to the account that is going to be linked. Any model or field not specified in link token payload will default to existing settings. + +
+
+ +
+
+ +**language:** `typing.Optional[EndUserDetailsRequestLanguage]` + +The following subset of IETF language tags can be used to configure localization. + +* `en` - en +* `de` - de + +
+
+ +
+
+ +**are_syncs_disabled:** `typing.Optional[bool]` — The boolean that indicates whether initial, periodic, and force syncs will be disabled. + +
+
+ +
+
+ +**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — A JSON object containing integration-specific configuration options. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -19995,8 +20038,8 @@ client.filestorage.files.meta_post_retrieve()
-## Filestorage Folders -
client.filestorage.folders.list(...) +## Ats LinkedAccounts +
client.ats.linked_accounts.list(...)
@@ -20008,7 +20051,7 @@ client.filestorage.files.meta_post_retrieve()
-Returns a list of `Folder` objects. +List linked accounts for your organization.
@@ -20029,7 +20072,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.folders.list() +client.ats.linked_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -20045,15 +20090,17 @@ client.filestorage.folders.list()
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. - -
-
+**category:** `typing.Optional[LinkedAccountsListRequestCategory]` -
-
+Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing` -**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +* `hris` - hris +* `ats` - ats +* `accounting` - accounting +* `ticketing` - ticketing +* `crm` - crm +* `mktg` - mktg +* `filestorage` - filestorage
@@ -20069,7 +20116,7 @@ client.filestorage.folders.list()
-**drive_id:** `typing.Optional[str]` — If provided, will only return folders in this drive. +**end_user_email_address:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given email address.
@@ -20077,7 +20124,7 @@ client.filestorage.folders.list()
-**expand:** `typing.Optional[FoldersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**end_user_organization_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given organization name.
@@ -20085,7 +20132,7 @@ client.filestorage.folders.list()
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**end_user_origin_id:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given origin ID.
@@ -20093,7 +20140,7 @@ client.filestorage.folders.list()
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**end_user_origin_ids:** `typing.Optional[str]` — Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once.
@@ -20101,7 +20148,7 @@ client.filestorage.folders.list()
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**id:** `typing.Optional[str]`
@@ -20109,7 +20156,7 @@ client.filestorage.folders.list()
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**ids:** `typing.Optional[str]` — Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once.
@@ -20117,7 +20164,7 @@ client.filestorage.folders.list()
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**include_duplicates:** `typing.Optional[bool]` — If `true`, will include complete production duplicates of the account specified by the `id` query parameter in the response. `id` must be for a complete production linked account.
@@ -20125,7 +20172,7 @@ client.filestorage.folders.list()
-**name:** `typing.Optional[str]` — If provided, will only return folders with this name. This performs an exact match. +**integration_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given integration name.
@@ -20133,7 +20180,7 @@ client.filestorage.folders.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**is_test_account:** `typing.Optional[str]` — If included, will only include test linked accounts. If not included, will only include non-test linked accounts.
@@ -20141,7 +20188,7 @@ client.filestorage.folders.list()
-**parent_folder_id:** `typing.Optional[str]` — If provided, will only return folders in this parent folder. If null, will return folders in root directory. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -20149,7 +20196,7 @@ client.filestorage.folders.list()
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**status:** `typing.Optional[str]` — Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED`
@@ -20169,7 +20216,8 @@ client.filestorage.folders.list()
-
client.filestorage.folders.create(...) +## Ats Offers +
client.ats.offers.list(...)
@@ -20181,7 +20229,7 @@ client.filestorage.folders.list()
-Creates a `Folder` object with the given values. +Returns a list of `Offer` objects.
@@ -20197,14 +20245,13 @@ Creates a `Folder` object with the given values. ```python from merge import Merge -from merge.resources.filestorage import FolderRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.folders.create( - model=FolderRequest(), +client.ats.offers.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -20221,7 +20268,7 @@ client.filestorage.folders.create(
-**model:** `FolderRequest` +**application_id:** `typing.Optional[str]` — If provided, will only return offers for this application.
@@ -20229,7 +20276,7 @@ client.filestorage.folders.create(
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -20237,7 +20284,7 @@ client.filestorage.folders.create(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -20245,70 +20292,71 @@ client.filestorage.folders.create(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**creator_id:** `typing.Optional[str]` — If provided, will only return offers created by this user.
- -
+
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value. +
-
-
client.filestorage.folders.retrieve(...)
-#### 📝 Description +**expand:** `typing.Optional[OffersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). + +
+
+
-Returns a `Folder` object with the given `id`. -
-
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + -#### 🔌 Usage -
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
+
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.filestorage.folders.retrieve( - id="id", -) - -``` -
-
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. + -#### ⚙️ Parameters -
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. + +
+
+
-**id:** `str` +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -20316,7 +20364,7 @@ client.filestorage.folders.retrieve(
-**expand:** `typing.Optional[FoldersRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins.
@@ -20324,7 +20372,7 @@ client.filestorage.folders.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -20332,7 +20380,7 @@ client.filestorage.folders.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
@@ -20352,7 +20400,7 @@ client.filestorage.folders.retrieve(
-
client.filestorage.folders.meta_post_retrieve() +
client.ats.offers.retrieve(...)
@@ -20364,7 +20412,7 @@ client.filestorage.folders.retrieve(
-Returns metadata for `FileStorageFolder` POSTs. +Returns an `Offer` object with the given `id`.
@@ -20385,7 +20433,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.folders.meta_post_retrieve() +client.ats.offers.retrieve( + id="id", +) ``` @@ -20401,71 +20451,47 @@ client.filestorage.folders.meta_post_retrieve()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**id:** `str`
- -
+
+
+**expand:** `typing.Optional[OffersRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +
-
-## Filestorage GenerateKey -
client.filestorage.generate_key.create(...)
-#### 📝 Description - -
-
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
-Create a remote key. -
-
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +
-#### 🔌 Usage - -
-
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.filestorage.generate_key.create( - name="Remote Deployment Key 1", -) - -``` -
-
+**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins. +
-#### ⚙️ Parameters - -
-
-
-**name:** `str` — The name of the remote key +**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
@@ -20485,8 +20511,8 @@ client.filestorage.generate_key.create(
-## Filestorage Groups -
client.filestorage.groups.list(...) +## Ats Offices +
client.ats.offices.list(...)
@@ -20498,7 +20524,7 @@ client.filestorage.generate_key.create(
-Returns a list of `Group` objects. +Returns a list of `Office` objects.
@@ -20519,7 +20545,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.groups.list() +client.ats.offices.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -20559,14 +20587,6 @@ client.filestorage.groups.list()
-**expand:** `typing.Optional[typing.Literal["child_groups"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - -
-
- -
-
- **include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -20635,7 +20655,7 @@ client.filestorage.groups.list()
-
client.filestorage.groups.retrieve(...) +
client.ats.offices.retrieve(...)
@@ -20647,7 +20667,7 @@ client.filestorage.groups.list()
-Returns a `Group` object with the given `id`. +Returns an `Office` object with the given `id`.
@@ -20668,7 +20688,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.groups.retrieve( +client.ats.offices.retrieve( id="id", ) @@ -20694,14 +20714,6 @@ client.filestorage.groups.retrieve(
-**expand:** `typing.Optional[typing.Literal["child_groups"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - -
-
- -
-
- **include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -20730,8 +20742,8 @@ client.filestorage.groups.retrieve(
-## Filestorage Issues -
client.filestorage.issues.list(...) +## Ats Passthrough +
client.ats.passthrough.create(...)
@@ -20743,7 +20755,7 @@ client.filestorage.groups.retrieve(
-Gets all issues for Organization. +Pull data from an endpoint not currently supported by Merge.
@@ -20759,12 +20771,18 @@ Gets all issues for Organization. ```python from merge import Merge +from merge.resources.ats import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.issues.list() +client.ats.passthrough.create( + request=DataPassthroughRequest( + method=MethodEnum.GET, + path="/scooters", + ), +) ``` @@ -20780,7 +20798,7 @@ client.filestorage.issues.list()
-**account_token:** `typing.Optional[str]` +**request:** `DataPassthroughRequest`
@@ -20788,108 +20806,71 @@ client.filestorage.issues.list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
- -
-
- -**end_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred before this time -
-
-
-**end_user_organization_name:** `typing.Optional[str]` -
+
+## Ats RegenerateKey +
client.ats.regenerate_key.create(...)
-**first_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was after this datetime. - -
-
+#### 📝 Description
-**first_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was before this datetime. - -
-
-
-**include_muted:** `typing.Optional[str]` — If true, will include muted issues - +Exchange remote keys.
- -
-
- -**integration_name:** `typing.Optional[str]` -
+#### 🔌 Usage +
-**last_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was after this datetime. - -
-
-
-**last_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was before this datetime. - -
-
+```python +from merge import Merge -
-
+client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ats.regenerate_key.create( + name="Remote Deployment Key 1", +) -**linked_account_id:** `typing.Optional[str]` — If provided, will only include issues pertaining to the linked account passed in. - +```
- -
-
- -**page_size:** `typing.Optional[int]` — Number of results to return per page. -
+#### ⚙️ Parameters +
-**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time - -
-
-
-**status:** `typing.Optional[IssuesListRequestStatus]` - -Status of the issue. Options: ('ONGOING', 'RESOLVED') - -* `ONGOING` - ONGOING -* `RESOLVED` - RESOLVED +**name:** `str` — The name of the remote key
@@ -20909,7 +20890,8 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-
client.filestorage.issues.retrieve(...) +## Ats RejectReasons +
client.ats.reject_reasons.list(...)
@@ -20921,7 +20903,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-Get a specific issue. +Returns a list of `RejectReason` objects.
@@ -20942,8 +20924,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.issues.retrieve( - id="id", +client.ats.reject_reasons.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -20960,7 +20942,7 @@ client.filestorage.issues.retrieve(
-**id:** `str` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -20968,75 +20950,39 @@ client.filestorage.issues.retrieve(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
- -
- - - -
- -## Filestorage LinkToken -
client.filestorage.link_token.create(...)
-#### 📝 Description - -
-
+**cursor:** `typing.Optional[str]` — The pagination cursor value. + +
+
-Creates a link token to be used when linking a new end user. -
-
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +
-#### 🔌 Usage -
-
-
- -```python -from merge import Merge -from merge.resources.filestorage import CategoriesEnum - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.filestorage.link_token.create( - end_user_email_address="example@gmail.com", - end_user_organization_name="Test Organization", - end_user_origin_id="12345", - categories=[CategoriesEnum.HRIS, CategoriesEnum.ATS], -) - -``` -
-
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +
-#### ⚙️ Parameters -
-
-
- -**end_user_email_address:** `str` — Your end user's email address. This is purely for identification purposes - setting this value will not cause any emails to be sent. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -21044,7 +20990,7 @@ client.filestorage.link_token.create(
-**end_user_organization_name:** `str` — Your end user's organization. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -21052,7 +20998,7 @@ client.filestorage.link_token.create(
-**end_user_origin_id:** `str` — This unique identifier typically represents the ID for your end user in your product's database. This value must be distinct from other Linked Accounts' unique identifiers. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -21060,7 +21006,7 @@ client.filestorage.link_token.create(
-**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -21068,7 +21014,7 @@ client.filestorage.link_token.create(
-**integration:** `typing.Optional[str]` — The slug of a specific pre-selected integration for this linking flow token. For examples of slugs, see https://docs.merge.dev/guides/merge-link/single-integration/. +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -21076,59 +21022,70 @@ client.filestorage.link_token.create(
-**link_expiry_mins:** `typing.Optional[int]` — An integer number of minutes between [30, 720 or 10080 if for a Magic Link URL] for how long this token is valid. Defaults to 30. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
-
-
-**should_create_magic_link_url:** `typing.Optional[bool]` — Whether to generate a Magic Link URL. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link. -
+
+
client.ats.reject_reasons.retrieve(...)
-**hide_admin_magic_link:** `typing.Optional[bool]` — Whether to generate a Magic Link URL on the Admin Needed screen during the linking flow. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link. - -
-
+#### 📝 Description
-**common_models:** `typing.Optional[typing.Sequence[CommonModelScopesBodyRequest]]` — An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account. - +
+
+ +Returns a `RejectReason` object with the given `id`. +
+
+#### 🔌 Usage +
-**category_common_model_scopes:** `typing.Optional[ - typing.Dict[ - str, - typing.Optional[ - typing.Sequence[IndividualCommonModelScopeDeserializerRequest] - ], - ] -]` — When creating a Link Token, you can set permissions for Common Models that will apply to the account that is going to be linked. Any model or field not specified in link token payload will default to existing settings. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ats.reject_reasons.retrieve( + id="id", +) + +```
+
+
+ +#### ⚙️ Parameters
-**language:** `typing.Optional[LanguageEnum]` - -The following subset of IETF language tags can be used to configure localization. +
+
-* `en` - en -* `de` - de +**id:** `str`
@@ -21136,7 +21093,7 @@ The following subset of IETF language tags can be used to configure localization
-**are_syncs_disabled:** `typing.Optional[bool]` — The boolean that indicates whether initial, periodic, and force syncs will be disabled. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -21144,7 +21101,7 @@ The following subset of IETF language tags can be used to configure localization
-**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — A JSON object containing integration-specific configuration options. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -21164,8 +21121,8 @@ The following subset of IETF language tags can be used to configure localization
-## Filestorage LinkedAccounts -
client.filestorage.linked_accounts.list(...) +## Ats Scorecards +
client.ats.scorecards.list(...)
@@ -21177,7 +21134,7 @@ The following subset of IETF language tags can be used to configure localization
-List linked accounts for your organization. +Returns a list of `Scorecard` objects.
@@ -21198,7 +21155,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.linked_accounts.list() +client.ats.scorecards.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -21214,17 +21173,15 @@ client.filestorage.linked_accounts.list()
-**category:** `typing.Optional[LinkedAccountsListRequestCategory]` +**application_id:** `typing.Optional[str]` — If provided, will only return scorecards for this application. + +
+
-Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing` +
+
-* `hris` - hris -* `ats` - ats -* `accounting` - accounting -* `ticketing` - ticketing -* `crm` - crm -* `mktg` - mktg -* `filestorage` - filestorage +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -21232,7 +21189,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -21240,7 +21197,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**end_user_email_address:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given email address. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -21248,7 +21205,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**end_user_organization_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given organization name. +**expand:** `typing.Optional[ScorecardsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -21256,7 +21213,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**end_user_origin_id:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given origin ID. +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -21264,7 +21221,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**end_user_origin_ids:** `typing.Optional[str]` — Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -21272,7 +21229,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**id:** `typing.Optional[str]` +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -21280,7 +21237,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**ids:** `typing.Optional[str]` — Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once. +**interview_id:** `typing.Optional[str]` — If provided, will only return scorecards for this interview.
@@ -21288,7 +21245,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**include_duplicates:** `typing.Optional[bool]` — If `true`, will include complete production duplicates of the account specified by the `id` query parameter in the response. `id` must be for a complete production linked account. +**interviewer_id:** `typing.Optional[str]` — If provided, will only return scorecards for this interviewer.
@@ -21296,7 +21253,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**integration_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given integration name. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -21304,7 +21261,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**is_test_account:** `typing.Optional[str]` — If included, will only include test linked accounts. If not included, will only include non-test linked accounts. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -21320,7 +21277,23 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**status:** `typing.Optional[str]` — Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED` +**remote_fields:** `typing.Optional[typing.Literal["overall_recommendation"]]` — Deprecated. Use show_enum_origins. + +
+
+ +
+
+ +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. + +
+
+ +
+
+ +**show_enum_origins:** `typing.Optional[typing.Literal["overall_recommendation"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
@@ -21340,8 +21313,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-## Filestorage Passthrough -
client.filestorage.passthrough.create(...) +
client.ats.scorecards.retrieve(...)
@@ -21353,7 +21325,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-Pull data from an endpoint not currently supported by Merge. +Returns a `Scorecard` object with the given `id`.
@@ -21369,17 +21341,13 @@ Pull data from an endpoint not currently supported by Merge. ```python from merge import Merge -from merge.resources.filestorage import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.passthrough.create( - request=DataPassthroughRequest( - method=MethodEnum.GET, - path="/scooters", - ), +client.ats.scorecards.retrieve( + id="id", ) ``` @@ -21396,7 +21364,7 @@ client.filestorage.passthrough.create(
-**request:** `DataPassthroughRequest` +**id:** `str`
@@ -21404,71 +21372,39 @@ client.filestorage.passthrough.create(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**expand:** `typing.Optional[ScorecardsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
- -
- - - - -
-## Filestorage RegenerateKey -
client.filestorage.regenerate_key.create(...)
-#### 📝 Description - -
-
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
-Exchange remote keys. -
-
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +
-#### 🔌 Usage - -
-
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.filestorage.regenerate_key.create( - name="Remote Deployment Key 1", -) - -``` -
-
+**remote_fields:** `typing.Optional[typing.Literal["overall_recommendation"]]` — Deprecated. Use show_enum_origins. +
-#### ⚙️ Parameters -
-
-
- -**name:** `str` — The name of the remote key +**show_enum_origins:** `typing.Optional[typing.Literal["overall_recommendation"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
@@ -21488,8 +21424,8 @@ client.filestorage.regenerate_key.create(
-## Filestorage SyncStatus -
client.filestorage.sync_status.list(...) +## Ats SyncStatus +
client.ats.sync_status.list(...)
@@ -21522,7 +21458,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.sync_status.list() +client.ats.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ```
@@ -21566,8 +21504,8 @@ client.filestorage.sync_status.list()
-## Filestorage ForceResync -
client.filestorage.force_resync.sync_status_resync_create() +## Ats ForceResync +
client.ats.force_resync.sync_status_resync_create()
@@ -21600,7 +21538,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.force_resync.sync_status_resync_create() +client.ats.force_resync.sync_status_resync_create() ```
@@ -21628,8 +21566,8 @@ client.filestorage.force_resync.sync_status_resync_create()
-## Filestorage Users -
client.filestorage.users.list(...) +## Ats Tags +
client.ats.tags.list(...)
@@ -21641,7 +21579,7 @@ client.filestorage.force_resync.sync_status_resync_create()
-Returns a list of `User` objects. +Returns a list of `Tag` objects.
@@ -21662,7 +21600,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.users.list() +client.ats.tags.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -21726,7 +21666,151 @@ client.filestorage.users.list()
-**is_me:** `typing.Optional[str]` — If provided, will only return the user object for requestor. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. + +
+
+ +
+
+ +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. + +
+
+ +
+
+ +**page_size:** `typing.Optional[int]` — Number of results to return per page. + +
+
+ +
+
+ +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+ +
+ + + + +
+ +## Ats Users +
client.ats.users.list(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns a list of `RemoteUser` objects. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ats.users.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. + +
+
+ +
+
+ +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` — The pagination cursor value. + +
+
+ +
+
+ +**email:** `typing.Optional[str]` — If provided, will only return remote users with the given email address + +
+
+ +
+
+ +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). + +
+
+ +
+
+ +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+ +
+
+ +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -21758,6 +21842,14 @@ client.filestorage.users.list()
+**remote_fields:** `typing.Optional[typing.Literal["access_role"]]` — Deprecated. Use show_enum_origins. + +
+
+ +
+
+ **remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -21766,6 +21858,14 @@ client.filestorage.users.list()
+**show_enum_origins:** `typing.Optional[typing.Literal["access_role"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -21778,7 +21878,7 @@ client.filestorage.users.list()
-
client.filestorage.users.retrieve(...) +
client.ats.users.retrieve(...)
@@ -21790,7 +21890,7 @@ client.filestorage.users.list()
-Returns a `User` object with the given `id`. +Returns a `RemoteUser` object with the given `id`.
@@ -21811,7 +21911,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.users.retrieve( +client.ats.users.retrieve( id="id", ) @@ -21853,6 +21953,22 @@ client.filestorage.users.retrieve(
+**remote_fields:** `typing.Optional[typing.Literal["access_role"]]` — Deprecated. Use show_enum_origins. + +
+
+ +
+
+ +**show_enum_origins:** `typing.Optional[typing.Literal["access_role"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -21865,8 +21981,8 @@ client.filestorage.users.retrieve(
-## Filestorage WebhookReceivers -
client.filestorage.webhook_receivers.list() +## Ats WebhookReceivers +
client.ats.webhook_receivers.list()
@@ -21899,7 +22015,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.webhook_receivers.list() +client.ats.webhook_receivers.list() ```
@@ -21927,7 +22043,7 @@ client.filestorage.webhook_receivers.list()
-
client.filestorage.webhook_receivers.create(...) +
client.ats.webhook_receivers.create(...)
@@ -21960,7 +22076,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.webhook_receivers.create( +client.ats.webhook_receivers.create( event="event", is_active=True, ) @@ -22330,7 +22446,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.audit_trail.list() +client.hris.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ```
@@ -22502,7 +22620,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.bank_info.list() +client.hris.bank_info.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -22816,7 +22936,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.benefits.list() +client.hris.benefits.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -23069,7 +23191,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.companies.list() +client.hris.companies.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -23583,7 +23707,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.dependents.list() +client.hris.dependents.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -23828,7 +23954,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employee_payroll_runs.list() +client.hris.employee_payroll_runs.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -24121,7 +24249,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employees.list() +client.hris.employees.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -24810,7 +24940,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employer_benefits.list() +client.hris.employer_benefits.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -25039,7 +25171,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employments.list() +client.hris.employments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -25902,7 +26036,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.groups.list() +client.hris.groups.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -26187,7 +26323,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.issues.list() +client.hris.issues.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -26621,7 +26759,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.linked_accounts.list() +client.hris.linked_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -26797,7 +26937,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.locations.list() +client.hris.locations.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -27147,7 +27289,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.pay_groups.list() +client.hris.pay_groups.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -27376,7 +27520,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.payroll_runs.list() +client.hris.payroll_runs.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -27757,7 +27903,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.sync_status.list() +client.hris.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -27897,7 +28045,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.teams.list() +client.hris.teams.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -28150,7 +28300,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.time_off.list() +client.hris.time_off.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -28657,7 +28809,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.time_off_balances.list() +client.hris.time_off_balances.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -28959,7 +29113,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.timesheet_entries.list() +client.hris.timesheet_entries.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -29685,7 +29841,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.accounts.list() +client.ticketing.accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -30061,7 +30219,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.attachments.list() +client.ticketing.attachments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -30471,7 +30631,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.audit_trail.list() +client.ticketing.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -30643,7 +30805,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.collections.list() +client.ticketing.collections.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -30826,6 +30990,7 @@ client = Merge( ) client.ticketing.collections.viewers_list( collection_id="collection_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -31055,7 +31220,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.comments.list() +client.ticketing.comments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -31465,7 +31632,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.contacts.list() +client.ticketing.contacts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -31505,6 +31674,14 @@ client.ticketing.contacts.list()
+**email_address:** `typing.Optional[str]` — If provided, will only return Contacts that match this email. + +
+
+ +
+
+ **expand:** `typing.Optional[typing.Literal["account"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -32714,7 +32891,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.issues.list() +client.ticketing.issues.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -33148,7 +33327,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.linked_accounts.list() +client.ticketing.linked_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -33400,7 +33581,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.projects.list() +client.ticketing.projects.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -33630,6 +33813,7 @@ client = Merge( ) client.ticketing.projects.users_list( parent_id="parent_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -33820,7 +34004,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.roles.list() +client.ticketing.roles.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -34049,7 +34235,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.sync_status.list() +client.ticketing.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -34189,7 +34377,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.tags.list() +client.ticketing.tags.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -34418,7 +34608,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.teams.list() +client.ticketing.teams.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -34647,7 +34839,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.tickets.list() +client.ticketing.tickets.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -34727,6 +34921,14 @@ client.ticketing.tickets.list()
+**creator_id:** `typing.Optional[str]` — If provided, will only return tickets created by this creator_id. + +
+
+ +
+
+ **cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -35277,6 +35479,7 @@ client = Merge( ) client.ticketing.tickets.viewers_list( ticket_id="ticket_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -35542,7 +35745,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.tickets.remote_field_classes_list() +client.ticketing.tickets.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -35668,7 +35873,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.users.list() +client.ticketing.users.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -36213,7 +36420,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.accounting_periods.list() +client.accounting.accounting_periods.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -36402,7 +36611,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.accounts.list() +client.accounting.accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -37191,7 +37402,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.attachments.list() +client.accounting.attachments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -37577,7 +37790,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.audit_trail.list() +client.accounting.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -37749,7 +37964,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.balance_sheets.list() +client.accounting.balance_sheets.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -38002,7 +38219,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.bank_feed_accounts.list() +client.accounting.bank_feed_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -38340,7 +38559,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.bank_feed_transactions.list() +client.accounting.bank_feed_transactions.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -38742,7 +38963,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.cash_flow_statements.list() +client.accounting.cash_flow_statements.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -38995,7 +39218,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.company_info.list() +client.accounting.company_info.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -39240,7 +39465,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.contacts.list() +client.accounting.contacts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -39729,7 +39956,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.contacts.remote_field_classes_list() +client.accounting.contacts.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -39847,7 +40076,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.credit_notes.list() +client.accounting.credit_notes.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -40582,7 +40813,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.employees.list() +client.accounting.employees.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -40835,7 +41068,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.expense_reports.list() +client.accounting.expense_reports.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -41095,6 +41330,7 @@ client = Merge( ) client.accounting.expense_reports.lines_list( expense_report_id="expense_report_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -41323,7 +41559,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.expense_reports.lines_remote_field_classes_list() +client.accounting.expense_reports.lines_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -41501,7 +41739,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.expense_reports.remote_field_classes_list() +client.accounting.expense_reports.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -41619,7 +41859,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.expenses.list() +client.accounting.expenses.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -41991,7 +42233,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.expenses.lines_remote_field_classes_list() +client.accounting.expenses.lines_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -42169,7 +42413,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.expenses.remote_field_classes_list() +client.accounting.expenses.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -42785,7 +43031,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.general_ledger_transactions.list() +client.accounting.general_ledger_transactions.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -43126,7 +43374,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.income_statements.list() +client.accounting.income_statements.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -43379,7 +43629,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.invoices.list() +client.accounting.invoices.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -43928,7 +44180,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.invoices.line_items_remote_field_classes_list() +client.accounting.invoices.line_items_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -44177,7 +44431,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.invoices.remote_field_classes_list() +client.accounting.invoices.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -44295,7 +44551,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.issues.list() +client.accounting.issues.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -44545,7 +44803,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.items.list() +client.accounting.items.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -45147,7 +45407,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.journal_entries.list() +client.accounting.journal_entries.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -45519,7 +45781,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.journal_entries.lines_remote_field_classes_list() +client.accounting.journal_entries.lines_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -45697,7 +45961,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.journal_entries.remote_field_classes_list() +client.accounting.journal_entries.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -45999,7 +46265,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.linked_accounts.list() +client.accounting.linked_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -46251,7 +46519,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.payment_methods.list() +client.accounting.payment_methods.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -46440,7 +46710,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.payment_terms.list() +client.accounting.payment_terms.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -46645,7 +46917,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.payments.list() +client.accounting.payments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -47130,7 +47404,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.payments.line_items_remote_field_classes_list() +client.accounting.payments.line_items_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -47379,7 +47655,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.payments.remote_field_classes_list() +client.accounting.payments.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -47585,7 +47863,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.projects.list() +client.accounting.projects.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -47838,7 +48118,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.purchase_orders.list() +client.accounting.purchase_orders.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -48242,7 +48524,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.purchase_orders.line_items_remote_field_classes_list() +client.accounting.purchase_orders.line_items_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -48420,7 +48704,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.purchase_orders.remote_field_classes_list() +client.accounting.purchase_orders.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -48610,7 +48896,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.sync_status.list() +client.accounting.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -48750,7 +49038,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.tax_rates.list() +client.accounting.tax_rates.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -49011,7 +49301,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.tracking_categories.list() +client.accounting.tracking_categories.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -49320,7 +49612,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.transactions.list() +client.accounting.transactions.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -49589,7 +49883,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.vendor_credits.list() +client.accounting.vendor_credits.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` diff --git a/src/merge/client.py b/src/merge/client.py index c55e9a2a..52e368a9 100644 --- a/src/merge/client.py +++ b/src/merge/client.py @@ -82,9 +82,9 @@ def __init__( else httpx.Client(timeout=_defaulted_timeout), timeout=_defaulted_timeout, ) - self.ats = AtsClient(client_wrapper=self._client_wrapper) self.crm = CrmClient(client_wrapper=self._client_wrapper) self.filestorage = FilestorageClient(client_wrapper=self._client_wrapper) + self.ats = AtsClient(client_wrapper=self._client_wrapper) self.hris = HrisClient(client_wrapper=self._client_wrapper) self.ticketing = TicketingClient(client_wrapper=self._client_wrapper) self.accounting = AccountingClient(client_wrapper=self._client_wrapper) @@ -159,9 +159,9 @@ def __init__( else httpx.AsyncClient(timeout=_defaulted_timeout), timeout=_defaulted_timeout, ) - self.ats = AsyncAtsClient(client_wrapper=self._client_wrapper) self.crm = AsyncCrmClient(client_wrapper=self._client_wrapper) self.filestorage = AsyncFilestorageClient(client_wrapper=self._client_wrapper) + self.ats = AsyncAtsClient(client_wrapper=self._client_wrapper) self.hris = AsyncHrisClient(client_wrapper=self._client_wrapper) self.ticketing = AsyncTicketingClient(client_wrapper=self._client_wrapper) self.accounting = AsyncAccountingClient(client_wrapper=self._client_wrapper) diff --git a/src/merge/core/client_wrapper.py b/src/merge/core/client_wrapper.py index 955b5565..87d533b8 100644 --- a/src/merge/core/client_wrapper.py +++ b/src/merge/core/client_wrapper.py @@ -24,10 +24,10 @@ def __init__( def get_headers(self) -> typing.Dict[str, str]: headers: typing.Dict[str, str] = { - "User-Agent": "MergePythonClient/2.1.1", + "User-Agent": "MergePythonClient/2.2.0", "X-Fern-Language": "Python", "X-Fern-SDK-Name": "MergePythonClient", - "X-Fern-SDK-Version": "2.1.1", + "X-Fern-SDK-Version": "2.2.0", **(self.get_custom_headers() or {}), } if self._account_token is not None: diff --git a/src/merge/core/force_multipart.py b/src/merge/core/force_multipart.py index ae24ccff..5440913f 100644 --- a/src/merge/core/force_multipart.py +++ b/src/merge/core/force_multipart.py @@ -1,7 +1,9 @@ # This file was auto-generated by Fern from our API Definition. +from typing import Any, Dict -class ForceMultipartDict(dict): + +class ForceMultipartDict(Dict[str, Any]): """ A dictionary subclass that always evaluates to True in boolean contexts. @@ -9,7 +11,7 @@ class ForceMultipartDict(dict): the dictionary is empty, which would normally evaluate to False. """ - def __bool__(self): + def __bool__(self) -> bool: return True diff --git a/src/merge/core/http_response.py b/src/merge/core/http_response.py index 48a1798a..2479747e 100644 --- a/src/merge/core/http_response.py +++ b/src/merge/core/http_response.py @@ -4,8 +4,8 @@ import httpx +# Generic to represent the underlying type of the data wrapped by the HTTP response. T = TypeVar("T") -"""Generic to represent the underlying type of the data wrapped by the HTTP response.""" class BaseHttpResponse: diff --git a/src/merge/core/unchecked_base_model.py b/src/merge/core/unchecked_base_model.py index e04a6f81..ae59845f 100644 --- a/src/merge/core/unchecked_base_model.py +++ b/src/merge/core/unchecked_base_model.py @@ -186,7 +186,7 @@ def _convert_undiscriminated_union_type(union_type: typing.Type[typing.Any], obj def _convert_union_type(type_: typing.Type[typing.Any], object_: typing.Any) -> typing.Any: base_type = get_origin(type_) or type_ union_type = type_ - if base_type == typing_extensions.Annotated: + if base_type == typing_extensions.Annotated: # type: ignore[comparison-overlap] union_type = get_args(type_)[0] annotated_metadata = get_args(type_)[1:] for metadata in annotated_metadata: @@ -217,11 +217,11 @@ def construct_type(*, type_: typing.Type[typing.Any], object_: typing.Any) -> ty return None base_type = get_origin(type_) or type_ - is_annotated = base_type == typing_extensions.Annotated + is_annotated = base_type == typing_extensions.Annotated # type: ignore[comparison-overlap] maybe_annotation_members = get_args(type_) is_annotated_union = is_annotated and is_union(get_origin(maybe_annotation_members[0])) - if base_type == typing.Any: + if base_type == typing.Any: # type: ignore[comparison-overlap] return object_ if base_type == dict: diff --git a/src/merge/resources/accounting/__init__.py b/src/merge/resources/accounting/__init__.py index ce637e34..ec735200 100644 --- a/src/merge/resources/accounting/__init__.py +++ b/src/merge/resources/accounting/__init__.py @@ -79,7 +79,9 @@ CommonModelScopeApi, CommonModelScopesBodyRequest, CompanyInfo, + CompanyInfoAddressesItem, CompanyInfoCurrency, + CompanyInfoPhoneNumbersItem, ComponentTypeEnum, Contact, ContactAddressesItem, @@ -129,6 +131,7 @@ CreditOrDebitEnum, DataPassthroughRequest, DataPassthroughRequestMethod, + DataPassthroughRequestRequestFormat, DebugModeLog, DebugModelLogSummary, Employee, @@ -164,17 +167,22 @@ ExpenseLineTrackingCategoriesItem, ExpenseLineTrackingCategory, ExpenseReport, + ExpenseReportAccountingPeriod, ExpenseReportCompany, + ExpenseReportCurrency, + ExpenseReportEmployee, ExpenseReportLine, ExpenseReportLineAccount, ExpenseReportLineCompany, ExpenseReportLineContact, + ExpenseReportLineCurrency, ExpenseReportLineEmployee, ExpenseReportLineProject, ExpenseReportLineRequest, ExpenseReportLineRequestAccount, ExpenseReportLineRequestCompany, ExpenseReportLineRequestContact, + ExpenseReportLineRequestCurrency, ExpenseReportLineRequestEmployee, ExpenseReportLineRequestProject, ExpenseReportLineRequestTaxRate, @@ -182,6 +190,7 @@ ExpenseReportRequest, ExpenseReportRequestAccountingPeriod, ExpenseReportRequestCompany, + ExpenseReportRequestCurrency, ExpenseReportRequestEmployee, ExpenseReportResponse, ExpenseReportStatus, @@ -265,6 +274,7 @@ InvoiceRequestContact, InvoiceRequestCurrency, InvoiceRequestEmployee, + InvoiceRequestLineItemsItem, InvoiceRequestPaymentTerm, InvoiceRequestPaymentsItem, InvoiceRequestPurchaseOrdersItem, @@ -310,6 +320,7 @@ JournalEntryRequest, JournalEntryRequestCompany, JournalEntryRequestCurrency, + JournalEntryRequestLinesItem, JournalEntryRequestPaymentsItem, JournalEntryRequestPostingStatus, JournalEntryRequestTrackingCategoriesItem, @@ -372,6 +383,9 @@ PaginatedTrackingCategoryList, PaginatedTransactionList, PaginatedVendorCreditList, + PatchedContactEndpointRequest, + PatchedContactRequest, + PatchedContactRequestStatus, PatchedItemRequestRequest, PatchedItemRequestRequestStatus, PatchedItemRequestRequestType, @@ -379,7 +393,6 @@ PatchedPaymentRequestAccount, PatchedPaymentRequestAccountingPeriod, PatchedPaymentRequestAppliedToLinesItem, - PatchedPaymentRequestCompany, PatchedPaymentRequestContact, PatchedPaymentRequestCurrency, PatchedPaymentRequestPaymentMethod, @@ -454,6 +467,7 @@ RemoteFieldRequestRemoteFieldClass, RemoteKey, RemoteResponse, + RemoteResponseResponseType, ReportItem, RequestFormatEnum, ResponseTypeEnum, @@ -477,6 +491,7 @@ Transaction, TransactionAccount, TransactionAccountingPeriod, + TransactionCompany, TransactionContact, TransactionCurrency, TransactionCurrencyEnum, @@ -505,6 +520,7 @@ VendorCreditLineRequestAccount, VendorCreditLineRequestContact, VendorCreditLineRequestProject, + VendorCreditLinesItem, VendorCreditRequest, VendorCreditRequestAccountingPeriod, VendorCreditRequestCompany, @@ -692,8 +708,10 @@ "CommonModelScopeApi", "CommonModelScopesBodyRequest", "CompanyInfo", + "CompanyInfoAddressesItem", "CompanyInfoCurrency", "CompanyInfoListRequestExpand", + "CompanyInfoPhoneNumbersItem", "CompanyInfoRetrieveRequestExpand", "ComponentTypeEnum", "Contact", @@ -752,6 +770,7 @@ "CreditOrDebitEnum", "DataPassthroughRequest", "DataPassthroughRequestMethod", + "DataPassthroughRequestRequestFormat", "DebugModeLog", "DebugModelLogSummary", "Employee", @@ -788,17 +807,22 @@ "ExpenseLineTrackingCategoriesItem", "ExpenseLineTrackingCategory", "ExpenseReport", + "ExpenseReportAccountingPeriod", "ExpenseReportCompany", + "ExpenseReportCurrency", + "ExpenseReportEmployee", "ExpenseReportLine", "ExpenseReportLineAccount", "ExpenseReportLineCompany", "ExpenseReportLineContact", + "ExpenseReportLineCurrency", "ExpenseReportLineEmployee", "ExpenseReportLineProject", "ExpenseReportLineRequest", "ExpenseReportLineRequestAccount", "ExpenseReportLineRequestCompany", "ExpenseReportLineRequestContact", + "ExpenseReportLineRequestCurrency", "ExpenseReportLineRequestEmployee", "ExpenseReportLineRequestProject", "ExpenseReportLineRequestTaxRate", @@ -806,6 +830,7 @@ "ExpenseReportRequest", "ExpenseReportRequestAccountingPeriod", "ExpenseReportRequestCompany", + "ExpenseReportRequestCurrency", "ExpenseReportRequestEmployee", "ExpenseReportResponse", "ExpenseReportStatus", @@ -896,6 +921,7 @@ "InvoiceRequestContact", "InvoiceRequestCurrency", "InvoiceRequestEmployee", + "InvoiceRequestLineItemsItem", "InvoiceRequestPaymentTerm", "InvoiceRequestPaymentsItem", "InvoiceRequestPurchaseOrdersItem", @@ -950,6 +976,7 @@ "JournalEntryRequest", "JournalEntryRequestCompany", "JournalEntryRequestCurrency", + "JournalEntryRequestLinesItem", "JournalEntryRequestPaymentsItem", "JournalEntryRequestPostingStatus", "JournalEntryRequestTrackingCategoriesItem", @@ -1013,6 +1040,9 @@ "PaginatedTrackingCategoryList", "PaginatedTransactionList", "PaginatedVendorCreditList", + "PatchedContactEndpointRequest", + "PatchedContactRequest", + "PatchedContactRequestStatus", "PatchedItemRequestRequest", "PatchedItemRequestRequestStatus", "PatchedItemRequestRequestType", @@ -1020,7 +1050,6 @@ "PatchedPaymentRequestAccount", "PatchedPaymentRequestAccountingPeriod", "PatchedPaymentRequestAppliedToLinesItem", - "PatchedPaymentRequestCompany", "PatchedPaymentRequestContact", "PatchedPaymentRequestCurrency", "PatchedPaymentRequestPaymentMethod", @@ -1101,6 +1130,7 @@ "RemoteFieldRequestRemoteFieldClass", "RemoteKey", "RemoteResponse", + "RemoteResponseResponseType", "ReportItem", "RequestFormatEnum", "ResponseTypeEnum", @@ -1124,6 +1154,7 @@ "Transaction", "TransactionAccount", "TransactionAccountingPeriod", + "TransactionCompany", "TransactionContact", "TransactionCurrency", "TransactionCurrencyEnum", @@ -1154,6 +1185,7 @@ "VendorCreditLineRequestAccount", "VendorCreditLineRequestContact", "VendorCreditLineRequestProject", + "VendorCreditLinesItem", "VendorCreditRequest", "VendorCreditRequestAccountingPeriod", "VendorCreditRequestCompany", diff --git a/src/merge/resources/accounting/resources/accounting_periods/client.py b/src/merge/resources/accounting/resources/accounting_periods/client.py index 4008dfb9..ea3dd2a4 100644 --- a/src/merge/resources/accounting/resources/accounting_periods/client.py +++ b/src/merge/resources/accounting/resources/accounting_periods/client.py @@ -70,7 +70,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.accounting_periods.list() + client.accounting.accounting_periods.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( cursor=cursor, @@ -198,7 +200,9 @@ async def list( async def main() -> None: - await client.accounting.accounting_periods.list() + await client.accounting.accounting_periods.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/accounts/client.py b/src/merge/resources/accounting/resources/accounts/client.py index 66260f6f..2cd1cb34 100644 --- a/src/merge/resources/accounting/resources/accounts/client.py +++ b/src/merge/resources/accounting/resources/accounts/client.py @@ -133,7 +133,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.accounts.list() + client.accounting.accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( account_type=account_type, @@ -415,7 +417,9 @@ async def list( async def main() -> None: - await client.accounting.accounts.list() + await client.accounting.accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/attachments/client.py b/src/merge/resources/accounting/resources/attachments/client.py index 4cd8b43c..ca9a16a7 100644 --- a/src/merge/resources/accounting/resources/attachments/client.py +++ b/src/merge/resources/accounting/resources/attachments/client.py @@ -101,7 +101,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.attachments.list() + client.accounting.attachments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( company_id=company_id, @@ -333,7 +335,9 @@ async def list( async def main() -> None: - await client.accounting.attachments.list() + await client.accounting.attachments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/audit_trail/client.py b/src/merge/resources/accounting/resources/audit_trail/client.py index 6d0d1886..be175372 100644 --- a/src/merge/resources/accounting/resources/audit_trail/client.py +++ b/src/merge/resources/accounting/resources/audit_trail/client.py @@ -73,7 +73,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.audit_trail.list() + client.accounting.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( cursor=cursor, @@ -157,7 +159,9 @@ async def list( async def main() -> None: - await client.accounting.audit_trail.list() + await client.accounting.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/balance_sheets/client.py b/src/merge/resources/accounting/resources/balance_sheets/client.py index 3f90d213..9f18736a 100644 --- a/src/merge/resources/accounting/resources/balance_sheets/client.py +++ b/src/merge/resources/accounting/resources/balance_sheets/client.py @@ -99,7 +99,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.balance_sheets.list() + client.accounting.balance_sheets.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( company_id=company_id, @@ -267,7 +269,9 @@ async def list( async def main() -> None: - await client.accounting.balance_sheets.list() + await client.accounting.balance_sheets.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/bank_feed_accounts/client.py b/src/merge/resources/accounting/resources/bank_feed_accounts/client.py index b1368bdf..0063c805 100644 --- a/src/merge/resources/accounting/resources/bank_feed_accounts/client.py +++ b/src/merge/resources/accounting/resources/bank_feed_accounts/client.py @@ -76,7 +76,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.bank_feed_accounts.list() + client.accounting.bank_feed_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( cursor=cursor, @@ -278,7 +280,9 @@ async def list( async def main() -> None: - await client.accounting.bank_feed_accounts.list() + await client.accounting.bank_feed_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/bank_feed_transactions/client.py b/src/merge/resources/accounting/resources/bank_feed_transactions/client.py index e8408b1d..5def8262 100644 --- a/src/merge/resources/accounting/resources/bank_feed_transactions/client.py +++ b/src/merge/resources/accounting/resources/bank_feed_transactions/client.py @@ -105,7 +105,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.bank_feed_transactions.list() + client.accounting.bank_feed_transactions.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -347,7 +349,9 @@ async def list( async def main() -> None: - await client.accounting.bank_feed_transactions.list() + await client.accounting.bank_feed_transactions.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/cash_flow_statements/client.py b/src/merge/resources/accounting/resources/cash_flow_statements/client.py index 59b2a40e..632235a4 100644 --- a/src/merge/resources/accounting/resources/cash_flow_statements/client.py +++ b/src/merge/resources/accounting/resources/cash_flow_statements/client.py @@ -99,7 +99,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.cash_flow_statements.list() + client.accounting.cash_flow_statements.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( company_id=company_id, @@ -267,7 +269,9 @@ async def list( async def main() -> None: - await client.accounting.cash_flow_statements.list() + await client.accounting.cash_flow_statements.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/company_info/client.py b/src/merge/resources/accounting/resources/company_info/client.py index 342b4fbc..a4a4fbc6 100644 --- a/src/merge/resources/accounting/resources/company_info/client.py +++ b/src/merge/resources/accounting/resources/company_info/client.py @@ -97,7 +97,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.company_info.list() + client.accounting.company_info.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -260,7 +262,9 @@ async def list( async def main() -> None: - await client.accounting.company_info.list() + await client.accounting.company_info.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/contacts/client.py b/src/merge/resources/accounting/resources/contacts/client.py index 6a425b25..66345884 100644 --- a/src/merge/resources/accounting/resources/contacts/client.py +++ b/src/merge/resources/accounting/resources/contacts/client.py @@ -140,7 +140,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.contacts.list() + client.accounting.contacts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( company_id=company_id, @@ -364,7 +366,9 @@ def remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.contacts.remote_field_classes_list() + client.accounting.contacts.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.remote_field_classes_list( cursor=cursor, @@ -505,7 +509,9 @@ async def list( async def main() -> None: - await client.accounting.contacts.list() + await client.accounting.contacts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -761,7 +767,9 @@ async def remote_field_classes_list( async def main() -> None: - await client.accounting.contacts.remote_field_classes_list() + await client.accounting.contacts.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/credit_notes/client.py b/src/merge/resources/accounting/resources/credit_notes/client.py index 91989aab..8b535864 100644 --- a/src/merge/resources/accounting/resources/credit_notes/client.py +++ b/src/merge/resources/accounting/resources/credit_notes/client.py @@ -127,7 +127,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.credit_notes.list() + client.accounting.credit_notes.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( company_id=company_id, @@ -399,7 +401,9 @@ async def list( async def main() -> None: - await client.accounting.credit_notes.list() + await client.accounting.credit_notes.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/employees/client.py b/src/merge/resources/accounting/resources/employees/client.py index eef0756f..73f4af0b 100644 --- a/src/merge/resources/accounting/resources/employees/client.py +++ b/src/merge/resources/accounting/resources/employees/client.py @@ -99,7 +99,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.employees.list() + client.accounting.employees.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( company_id=company_id, @@ -267,7 +269,9 @@ async def list( async def main() -> None: - await client.accounting.employees.list() + await client.accounting.employees.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/expense_reports/client.py b/src/merge/resources/accounting/resources/expense_reports/client.py index 2a30eb5f..0b2585d5 100644 --- a/src/merge/resources/accounting/resources/expense_reports/client.py +++ b/src/merge/resources/accounting/resources/expense_reports/client.py @@ -114,7 +114,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.expense_reports.list() + client.accounting.expense_reports.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( company_id=company_id, @@ -245,6 +247,7 @@ def lines_list( ) client.accounting.expense_reports.lines_list( expense_report_id="expense_report_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) """ _response = self._raw_client.lines_list( @@ -373,7 +376,9 @@ def lines_remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.expense_reports.lines_remote_field_classes_list() + client.accounting.expense_reports.lines_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.lines_remote_field_classes_list( cursor=cursor, @@ -468,7 +473,9 @@ def remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.expense_reports.remote_field_classes_list() + client.accounting.expense_reports.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.remote_field_classes_list( cursor=cursor, @@ -581,7 +588,9 @@ async def list( async def main() -> None: - await client.accounting.expense_reports.list() + await client.accounting.expense_reports.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -728,6 +737,7 @@ async def lines_list( async def main() -> None: await client.accounting.expense_reports.lines_list( expense_report_id="expense_report_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -872,7 +882,9 @@ async def lines_remote_field_classes_list( async def main() -> None: - await client.accounting.expense_reports.lines_remote_field_classes_list() + await client.accounting.expense_reports.lines_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -983,7 +995,9 @@ async def remote_field_classes_list( async def main() -> None: - await client.accounting.expense_reports.remote_field_classes_list() + await client.accounting.expense_reports.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/expenses/client.py b/src/merge/resources/accounting/resources/expenses/client.py index af655c88..c268fc18 100644 --- a/src/merge/resources/accounting/resources/expenses/client.py +++ b/src/merge/resources/accounting/resources/expenses/client.py @@ -120,7 +120,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.expenses.list() + client.accounting.expenses.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( company_id=company_id, @@ -302,7 +304,9 @@ def lines_remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.expenses.lines_remote_field_classes_list() + client.accounting.expenses.lines_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.lines_remote_field_classes_list( cursor=cursor, @@ -397,7 +401,9 @@ def remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.expenses.remote_field_classes_list() + client.accounting.expenses.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.remote_field_classes_list( cursor=cursor, @@ -518,7 +524,9 @@ async def list( async def main() -> None: - await client.accounting.expenses.list() + await client.accounting.expenses.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -724,7 +732,9 @@ async def lines_remote_field_classes_list( async def main() -> None: - await client.accounting.expenses.lines_remote_field_classes_list() + await client.accounting.expenses.lines_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -835,7 +845,9 @@ async def remote_field_classes_list( async def main() -> None: - await client.accounting.expenses.remote_field_classes_list() + await client.accounting.expenses.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/general_ledger_transactions/client.py b/src/merge/resources/accounting/resources/general_ledger_transactions/client.py index a4f2eff3..77139d04 100644 --- a/src/merge/resources/accounting/resources/general_ledger_transactions/client.py +++ b/src/merge/resources/accounting/resources/general_ledger_transactions/client.py @@ -109,7 +109,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.general_ledger_transactions.list() + client.accounting.general_ledger_transactions.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( company_id=company_id, @@ -287,7 +289,9 @@ async def list( async def main() -> None: - await client.accounting.general_ledger_transactions.list() + await client.accounting.general_ledger_transactions.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/income_statements/client.py b/src/merge/resources/accounting/resources/income_statements/client.py index 83d098da..79cd108f 100644 --- a/src/merge/resources/accounting/resources/income_statements/client.py +++ b/src/merge/resources/accounting/resources/income_statements/client.py @@ -99,7 +99,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.income_statements.list() + client.accounting.income_statements.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( company_id=company_id, @@ -267,7 +269,9 @@ async def list( async def main() -> None: - await client.accounting.income_statements.list() + await client.accounting.income_statements.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/invoices/client.py b/src/merge/resources/accounting/resources/invoices/client.py index d7cdb07f..f5a51718 100644 --- a/src/merge/resources/accounting/resources/invoices/client.py +++ b/src/merge/resources/accounting/resources/invoices/client.py @@ -156,7 +156,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.invoices.list() + client.accounting.invoices.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( company_id=company_id, @@ -407,7 +409,9 @@ def line_items_remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.invoices.line_items_remote_field_classes_list() + client.accounting.invoices.line_items_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.line_items_remote_field_classes_list( cursor=cursor, @@ -533,7 +537,9 @@ def remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.invoices.remote_field_classes_list() + client.accounting.invoices.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.remote_field_classes_list( cursor=cursor, @@ -688,7 +694,9 @@ async def list( async def main() -> None: - await client.accounting.invoices.list() + await client.accounting.invoices.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -971,7 +979,9 @@ async def line_items_remote_field_classes_list( async def main() -> None: - await client.accounting.invoices.line_items_remote_field_classes_list() + await client.accounting.invoices.line_items_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -1123,7 +1133,9 @@ async def remote_field_classes_list( async def main() -> None: - await client.accounting.invoices.remote_field_classes_list() + await client.accounting.invoices.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/issues/client.py b/src/merge/resources/accounting/resources/issues/client.py index 68e0cc48..18eec115 100644 --- a/src/merge/resources/accounting/resources/issues/client.py +++ b/src/merge/resources/accounting/resources/issues/client.py @@ -108,7 +108,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.issues.list() + client.accounting.issues.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( account_token=account_token, @@ -263,7 +265,9 @@ async def list( async def main() -> None: - await client.accounting.issues.list() + await client.accounting.issues.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/items/client.py b/src/merge/resources/accounting/resources/items/client.py index 395dd3e7..e66fe427 100644 --- a/src/merge/resources/accounting/resources/items/client.py +++ b/src/merge/resources/accounting/resources/items/client.py @@ -116,7 +116,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.items.list() + client.accounting.items.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( company_id=company_id, @@ -460,7 +462,9 @@ async def list( async def main() -> None: - await client.accounting.items.list() + await client.accounting.items.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/journal_entries/client.py b/src/merge/resources/accounting/resources/journal_entries/client.py index f35ff8eb..1a7d47ed 100644 --- a/src/merge/resources/accounting/resources/journal_entries/client.py +++ b/src/merge/resources/accounting/resources/journal_entries/client.py @@ -120,7 +120,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.journal_entries.list() + client.accounting.journal_entries.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( company_id=company_id, @@ -302,7 +304,9 @@ def lines_remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.journal_entries.lines_remote_field_classes_list() + client.accounting.journal_entries.lines_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.lines_remote_field_classes_list( cursor=cursor, @@ -397,7 +401,9 @@ def remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.journal_entries.remote_field_classes_list() + client.accounting.journal_entries.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.remote_field_classes_list( cursor=cursor, @@ -518,7 +524,9 @@ async def list( async def main() -> None: - await client.accounting.journal_entries.list() + await client.accounting.journal_entries.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -724,7 +732,9 @@ async def lines_remote_field_classes_list( async def main() -> None: - await client.accounting.journal_entries.lines_remote_field_classes_list() + await client.accounting.journal_entries.lines_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -835,7 +845,9 @@ async def remote_field_classes_list( async def main() -> None: - await client.accounting.journal_entries.remote_field_classes_list() + await client.accounting.journal_entries.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/linked_accounts/client.py b/src/merge/resources/accounting/resources/linked_accounts/client.py index df102c2b..2a5024cd 100644 --- a/src/merge/resources/accounting/resources/linked_accounts/client.py +++ b/src/merge/resources/accounting/resources/linked_accounts/client.py @@ -109,7 +109,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.linked_accounts.list() + client.accounting.linked_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( category=category, @@ -235,7 +237,9 @@ async def list( async def main() -> None: - await client.accounting.linked_accounts.list() + await client.accounting.linked_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/payment_methods/client.py b/src/merge/resources/accounting/resources/payment_methods/client.py index ee070e4f..2b8226d6 100644 --- a/src/merge/resources/accounting/resources/payment_methods/client.py +++ b/src/merge/resources/accounting/resources/payment_methods/client.py @@ -70,7 +70,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.payment_methods.list() + client.accounting.payment_methods.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( cursor=cursor, @@ -198,7 +200,9 @@ async def list( async def main() -> None: - await client.accounting.payment_methods.list() + await client.accounting.payment_methods.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/payment_terms/client.py b/src/merge/resources/accounting/resources/payment_terms/client.py index 7de8f6a7..7f0e7f70 100644 --- a/src/merge/resources/accounting/resources/payment_terms/client.py +++ b/src/merge/resources/accounting/resources/payment_terms/client.py @@ -74,7 +74,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.payment_terms.list() + client.accounting.payment_terms.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( cursor=cursor, @@ -212,7 +214,9 @@ async def list( async def main() -> None: - await client.accounting.payment_terms.list() + await client.accounting.payment_terms.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/payments/client.py b/src/merge/resources/accounting/resources/payments/client.py index 473acf56..c6fdbb43 100644 --- a/src/merge/resources/accounting/resources/payments/client.py +++ b/src/merge/resources/accounting/resources/payments/client.py @@ -129,7 +129,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.payments.list() + client.accounting.payments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( account_id=account_id, @@ -364,7 +366,9 @@ def line_items_remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.payments.line_items_remote_field_classes_list() + client.accounting.payments.line_items_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.line_items_remote_field_classes_list( cursor=cursor, @@ -490,7 +494,9 @@ def remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.payments.remote_field_classes_list() + client.accounting.payments.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.remote_field_classes_list( cursor=cursor, @@ -619,7 +625,9 @@ async def list( async def main() -> None: - await client.accounting.payments.list() + await client.accounting.payments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -886,7 +894,9 @@ async def line_items_remote_field_classes_list( async def main() -> None: - await client.accounting.payments.line_items_remote_field_classes_list() + await client.accounting.payments.line_items_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -1038,7 +1048,9 @@ async def remote_field_classes_list( async def main() -> None: - await client.accounting.payments.remote_field_classes_list() + await client.accounting.payments.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/projects/client.py b/src/merge/resources/accounting/resources/projects/client.py index 4afffa7e..a7335b20 100644 --- a/src/merge/resources/accounting/resources/projects/client.py +++ b/src/merge/resources/accounting/resources/projects/client.py @@ -101,7 +101,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.projects.list() + client.accounting.projects.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( company_id=company_id, @@ -269,7 +271,9 @@ async def list( async def main() -> None: - await client.accounting.projects.list() + await client.accounting.projects.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/purchase_orders/client.py b/src/merge/resources/accounting/resources/purchase_orders/client.py index 4b7a1931..5b6a4ab6 100644 --- a/src/merge/resources/accounting/resources/purchase_orders/client.py +++ b/src/merge/resources/accounting/resources/purchase_orders/client.py @@ -128,7 +128,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.purchase_orders.list() + client.accounting.purchase_orders.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( company_id=company_id, @@ -322,7 +324,9 @@ def line_items_remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.purchase_orders.line_items_remote_field_classes_list() + client.accounting.purchase_orders.line_items_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.line_items_remote_field_classes_list( cursor=cursor, @@ -417,7 +421,9 @@ def remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.purchase_orders.remote_field_classes_list() + client.accounting.purchase_orders.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.remote_field_classes_list( cursor=cursor, @@ -546,7 +552,9 @@ async def list( async def main() -> None: - await client.accounting.purchase_orders.list() + await client.accounting.purchase_orders.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -764,7 +772,9 @@ async def line_items_remote_field_classes_list( async def main() -> None: - await client.accounting.purchase_orders.line_items_remote_field_classes_list() + await client.accounting.purchase_orders.line_items_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -875,7 +885,9 @@ async def remote_field_classes_list( async def main() -> None: - await client.accounting.purchase_orders.remote_field_classes_list() + await client.accounting.purchase_orders.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/sync_status/client.py b/src/merge/resources/accounting/resources/sync_status/client.py index b1158fdd..3c1b31e8 100644 --- a/src/merge/resources/accounting/resources/sync_status/client.py +++ b/src/merge/resources/accounting/resources/sync_status/client.py @@ -57,7 +57,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.sync_status.list() + client.accounting.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list(cursor=cursor, page_size=page_size, request_options=request_options) return _response.data @@ -117,7 +119,9 @@ async def list( async def main() -> None: - await client.accounting.sync_status.list() + await client.accounting.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/tax_rates/client.py b/src/merge/resources/accounting/resources/tax_rates/client.py index fa872829..29f1ca42 100644 --- a/src/merge/resources/accounting/resources/tax_rates/client.py +++ b/src/merge/resources/accounting/resources/tax_rates/client.py @@ -103,7 +103,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.tax_rates.list() + client.accounting.tax_rates.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( company_id=company_id, @@ -276,7 +278,9 @@ async def list( async def main() -> None: - await client.accounting.tax_rates.list() + await client.accounting.tax_rates.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/tracking_categories/client.py b/src/merge/resources/accounting/resources/tracking_categories/client.py index 61b7c215..bdd73f97 100644 --- a/src/merge/resources/accounting/resources/tracking_categories/client.py +++ b/src/merge/resources/accounting/resources/tracking_categories/client.py @@ -119,7 +119,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.tracking_categories.list() + client.accounting.tracking_categories.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( category_type=category_type, @@ -322,7 +324,9 @@ async def list( async def main() -> None: - await client.accounting.tracking_categories.list() + await client.accounting.tracking_categories.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/transactions/client.py b/src/merge/resources/accounting/resources/transactions/client.py index 68b26ccd..0dd5c1d1 100644 --- a/src/merge/resources/accounting/resources/transactions/client.py +++ b/src/merge/resources/accounting/resources/transactions/client.py @@ -109,7 +109,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.transactions.list() + client.accounting.transactions.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( company_id=company_id, @@ -287,7 +289,9 @@ async def list( async def main() -> None: - await client.accounting.transactions.list() + await client.accounting.transactions.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/transactions/types/transactions_list_request_expand.py b/src/merge/resources/accounting/resources/transactions/types/transactions_list_request_expand.py index 42abde42..8246398b 100644 --- a/src/merge/resources/accounting/resources/transactions/types/transactions_list_request_expand.py +++ b/src/merge/resources/accounting/resources/transactions/types/transactions_list_request_expand.py @@ -9,135 +9,276 @@ class TransactionsListRequestExpand(str, enum.Enum): ACCOUNT = "account" ACCOUNT_ACCOUNTING_PERIOD = "account,accounting_period" + ACCOUNT_COMPANY = "account,company" + ACCOUNT_COMPANY_ACCOUNTING_PERIOD = "account,company,accounting_period" ACCOUNTING_PERIOD = "accounting_period" + COMPANY = "company" + COMPANY_ACCOUNTING_PERIOD = "company,accounting_period" CONTACT = "contact" CONTACT_ACCOUNT = "contact,account" CONTACT_ACCOUNT_ACCOUNTING_PERIOD = "contact,account,accounting_period" + CONTACT_ACCOUNT_COMPANY = "contact,account,company" + CONTACT_ACCOUNT_COMPANY_ACCOUNTING_PERIOD = "contact,account,company,accounting_period" CONTACT_ACCOUNTING_PERIOD = "contact,accounting_period" + CONTACT_COMPANY = "contact,company" + CONTACT_COMPANY_ACCOUNTING_PERIOD = "contact,company,accounting_period" LINE_ITEMS = "line_items" LINE_ITEMS_ACCOUNT = "line_items,account" LINE_ITEMS_ACCOUNT_ACCOUNTING_PERIOD = "line_items,account,accounting_period" + LINE_ITEMS_ACCOUNT_COMPANY = "line_items,account,company" + LINE_ITEMS_ACCOUNT_COMPANY_ACCOUNTING_PERIOD = "line_items,account,company,accounting_period" LINE_ITEMS_ACCOUNTING_PERIOD = "line_items,accounting_period" + LINE_ITEMS_COMPANY = "line_items,company" + LINE_ITEMS_COMPANY_ACCOUNTING_PERIOD = "line_items,company,accounting_period" LINE_ITEMS_CONTACT = "line_items,contact" LINE_ITEMS_CONTACT_ACCOUNT = "line_items,contact,account" LINE_ITEMS_CONTACT_ACCOUNT_ACCOUNTING_PERIOD = "line_items,contact,account,accounting_period" + LINE_ITEMS_CONTACT_ACCOUNT_COMPANY = "line_items,contact,account,company" + LINE_ITEMS_CONTACT_ACCOUNT_COMPANY_ACCOUNTING_PERIOD = "line_items,contact,account,company,accounting_period" LINE_ITEMS_CONTACT_ACCOUNTING_PERIOD = "line_items,contact,accounting_period" + LINE_ITEMS_CONTACT_COMPANY = "line_items,contact,company" + LINE_ITEMS_CONTACT_COMPANY_ACCOUNTING_PERIOD = "line_items,contact,company,accounting_period" LINE_ITEMS_TRACKING_CATEGORIES = "line_items,tracking_categories" LINE_ITEMS_TRACKING_CATEGORIES_ACCOUNT = "line_items,tracking_categories,account" LINE_ITEMS_TRACKING_CATEGORIES_ACCOUNT_ACCOUNTING_PERIOD = ( "line_items,tracking_categories,account,accounting_period" ) + LINE_ITEMS_TRACKING_CATEGORIES_ACCOUNT_COMPANY = "line_items,tracking_categories,account,company" + LINE_ITEMS_TRACKING_CATEGORIES_ACCOUNT_COMPANY_ACCOUNTING_PERIOD = ( + "line_items,tracking_categories,account,company,accounting_period" + ) LINE_ITEMS_TRACKING_CATEGORIES_ACCOUNTING_PERIOD = "line_items,tracking_categories,accounting_period" + LINE_ITEMS_TRACKING_CATEGORIES_COMPANY = "line_items,tracking_categories,company" + LINE_ITEMS_TRACKING_CATEGORIES_COMPANY_ACCOUNTING_PERIOD = ( + "line_items,tracking_categories,company,accounting_period" + ) LINE_ITEMS_TRACKING_CATEGORIES_CONTACT = "line_items,tracking_categories,contact" LINE_ITEMS_TRACKING_CATEGORIES_CONTACT_ACCOUNT = "line_items,tracking_categories,contact,account" LINE_ITEMS_TRACKING_CATEGORIES_CONTACT_ACCOUNT_ACCOUNTING_PERIOD = ( "line_items,tracking_categories,contact,account,accounting_period" ) + LINE_ITEMS_TRACKING_CATEGORIES_CONTACT_ACCOUNT_COMPANY = "line_items,tracking_categories,contact,account,company" + LINE_ITEMS_TRACKING_CATEGORIES_CONTACT_ACCOUNT_COMPANY_ACCOUNTING_PERIOD = ( + "line_items,tracking_categories,contact,account,company,accounting_period" + ) LINE_ITEMS_TRACKING_CATEGORIES_CONTACT_ACCOUNTING_PERIOD = ( "line_items,tracking_categories,contact,accounting_period" ) + LINE_ITEMS_TRACKING_CATEGORIES_CONTACT_COMPANY = "line_items,tracking_categories,contact,company" + LINE_ITEMS_TRACKING_CATEGORIES_CONTACT_COMPANY_ACCOUNTING_PERIOD = ( + "line_items,tracking_categories,contact,company,accounting_period" + ) TRACKING_CATEGORIES = "tracking_categories" TRACKING_CATEGORIES_ACCOUNT = "tracking_categories,account" TRACKING_CATEGORIES_ACCOUNT_ACCOUNTING_PERIOD = "tracking_categories,account,accounting_period" + TRACKING_CATEGORIES_ACCOUNT_COMPANY = "tracking_categories,account,company" + TRACKING_CATEGORIES_ACCOUNT_COMPANY_ACCOUNTING_PERIOD = "tracking_categories,account,company,accounting_period" TRACKING_CATEGORIES_ACCOUNTING_PERIOD = "tracking_categories,accounting_period" + TRACKING_CATEGORIES_COMPANY = "tracking_categories,company" + TRACKING_CATEGORIES_COMPANY_ACCOUNTING_PERIOD = "tracking_categories,company,accounting_period" TRACKING_CATEGORIES_CONTACT = "tracking_categories,contact" TRACKING_CATEGORIES_CONTACT_ACCOUNT = "tracking_categories,contact,account" TRACKING_CATEGORIES_CONTACT_ACCOUNT_ACCOUNTING_PERIOD = "tracking_categories,contact,account,accounting_period" + TRACKING_CATEGORIES_CONTACT_ACCOUNT_COMPANY = "tracking_categories,contact,account,company" + TRACKING_CATEGORIES_CONTACT_ACCOUNT_COMPANY_ACCOUNTING_PERIOD = ( + "tracking_categories,contact,account,company,accounting_period" + ) TRACKING_CATEGORIES_CONTACT_ACCOUNTING_PERIOD = "tracking_categories,contact,accounting_period" + TRACKING_CATEGORIES_CONTACT_COMPANY = "tracking_categories,contact,company" + TRACKING_CATEGORIES_CONTACT_COMPANY_ACCOUNTING_PERIOD = "tracking_categories,contact,company,accounting_period" def visit( self, account: typing.Callable[[], T_Result], account_accounting_period: typing.Callable[[], T_Result], + account_company: typing.Callable[[], T_Result], + account_company_accounting_period: typing.Callable[[], T_Result], accounting_period: typing.Callable[[], T_Result], + company: typing.Callable[[], T_Result], + company_accounting_period: typing.Callable[[], T_Result], contact: typing.Callable[[], T_Result], contact_account: typing.Callable[[], T_Result], contact_account_accounting_period: typing.Callable[[], T_Result], + contact_account_company: typing.Callable[[], T_Result], + contact_account_company_accounting_period: typing.Callable[[], T_Result], contact_accounting_period: typing.Callable[[], T_Result], + contact_company: typing.Callable[[], T_Result], + contact_company_accounting_period: typing.Callable[[], T_Result], line_items: typing.Callable[[], T_Result], line_items_account: typing.Callable[[], T_Result], line_items_account_accounting_period: typing.Callable[[], T_Result], + line_items_account_company: typing.Callable[[], T_Result], + line_items_account_company_accounting_period: typing.Callable[[], T_Result], line_items_accounting_period: typing.Callable[[], T_Result], + line_items_company: typing.Callable[[], T_Result], + line_items_company_accounting_period: typing.Callable[[], T_Result], line_items_contact: typing.Callable[[], T_Result], line_items_contact_account: typing.Callable[[], T_Result], line_items_contact_account_accounting_period: typing.Callable[[], T_Result], + line_items_contact_account_company: typing.Callable[[], T_Result], + line_items_contact_account_company_accounting_period: typing.Callable[[], T_Result], line_items_contact_accounting_period: typing.Callable[[], T_Result], + line_items_contact_company: typing.Callable[[], T_Result], + line_items_contact_company_accounting_period: typing.Callable[[], T_Result], line_items_tracking_categories: typing.Callable[[], T_Result], line_items_tracking_categories_account: typing.Callable[[], T_Result], line_items_tracking_categories_account_accounting_period: typing.Callable[[], T_Result], + line_items_tracking_categories_account_company: typing.Callable[[], T_Result], + line_items_tracking_categories_account_company_accounting_period: typing.Callable[[], T_Result], line_items_tracking_categories_accounting_period: typing.Callable[[], T_Result], + line_items_tracking_categories_company: typing.Callable[[], T_Result], + line_items_tracking_categories_company_accounting_period: typing.Callable[[], T_Result], line_items_tracking_categories_contact: typing.Callable[[], T_Result], line_items_tracking_categories_contact_account: typing.Callable[[], T_Result], line_items_tracking_categories_contact_account_accounting_period: typing.Callable[[], T_Result], + line_items_tracking_categories_contact_account_company: typing.Callable[[], T_Result], + line_items_tracking_categories_contact_account_company_accounting_period: typing.Callable[[], T_Result], line_items_tracking_categories_contact_accounting_period: typing.Callable[[], T_Result], + line_items_tracking_categories_contact_company: typing.Callable[[], T_Result], + line_items_tracking_categories_contact_company_accounting_period: typing.Callable[[], T_Result], tracking_categories: typing.Callable[[], T_Result], tracking_categories_account: typing.Callable[[], T_Result], tracking_categories_account_accounting_period: typing.Callable[[], T_Result], + tracking_categories_account_company: typing.Callable[[], T_Result], + tracking_categories_account_company_accounting_period: typing.Callable[[], T_Result], tracking_categories_accounting_period: typing.Callable[[], T_Result], + tracking_categories_company: typing.Callable[[], T_Result], + tracking_categories_company_accounting_period: typing.Callable[[], T_Result], tracking_categories_contact: typing.Callable[[], T_Result], tracking_categories_contact_account: typing.Callable[[], T_Result], tracking_categories_contact_account_accounting_period: typing.Callable[[], T_Result], + tracking_categories_contact_account_company: typing.Callable[[], T_Result], + tracking_categories_contact_account_company_accounting_period: typing.Callable[[], T_Result], tracking_categories_contact_accounting_period: typing.Callable[[], T_Result], + tracking_categories_contact_company: typing.Callable[[], T_Result], + tracking_categories_contact_company_accounting_period: typing.Callable[[], T_Result], ) -> T_Result: if self is TransactionsListRequestExpand.ACCOUNT: return account() if self is TransactionsListRequestExpand.ACCOUNT_ACCOUNTING_PERIOD: return account_accounting_period() + if self is TransactionsListRequestExpand.ACCOUNT_COMPANY: + return account_company() + if self is TransactionsListRequestExpand.ACCOUNT_COMPANY_ACCOUNTING_PERIOD: + return account_company_accounting_period() if self is TransactionsListRequestExpand.ACCOUNTING_PERIOD: return accounting_period() + if self is TransactionsListRequestExpand.COMPANY: + return company() + if self is TransactionsListRequestExpand.COMPANY_ACCOUNTING_PERIOD: + return company_accounting_period() if self is TransactionsListRequestExpand.CONTACT: return contact() if self is TransactionsListRequestExpand.CONTACT_ACCOUNT: return contact_account() if self is TransactionsListRequestExpand.CONTACT_ACCOUNT_ACCOUNTING_PERIOD: return contact_account_accounting_period() + if self is TransactionsListRequestExpand.CONTACT_ACCOUNT_COMPANY: + return contact_account_company() + if self is TransactionsListRequestExpand.CONTACT_ACCOUNT_COMPANY_ACCOUNTING_PERIOD: + return contact_account_company_accounting_period() if self is TransactionsListRequestExpand.CONTACT_ACCOUNTING_PERIOD: return contact_accounting_period() + if self is TransactionsListRequestExpand.CONTACT_COMPANY: + return contact_company() + if self is TransactionsListRequestExpand.CONTACT_COMPANY_ACCOUNTING_PERIOD: + return contact_company_accounting_period() if self is TransactionsListRequestExpand.LINE_ITEMS: return line_items() if self is TransactionsListRequestExpand.LINE_ITEMS_ACCOUNT: return line_items_account() if self is TransactionsListRequestExpand.LINE_ITEMS_ACCOUNT_ACCOUNTING_PERIOD: return line_items_account_accounting_period() + if self is TransactionsListRequestExpand.LINE_ITEMS_ACCOUNT_COMPANY: + return line_items_account_company() + if self is TransactionsListRequestExpand.LINE_ITEMS_ACCOUNT_COMPANY_ACCOUNTING_PERIOD: + return line_items_account_company_accounting_period() if self is TransactionsListRequestExpand.LINE_ITEMS_ACCOUNTING_PERIOD: return line_items_accounting_period() + if self is TransactionsListRequestExpand.LINE_ITEMS_COMPANY: + return line_items_company() + if self is TransactionsListRequestExpand.LINE_ITEMS_COMPANY_ACCOUNTING_PERIOD: + return line_items_company_accounting_period() if self is TransactionsListRequestExpand.LINE_ITEMS_CONTACT: return line_items_contact() if self is TransactionsListRequestExpand.LINE_ITEMS_CONTACT_ACCOUNT: return line_items_contact_account() if self is TransactionsListRequestExpand.LINE_ITEMS_CONTACT_ACCOUNT_ACCOUNTING_PERIOD: return line_items_contact_account_accounting_period() + if self is TransactionsListRequestExpand.LINE_ITEMS_CONTACT_ACCOUNT_COMPANY: + return line_items_contact_account_company() + if self is TransactionsListRequestExpand.LINE_ITEMS_CONTACT_ACCOUNT_COMPANY_ACCOUNTING_PERIOD: + return line_items_contact_account_company_accounting_period() if self is TransactionsListRequestExpand.LINE_ITEMS_CONTACT_ACCOUNTING_PERIOD: return line_items_contact_accounting_period() + if self is TransactionsListRequestExpand.LINE_ITEMS_CONTACT_COMPANY: + return line_items_contact_company() + if self is TransactionsListRequestExpand.LINE_ITEMS_CONTACT_COMPANY_ACCOUNTING_PERIOD: + return line_items_contact_company_accounting_period() if self is TransactionsListRequestExpand.LINE_ITEMS_TRACKING_CATEGORIES: return line_items_tracking_categories() if self is TransactionsListRequestExpand.LINE_ITEMS_TRACKING_CATEGORIES_ACCOUNT: return line_items_tracking_categories_account() if self is TransactionsListRequestExpand.LINE_ITEMS_TRACKING_CATEGORIES_ACCOUNT_ACCOUNTING_PERIOD: return line_items_tracking_categories_account_accounting_period() + if self is TransactionsListRequestExpand.LINE_ITEMS_TRACKING_CATEGORIES_ACCOUNT_COMPANY: + return line_items_tracking_categories_account_company() + if self is TransactionsListRequestExpand.LINE_ITEMS_TRACKING_CATEGORIES_ACCOUNT_COMPANY_ACCOUNTING_PERIOD: + return line_items_tracking_categories_account_company_accounting_period() if self is TransactionsListRequestExpand.LINE_ITEMS_TRACKING_CATEGORIES_ACCOUNTING_PERIOD: return line_items_tracking_categories_accounting_period() + if self is TransactionsListRequestExpand.LINE_ITEMS_TRACKING_CATEGORIES_COMPANY: + return line_items_tracking_categories_company() + if self is TransactionsListRequestExpand.LINE_ITEMS_TRACKING_CATEGORIES_COMPANY_ACCOUNTING_PERIOD: + return line_items_tracking_categories_company_accounting_period() if self is TransactionsListRequestExpand.LINE_ITEMS_TRACKING_CATEGORIES_CONTACT: return line_items_tracking_categories_contact() if self is TransactionsListRequestExpand.LINE_ITEMS_TRACKING_CATEGORIES_CONTACT_ACCOUNT: return line_items_tracking_categories_contact_account() if self is TransactionsListRequestExpand.LINE_ITEMS_TRACKING_CATEGORIES_CONTACT_ACCOUNT_ACCOUNTING_PERIOD: return line_items_tracking_categories_contact_account_accounting_period() + if self is TransactionsListRequestExpand.LINE_ITEMS_TRACKING_CATEGORIES_CONTACT_ACCOUNT_COMPANY: + return line_items_tracking_categories_contact_account_company() + if ( + self + is TransactionsListRequestExpand.LINE_ITEMS_TRACKING_CATEGORIES_CONTACT_ACCOUNT_COMPANY_ACCOUNTING_PERIOD + ): + return line_items_tracking_categories_contact_account_company_accounting_period() if self is TransactionsListRequestExpand.LINE_ITEMS_TRACKING_CATEGORIES_CONTACT_ACCOUNTING_PERIOD: return line_items_tracking_categories_contact_accounting_period() + if self is TransactionsListRequestExpand.LINE_ITEMS_TRACKING_CATEGORIES_CONTACT_COMPANY: + return line_items_tracking_categories_contact_company() + if self is TransactionsListRequestExpand.LINE_ITEMS_TRACKING_CATEGORIES_CONTACT_COMPANY_ACCOUNTING_PERIOD: + return line_items_tracking_categories_contact_company_accounting_period() if self is TransactionsListRequestExpand.TRACKING_CATEGORIES: return tracking_categories() if self is TransactionsListRequestExpand.TRACKING_CATEGORIES_ACCOUNT: return tracking_categories_account() if self is TransactionsListRequestExpand.TRACKING_CATEGORIES_ACCOUNT_ACCOUNTING_PERIOD: return tracking_categories_account_accounting_period() + if self is TransactionsListRequestExpand.TRACKING_CATEGORIES_ACCOUNT_COMPANY: + return tracking_categories_account_company() + if self is TransactionsListRequestExpand.TRACKING_CATEGORIES_ACCOUNT_COMPANY_ACCOUNTING_PERIOD: + return tracking_categories_account_company_accounting_period() if self is TransactionsListRequestExpand.TRACKING_CATEGORIES_ACCOUNTING_PERIOD: return tracking_categories_accounting_period() + if self is TransactionsListRequestExpand.TRACKING_CATEGORIES_COMPANY: + return tracking_categories_company() + if self is TransactionsListRequestExpand.TRACKING_CATEGORIES_COMPANY_ACCOUNTING_PERIOD: + return tracking_categories_company_accounting_period() if self is TransactionsListRequestExpand.TRACKING_CATEGORIES_CONTACT: return tracking_categories_contact() if self is TransactionsListRequestExpand.TRACKING_CATEGORIES_CONTACT_ACCOUNT: return tracking_categories_contact_account() if self is TransactionsListRequestExpand.TRACKING_CATEGORIES_CONTACT_ACCOUNT_ACCOUNTING_PERIOD: return tracking_categories_contact_account_accounting_period() + if self is TransactionsListRequestExpand.TRACKING_CATEGORIES_CONTACT_ACCOUNT_COMPANY: + return tracking_categories_contact_account_company() + if self is TransactionsListRequestExpand.TRACKING_CATEGORIES_CONTACT_ACCOUNT_COMPANY_ACCOUNTING_PERIOD: + return tracking_categories_contact_account_company_accounting_period() if self is TransactionsListRequestExpand.TRACKING_CATEGORIES_CONTACT_ACCOUNTING_PERIOD: return tracking_categories_contact_accounting_period() + if self is TransactionsListRequestExpand.TRACKING_CATEGORIES_CONTACT_COMPANY: + return tracking_categories_contact_company() + if self is TransactionsListRequestExpand.TRACKING_CATEGORIES_CONTACT_COMPANY_ACCOUNTING_PERIOD: + return tracking_categories_contact_company_accounting_period() diff --git a/src/merge/resources/accounting/resources/transactions/types/transactions_retrieve_request_expand.py b/src/merge/resources/accounting/resources/transactions/types/transactions_retrieve_request_expand.py index 5d6d1ad2..89925077 100644 --- a/src/merge/resources/accounting/resources/transactions/types/transactions_retrieve_request_expand.py +++ b/src/merge/resources/accounting/resources/transactions/types/transactions_retrieve_request_expand.py @@ -9,135 +9,276 @@ class TransactionsRetrieveRequestExpand(str, enum.Enum): ACCOUNT = "account" ACCOUNT_ACCOUNTING_PERIOD = "account,accounting_period" + ACCOUNT_COMPANY = "account,company" + ACCOUNT_COMPANY_ACCOUNTING_PERIOD = "account,company,accounting_period" ACCOUNTING_PERIOD = "accounting_period" + COMPANY = "company" + COMPANY_ACCOUNTING_PERIOD = "company,accounting_period" CONTACT = "contact" CONTACT_ACCOUNT = "contact,account" CONTACT_ACCOUNT_ACCOUNTING_PERIOD = "contact,account,accounting_period" + CONTACT_ACCOUNT_COMPANY = "contact,account,company" + CONTACT_ACCOUNT_COMPANY_ACCOUNTING_PERIOD = "contact,account,company,accounting_period" CONTACT_ACCOUNTING_PERIOD = "contact,accounting_period" + CONTACT_COMPANY = "contact,company" + CONTACT_COMPANY_ACCOUNTING_PERIOD = "contact,company,accounting_period" LINE_ITEMS = "line_items" LINE_ITEMS_ACCOUNT = "line_items,account" LINE_ITEMS_ACCOUNT_ACCOUNTING_PERIOD = "line_items,account,accounting_period" + LINE_ITEMS_ACCOUNT_COMPANY = "line_items,account,company" + LINE_ITEMS_ACCOUNT_COMPANY_ACCOUNTING_PERIOD = "line_items,account,company,accounting_period" LINE_ITEMS_ACCOUNTING_PERIOD = "line_items,accounting_period" + LINE_ITEMS_COMPANY = "line_items,company" + LINE_ITEMS_COMPANY_ACCOUNTING_PERIOD = "line_items,company,accounting_period" LINE_ITEMS_CONTACT = "line_items,contact" LINE_ITEMS_CONTACT_ACCOUNT = "line_items,contact,account" LINE_ITEMS_CONTACT_ACCOUNT_ACCOUNTING_PERIOD = "line_items,contact,account,accounting_period" + LINE_ITEMS_CONTACT_ACCOUNT_COMPANY = "line_items,contact,account,company" + LINE_ITEMS_CONTACT_ACCOUNT_COMPANY_ACCOUNTING_PERIOD = "line_items,contact,account,company,accounting_period" LINE_ITEMS_CONTACT_ACCOUNTING_PERIOD = "line_items,contact,accounting_period" + LINE_ITEMS_CONTACT_COMPANY = "line_items,contact,company" + LINE_ITEMS_CONTACT_COMPANY_ACCOUNTING_PERIOD = "line_items,contact,company,accounting_period" LINE_ITEMS_TRACKING_CATEGORIES = "line_items,tracking_categories" LINE_ITEMS_TRACKING_CATEGORIES_ACCOUNT = "line_items,tracking_categories,account" LINE_ITEMS_TRACKING_CATEGORIES_ACCOUNT_ACCOUNTING_PERIOD = ( "line_items,tracking_categories,account,accounting_period" ) + LINE_ITEMS_TRACKING_CATEGORIES_ACCOUNT_COMPANY = "line_items,tracking_categories,account,company" + LINE_ITEMS_TRACKING_CATEGORIES_ACCOUNT_COMPANY_ACCOUNTING_PERIOD = ( + "line_items,tracking_categories,account,company,accounting_period" + ) LINE_ITEMS_TRACKING_CATEGORIES_ACCOUNTING_PERIOD = "line_items,tracking_categories,accounting_period" + LINE_ITEMS_TRACKING_CATEGORIES_COMPANY = "line_items,tracking_categories,company" + LINE_ITEMS_TRACKING_CATEGORIES_COMPANY_ACCOUNTING_PERIOD = ( + "line_items,tracking_categories,company,accounting_period" + ) LINE_ITEMS_TRACKING_CATEGORIES_CONTACT = "line_items,tracking_categories,contact" LINE_ITEMS_TRACKING_CATEGORIES_CONTACT_ACCOUNT = "line_items,tracking_categories,contact,account" LINE_ITEMS_TRACKING_CATEGORIES_CONTACT_ACCOUNT_ACCOUNTING_PERIOD = ( "line_items,tracking_categories,contact,account,accounting_period" ) + LINE_ITEMS_TRACKING_CATEGORIES_CONTACT_ACCOUNT_COMPANY = "line_items,tracking_categories,contact,account,company" + LINE_ITEMS_TRACKING_CATEGORIES_CONTACT_ACCOUNT_COMPANY_ACCOUNTING_PERIOD = ( + "line_items,tracking_categories,contact,account,company,accounting_period" + ) LINE_ITEMS_TRACKING_CATEGORIES_CONTACT_ACCOUNTING_PERIOD = ( "line_items,tracking_categories,contact,accounting_period" ) + LINE_ITEMS_TRACKING_CATEGORIES_CONTACT_COMPANY = "line_items,tracking_categories,contact,company" + LINE_ITEMS_TRACKING_CATEGORIES_CONTACT_COMPANY_ACCOUNTING_PERIOD = ( + "line_items,tracking_categories,contact,company,accounting_period" + ) TRACKING_CATEGORIES = "tracking_categories" TRACKING_CATEGORIES_ACCOUNT = "tracking_categories,account" TRACKING_CATEGORIES_ACCOUNT_ACCOUNTING_PERIOD = "tracking_categories,account,accounting_period" + TRACKING_CATEGORIES_ACCOUNT_COMPANY = "tracking_categories,account,company" + TRACKING_CATEGORIES_ACCOUNT_COMPANY_ACCOUNTING_PERIOD = "tracking_categories,account,company,accounting_period" TRACKING_CATEGORIES_ACCOUNTING_PERIOD = "tracking_categories,accounting_period" + TRACKING_CATEGORIES_COMPANY = "tracking_categories,company" + TRACKING_CATEGORIES_COMPANY_ACCOUNTING_PERIOD = "tracking_categories,company,accounting_period" TRACKING_CATEGORIES_CONTACT = "tracking_categories,contact" TRACKING_CATEGORIES_CONTACT_ACCOUNT = "tracking_categories,contact,account" TRACKING_CATEGORIES_CONTACT_ACCOUNT_ACCOUNTING_PERIOD = "tracking_categories,contact,account,accounting_period" + TRACKING_CATEGORIES_CONTACT_ACCOUNT_COMPANY = "tracking_categories,contact,account,company" + TRACKING_CATEGORIES_CONTACT_ACCOUNT_COMPANY_ACCOUNTING_PERIOD = ( + "tracking_categories,contact,account,company,accounting_period" + ) TRACKING_CATEGORIES_CONTACT_ACCOUNTING_PERIOD = "tracking_categories,contact,accounting_period" + TRACKING_CATEGORIES_CONTACT_COMPANY = "tracking_categories,contact,company" + TRACKING_CATEGORIES_CONTACT_COMPANY_ACCOUNTING_PERIOD = "tracking_categories,contact,company,accounting_period" def visit( self, account: typing.Callable[[], T_Result], account_accounting_period: typing.Callable[[], T_Result], + account_company: typing.Callable[[], T_Result], + account_company_accounting_period: typing.Callable[[], T_Result], accounting_period: typing.Callable[[], T_Result], + company: typing.Callable[[], T_Result], + company_accounting_period: typing.Callable[[], T_Result], contact: typing.Callable[[], T_Result], contact_account: typing.Callable[[], T_Result], contact_account_accounting_period: typing.Callable[[], T_Result], + contact_account_company: typing.Callable[[], T_Result], + contact_account_company_accounting_period: typing.Callable[[], T_Result], contact_accounting_period: typing.Callable[[], T_Result], + contact_company: typing.Callable[[], T_Result], + contact_company_accounting_period: typing.Callable[[], T_Result], line_items: typing.Callable[[], T_Result], line_items_account: typing.Callable[[], T_Result], line_items_account_accounting_period: typing.Callable[[], T_Result], + line_items_account_company: typing.Callable[[], T_Result], + line_items_account_company_accounting_period: typing.Callable[[], T_Result], line_items_accounting_period: typing.Callable[[], T_Result], + line_items_company: typing.Callable[[], T_Result], + line_items_company_accounting_period: typing.Callable[[], T_Result], line_items_contact: typing.Callable[[], T_Result], line_items_contact_account: typing.Callable[[], T_Result], line_items_contact_account_accounting_period: typing.Callable[[], T_Result], + line_items_contact_account_company: typing.Callable[[], T_Result], + line_items_contact_account_company_accounting_period: typing.Callable[[], T_Result], line_items_contact_accounting_period: typing.Callable[[], T_Result], + line_items_contact_company: typing.Callable[[], T_Result], + line_items_contact_company_accounting_period: typing.Callable[[], T_Result], line_items_tracking_categories: typing.Callable[[], T_Result], line_items_tracking_categories_account: typing.Callable[[], T_Result], line_items_tracking_categories_account_accounting_period: typing.Callable[[], T_Result], + line_items_tracking_categories_account_company: typing.Callable[[], T_Result], + line_items_tracking_categories_account_company_accounting_period: typing.Callable[[], T_Result], line_items_tracking_categories_accounting_period: typing.Callable[[], T_Result], + line_items_tracking_categories_company: typing.Callable[[], T_Result], + line_items_tracking_categories_company_accounting_period: typing.Callable[[], T_Result], line_items_tracking_categories_contact: typing.Callable[[], T_Result], line_items_tracking_categories_contact_account: typing.Callable[[], T_Result], line_items_tracking_categories_contact_account_accounting_period: typing.Callable[[], T_Result], + line_items_tracking_categories_contact_account_company: typing.Callable[[], T_Result], + line_items_tracking_categories_contact_account_company_accounting_period: typing.Callable[[], T_Result], line_items_tracking_categories_contact_accounting_period: typing.Callable[[], T_Result], + line_items_tracking_categories_contact_company: typing.Callable[[], T_Result], + line_items_tracking_categories_contact_company_accounting_period: typing.Callable[[], T_Result], tracking_categories: typing.Callable[[], T_Result], tracking_categories_account: typing.Callable[[], T_Result], tracking_categories_account_accounting_period: typing.Callable[[], T_Result], + tracking_categories_account_company: typing.Callable[[], T_Result], + tracking_categories_account_company_accounting_period: typing.Callable[[], T_Result], tracking_categories_accounting_period: typing.Callable[[], T_Result], + tracking_categories_company: typing.Callable[[], T_Result], + tracking_categories_company_accounting_period: typing.Callable[[], T_Result], tracking_categories_contact: typing.Callable[[], T_Result], tracking_categories_contact_account: typing.Callable[[], T_Result], tracking_categories_contact_account_accounting_period: typing.Callable[[], T_Result], + tracking_categories_contact_account_company: typing.Callable[[], T_Result], + tracking_categories_contact_account_company_accounting_period: typing.Callable[[], T_Result], tracking_categories_contact_accounting_period: typing.Callable[[], T_Result], + tracking_categories_contact_company: typing.Callable[[], T_Result], + tracking_categories_contact_company_accounting_period: typing.Callable[[], T_Result], ) -> T_Result: if self is TransactionsRetrieveRequestExpand.ACCOUNT: return account() if self is TransactionsRetrieveRequestExpand.ACCOUNT_ACCOUNTING_PERIOD: return account_accounting_period() + if self is TransactionsRetrieveRequestExpand.ACCOUNT_COMPANY: + return account_company() + if self is TransactionsRetrieveRequestExpand.ACCOUNT_COMPANY_ACCOUNTING_PERIOD: + return account_company_accounting_period() if self is TransactionsRetrieveRequestExpand.ACCOUNTING_PERIOD: return accounting_period() + if self is TransactionsRetrieveRequestExpand.COMPANY: + return company() + if self is TransactionsRetrieveRequestExpand.COMPANY_ACCOUNTING_PERIOD: + return company_accounting_period() if self is TransactionsRetrieveRequestExpand.CONTACT: return contact() if self is TransactionsRetrieveRequestExpand.CONTACT_ACCOUNT: return contact_account() if self is TransactionsRetrieveRequestExpand.CONTACT_ACCOUNT_ACCOUNTING_PERIOD: return contact_account_accounting_period() + if self is TransactionsRetrieveRequestExpand.CONTACT_ACCOUNT_COMPANY: + return contact_account_company() + if self is TransactionsRetrieveRequestExpand.CONTACT_ACCOUNT_COMPANY_ACCOUNTING_PERIOD: + return contact_account_company_accounting_period() if self is TransactionsRetrieveRequestExpand.CONTACT_ACCOUNTING_PERIOD: return contact_accounting_period() + if self is TransactionsRetrieveRequestExpand.CONTACT_COMPANY: + return contact_company() + if self is TransactionsRetrieveRequestExpand.CONTACT_COMPANY_ACCOUNTING_PERIOD: + return contact_company_accounting_period() if self is TransactionsRetrieveRequestExpand.LINE_ITEMS: return line_items() if self is TransactionsRetrieveRequestExpand.LINE_ITEMS_ACCOUNT: return line_items_account() if self is TransactionsRetrieveRequestExpand.LINE_ITEMS_ACCOUNT_ACCOUNTING_PERIOD: return line_items_account_accounting_period() + if self is TransactionsRetrieveRequestExpand.LINE_ITEMS_ACCOUNT_COMPANY: + return line_items_account_company() + if self is TransactionsRetrieveRequestExpand.LINE_ITEMS_ACCOUNT_COMPANY_ACCOUNTING_PERIOD: + return line_items_account_company_accounting_period() if self is TransactionsRetrieveRequestExpand.LINE_ITEMS_ACCOUNTING_PERIOD: return line_items_accounting_period() + if self is TransactionsRetrieveRequestExpand.LINE_ITEMS_COMPANY: + return line_items_company() + if self is TransactionsRetrieveRequestExpand.LINE_ITEMS_COMPANY_ACCOUNTING_PERIOD: + return line_items_company_accounting_period() if self is TransactionsRetrieveRequestExpand.LINE_ITEMS_CONTACT: return line_items_contact() if self is TransactionsRetrieveRequestExpand.LINE_ITEMS_CONTACT_ACCOUNT: return line_items_contact_account() if self is TransactionsRetrieveRequestExpand.LINE_ITEMS_CONTACT_ACCOUNT_ACCOUNTING_PERIOD: return line_items_contact_account_accounting_period() + if self is TransactionsRetrieveRequestExpand.LINE_ITEMS_CONTACT_ACCOUNT_COMPANY: + return line_items_contact_account_company() + if self is TransactionsRetrieveRequestExpand.LINE_ITEMS_CONTACT_ACCOUNT_COMPANY_ACCOUNTING_PERIOD: + return line_items_contact_account_company_accounting_period() if self is TransactionsRetrieveRequestExpand.LINE_ITEMS_CONTACT_ACCOUNTING_PERIOD: return line_items_contact_accounting_period() + if self is TransactionsRetrieveRequestExpand.LINE_ITEMS_CONTACT_COMPANY: + return line_items_contact_company() + if self is TransactionsRetrieveRequestExpand.LINE_ITEMS_CONTACT_COMPANY_ACCOUNTING_PERIOD: + return line_items_contact_company_accounting_period() if self is TransactionsRetrieveRequestExpand.LINE_ITEMS_TRACKING_CATEGORIES: return line_items_tracking_categories() if self is TransactionsRetrieveRequestExpand.LINE_ITEMS_TRACKING_CATEGORIES_ACCOUNT: return line_items_tracking_categories_account() if self is TransactionsRetrieveRequestExpand.LINE_ITEMS_TRACKING_CATEGORIES_ACCOUNT_ACCOUNTING_PERIOD: return line_items_tracking_categories_account_accounting_period() + if self is TransactionsRetrieveRequestExpand.LINE_ITEMS_TRACKING_CATEGORIES_ACCOUNT_COMPANY: + return line_items_tracking_categories_account_company() + if self is TransactionsRetrieveRequestExpand.LINE_ITEMS_TRACKING_CATEGORIES_ACCOUNT_COMPANY_ACCOUNTING_PERIOD: + return line_items_tracking_categories_account_company_accounting_period() if self is TransactionsRetrieveRequestExpand.LINE_ITEMS_TRACKING_CATEGORIES_ACCOUNTING_PERIOD: return line_items_tracking_categories_accounting_period() + if self is TransactionsRetrieveRequestExpand.LINE_ITEMS_TRACKING_CATEGORIES_COMPANY: + return line_items_tracking_categories_company() + if self is TransactionsRetrieveRequestExpand.LINE_ITEMS_TRACKING_CATEGORIES_COMPANY_ACCOUNTING_PERIOD: + return line_items_tracking_categories_company_accounting_period() if self is TransactionsRetrieveRequestExpand.LINE_ITEMS_TRACKING_CATEGORIES_CONTACT: return line_items_tracking_categories_contact() if self is TransactionsRetrieveRequestExpand.LINE_ITEMS_TRACKING_CATEGORIES_CONTACT_ACCOUNT: return line_items_tracking_categories_contact_account() if self is TransactionsRetrieveRequestExpand.LINE_ITEMS_TRACKING_CATEGORIES_CONTACT_ACCOUNT_ACCOUNTING_PERIOD: return line_items_tracking_categories_contact_account_accounting_period() + if self is TransactionsRetrieveRequestExpand.LINE_ITEMS_TRACKING_CATEGORIES_CONTACT_ACCOUNT_COMPANY: + return line_items_tracking_categories_contact_account_company() + if ( + self + is TransactionsRetrieveRequestExpand.LINE_ITEMS_TRACKING_CATEGORIES_CONTACT_ACCOUNT_COMPANY_ACCOUNTING_PERIOD + ): + return line_items_tracking_categories_contact_account_company_accounting_period() if self is TransactionsRetrieveRequestExpand.LINE_ITEMS_TRACKING_CATEGORIES_CONTACT_ACCOUNTING_PERIOD: return line_items_tracking_categories_contact_accounting_period() + if self is TransactionsRetrieveRequestExpand.LINE_ITEMS_TRACKING_CATEGORIES_CONTACT_COMPANY: + return line_items_tracking_categories_contact_company() + if self is TransactionsRetrieveRequestExpand.LINE_ITEMS_TRACKING_CATEGORIES_CONTACT_COMPANY_ACCOUNTING_PERIOD: + return line_items_tracking_categories_contact_company_accounting_period() if self is TransactionsRetrieveRequestExpand.TRACKING_CATEGORIES: return tracking_categories() if self is TransactionsRetrieveRequestExpand.TRACKING_CATEGORIES_ACCOUNT: return tracking_categories_account() if self is TransactionsRetrieveRequestExpand.TRACKING_CATEGORIES_ACCOUNT_ACCOUNTING_PERIOD: return tracking_categories_account_accounting_period() + if self is TransactionsRetrieveRequestExpand.TRACKING_CATEGORIES_ACCOUNT_COMPANY: + return tracking_categories_account_company() + if self is TransactionsRetrieveRequestExpand.TRACKING_CATEGORIES_ACCOUNT_COMPANY_ACCOUNTING_PERIOD: + return tracking_categories_account_company_accounting_period() if self is TransactionsRetrieveRequestExpand.TRACKING_CATEGORIES_ACCOUNTING_PERIOD: return tracking_categories_accounting_period() + if self is TransactionsRetrieveRequestExpand.TRACKING_CATEGORIES_COMPANY: + return tracking_categories_company() + if self is TransactionsRetrieveRequestExpand.TRACKING_CATEGORIES_COMPANY_ACCOUNTING_PERIOD: + return tracking_categories_company_accounting_period() if self is TransactionsRetrieveRequestExpand.TRACKING_CATEGORIES_CONTACT: return tracking_categories_contact() if self is TransactionsRetrieveRequestExpand.TRACKING_CATEGORIES_CONTACT_ACCOUNT: return tracking_categories_contact_account() if self is TransactionsRetrieveRequestExpand.TRACKING_CATEGORIES_CONTACT_ACCOUNT_ACCOUNTING_PERIOD: return tracking_categories_contact_account_accounting_period() + if self is TransactionsRetrieveRequestExpand.TRACKING_CATEGORIES_CONTACT_ACCOUNT_COMPANY: + return tracking_categories_contact_account_company() + if self is TransactionsRetrieveRequestExpand.TRACKING_CATEGORIES_CONTACT_ACCOUNT_COMPANY_ACCOUNTING_PERIOD: + return tracking_categories_contact_account_company_accounting_period() if self is TransactionsRetrieveRequestExpand.TRACKING_CATEGORIES_CONTACT_ACCOUNTING_PERIOD: return tracking_categories_contact_accounting_period() + if self is TransactionsRetrieveRequestExpand.TRACKING_CATEGORIES_CONTACT_COMPANY: + return tracking_categories_contact_company() + if self is TransactionsRetrieveRequestExpand.TRACKING_CATEGORIES_CONTACT_COMPANY_ACCOUNTING_PERIOD: + return tracking_categories_contact_company_accounting_period() diff --git a/src/merge/resources/accounting/resources/vendor_credits/client.py b/src/merge/resources/accounting/resources/vendor_credits/client.py index 077ae72f..35f220c2 100644 --- a/src/merge/resources/accounting/resources/vendor_credits/client.py +++ b/src/merge/resources/accounting/resources/vendor_credits/client.py @@ -115,7 +115,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.vendor_credits.list() + client.accounting.vendor_credits.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( company_id=company_id, @@ -367,7 +369,9 @@ async def list( async def main() -> None: - await client.accounting.vendor_credits.list() + await client.accounting.vendor_credits.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/types/__init__.py b/src/merge/resources/accounting/types/__init__.py index ccc53eea..b9451ea9 100644 --- a/src/merge/resources/accounting/types/__init__.py +++ b/src/merge/resources/accounting/types/__init__.py @@ -78,7 +78,9 @@ from .common_model_scope_api import CommonModelScopeApi from .common_model_scopes_body_request import CommonModelScopesBodyRequest from .company_info import CompanyInfo +from .company_info_addresses_item import CompanyInfoAddressesItem from .company_info_currency import CompanyInfoCurrency +from .company_info_phone_numbers_item import CompanyInfoPhoneNumbersItem from .component_type_enum import ComponentTypeEnum from .contact import Contact from .contact_addresses_item import ContactAddressesItem @@ -128,6 +130,7 @@ from .credit_or_debit_enum import CreditOrDebitEnum from .data_passthrough_request import DataPassthroughRequest from .data_passthrough_request_method import DataPassthroughRequestMethod +from .data_passthrough_request_request_format import DataPassthroughRequestRequestFormat from .debug_mode_log import DebugModeLog from .debug_model_log_summary import DebugModelLogSummary from .employee import Employee @@ -163,17 +166,22 @@ from .expense_line_tracking_categories_item import ExpenseLineTrackingCategoriesItem from .expense_line_tracking_category import ExpenseLineTrackingCategory from .expense_report import ExpenseReport +from .expense_report_accounting_period import ExpenseReportAccountingPeriod from .expense_report_company import ExpenseReportCompany +from .expense_report_currency import ExpenseReportCurrency +from .expense_report_employee import ExpenseReportEmployee from .expense_report_line import ExpenseReportLine from .expense_report_line_account import ExpenseReportLineAccount from .expense_report_line_company import ExpenseReportLineCompany from .expense_report_line_contact import ExpenseReportLineContact +from .expense_report_line_currency import ExpenseReportLineCurrency from .expense_report_line_employee import ExpenseReportLineEmployee from .expense_report_line_project import ExpenseReportLineProject from .expense_report_line_request import ExpenseReportLineRequest from .expense_report_line_request_account import ExpenseReportLineRequestAccount from .expense_report_line_request_company import ExpenseReportLineRequestCompany from .expense_report_line_request_contact import ExpenseReportLineRequestContact +from .expense_report_line_request_currency import ExpenseReportLineRequestCurrency from .expense_report_line_request_employee import ExpenseReportLineRequestEmployee from .expense_report_line_request_project import ExpenseReportLineRequestProject from .expense_report_line_request_tax_rate import ExpenseReportLineRequestTaxRate @@ -181,6 +189,7 @@ from .expense_report_request import ExpenseReportRequest from .expense_report_request_accounting_period import ExpenseReportRequestAccountingPeriod from .expense_report_request_company import ExpenseReportRequestCompany +from .expense_report_request_currency import ExpenseReportRequestCurrency from .expense_report_request_employee import ExpenseReportRequestEmployee from .expense_report_response import ExpenseReportResponse from .expense_report_status import ExpenseReportStatus @@ -268,6 +277,7 @@ from .invoice_request_contact import InvoiceRequestContact from .invoice_request_currency import InvoiceRequestCurrency from .invoice_request_employee import InvoiceRequestEmployee +from .invoice_request_line_items_item import InvoiceRequestLineItemsItem from .invoice_request_payment_term import InvoiceRequestPaymentTerm from .invoice_request_payments_item import InvoiceRequestPaymentsItem from .invoice_request_purchase_orders_item import InvoiceRequestPurchaseOrdersItem @@ -313,6 +323,7 @@ from .journal_entry_request import JournalEntryRequest from .journal_entry_request_company import JournalEntryRequestCompany from .journal_entry_request_currency import JournalEntryRequestCurrency +from .journal_entry_request_lines_item import JournalEntryRequestLinesItem from .journal_entry_request_payments_item import JournalEntryRequestPaymentsItem from .journal_entry_request_posting_status import JournalEntryRequestPostingStatus from .journal_entry_request_tracking_categories_item import JournalEntryRequestTrackingCategoriesItem @@ -375,6 +386,9 @@ from .paginated_tracking_category_list import PaginatedTrackingCategoryList from .paginated_transaction_list import PaginatedTransactionList from .paginated_vendor_credit_list import PaginatedVendorCreditList +from .patched_contact_endpoint_request import PatchedContactEndpointRequest +from .patched_contact_request import PatchedContactRequest +from .patched_contact_request_status import PatchedContactRequestStatus from .patched_item_request_request import PatchedItemRequestRequest from .patched_item_request_request_status import PatchedItemRequestRequestStatus from .patched_item_request_request_type import PatchedItemRequestRequestType @@ -382,7 +396,6 @@ from .patched_payment_request_account import PatchedPaymentRequestAccount from .patched_payment_request_accounting_period import PatchedPaymentRequestAccountingPeriod from .patched_payment_request_applied_to_lines_item import PatchedPaymentRequestAppliedToLinesItem -from .patched_payment_request_company import PatchedPaymentRequestCompany from .patched_payment_request_contact import PatchedPaymentRequestContact from .patched_payment_request_currency import PatchedPaymentRequestCurrency from .patched_payment_request_payment_method import PatchedPaymentRequestPaymentMethod @@ -457,6 +470,7 @@ from .remote_field_request_remote_field_class import RemoteFieldRequestRemoteFieldClass from .remote_key import RemoteKey from .remote_response import RemoteResponse +from .remote_response_response_type import RemoteResponseResponseType from .report_item import ReportItem from .request_format_enum import RequestFormatEnum from .response_type_enum import ResponseTypeEnum @@ -480,6 +494,7 @@ from .transaction import Transaction from .transaction_account import TransactionAccount from .transaction_accounting_period import TransactionAccountingPeriod +from .transaction_company import TransactionCompany from .transaction_contact import TransactionContact from .transaction_currency import TransactionCurrency from .transaction_currency_enum import TransactionCurrencyEnum @@ -510,6 +525,7 @@ from .vendor_credit_line_request_account import VendorCreditLineRequestAccount from .vendor_credit_line_request_contact import VendorCreditLineRequestContact from .vendor_credit_line_request_project import VendorCreditLineRequestProject +from .vendor_credit_lines_item import VendorCreditLinesItem from .vendor_credit_request import VendorCreditRequest from .vendor_credit_request_accounting_period import VendorCreditRequestAccountingPeriod from .vendor_credit_request_company import VendorCreditRequestCompany @@ -599,7 +615,9 @@ "CommonModelScopeApi", "CommonModelScopesBodyRequest", "CompanyInfo", + "CompanyInfoAddressesItem", "CompanyInfoCurrency", + "CompanyInfoPhoneNumbersItem", "ComponentTypeEnum", "Contact", "ContactAddressesItem", @@ -649,6 +667,7 @@ "CreditOrDebitEnum", "DataPassthroughRequest", "DataPassthroughRequestMethod", + "DataPassthroughRequestRequestFormat", "DebugModeLog", "DebugModelLogSummary", "Employee", @@ -684,17 +703,22 @@ "ExpenseLineTrackingCategoriesItem", "ExpenseLineTrackingCategory", "ExpenseReport", + "ExpenseReportAccountingPeriod", "ExpenseReportCompany", + "ExpenseReportCurrency", + "ExpenseReportEmployee", "ExpenseReportLine", "ExpenseReportLineAccount", "ExpenseReportLineCompany", "ExpenseReportLineContact", + "ExpenseReportLineCurrency", "ExpenseReportLineEmployee", "ExpenseReportLineProject", "ExpenseReportLineRequest", "ExpenseReportLineRequestAccount", "ExpenseReportLineRequestCompany", "ExpenseReportLineRequestContact", + "ExpenseReportLineRequestCurrency", "ExpenseReportLineRequestEmployee", "ExpenseReportLineRequestProject", "ExpenseReportLineRequestTaxRate", @@ -702,6 +726,7 @@ "ExpenseReportRequest", "ExpenseReportRequestAccountingPeriod", "ExpenseReportRequestCompany", + "ExpenseReportRequestCurrency", "ExpenseReportRequestEmployee", "ExpenseReportResponse", "ExpenseReportStatus", @@ -785,6 +810,7 @@ "InvoiceRequestContact", "InvoiceRequestCurrency", "InvoiceRequestEmployee", + "InvoiceRequestLineItemsItem", "InvoiceRequestPaymentTerm", "InvoiceRequestPaymentsItem", "InvoiceRequestPurchaseOrdersItem", @@ -830,6 +856,7 @@ "JournalEntryRequest", "JournalEntryRequestCompany", "JournalEntryRequestCurrency", + "JournalEntryRequestLinesItem", "JournalEntryRequestPaymentsItem", "JournalEntryRequestPostingStatus", "JournalEntryRequestTrackingCategoriesItem", @@ -892,6 +919,9 @@ "PaginatedTrackingCategoryList", "PaginatedTransactionList", "PaginatedVendorCreditList", + "PatchedContactEndpointRequest", + "PatchedContactRequest", + "PatchedContactRequestStatus", "PatchedItemRequestRequest", "PatchedItemRequestRequestStatus", "PatchedItemRequestRequestType", @@ -899,7 +929,6 @@ "PatchedPaymentRequestAccount", "PatchedPaymentRequestAccountingPeriod", "PatchedPaymentRequestAppliedToLinesItem", - "PatchedPaymentRequestCompany", "PatchedPaymentRequestContact", "PatchedPaymentRequestCurrency", "PatchedPaymentRequestPaymentMethod", @@ -974,6 +1003,7 @@ "RemoteFieldRequestRemoteFieldClass", "RemoteKey", "RemoteResponse", + "RemoteResponseResponseType", "ReportItem", "RequestFormatEnum", "ResponseTypeEnum", @@ -997,6 +1027,7 @@ "Transaction", "TransactionAccount", "TransactionAccountingPeriod", + "TransactionCompany", "TransactionContact", "TransactionCurrency", "TransactionCurrencyEnum", @@ -1025,6 +1056,7 @@ "VendorCreditLineRequestAccount", "VendorCreditLineRequestContact", "VendorCreditLineRequestProject", + "VendorCreditLinesItem", "VendorCreditRequest", "VendorCreditRequestAccountingPeriod", "VendorCreditRequestCompany", diff --git a/src/merge/resources/accounting/types/company_info.py b/src/merge/resources/accounting/types/company_info.py index 1f8a46ef..d4ed2d01 100644 --- a/src/merge/resources/accounting/types/company_info.py +++ b/src/merge/resources/accounting/types/company_info.py @@ -6,9 +6,9 @@ import pydantic from ....core.pydantic_utilities import IS_PYDANTIC_V2 from ....core.unchecked_base_model import UncheckedBaseModel -from .accounting_phone_number import AccountingPhoneNumber -from .address import Address +from .company_info_addresses_item import CompanyInfoAddressesItem from .company_info_currency import CompanyInfoCurrency +from .company_info_phone_numbers_item import CompanyInfoPhoneNumbersItem from .remote_data import RemoteData @@ -385,8 +385,8 @@ class CompanyInfo(UncheckedBaseModel): The company's urls. """ - addresses: typing.Optional[typing.List[Address]] = None - phone_numbers: typing.Optional[typing.List[AccountingPhoneNumber]] = None + addresses: typing.Optional[typing.List[CompanyInfoAddressesItem]] = None + phone_numbers: typing.Optional[typing.List[CompanyInfoPhoneNumbersItem]] = None remote_was_deleted: typing.Optional[bool] = pydantic.Field(default=None) """ Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). diff --git a/src/merge/resources/accounting/types/company_info_addresses_item.py b/src/merge/resources/accounting/types/company_info_addresses_item.py new file mode 100644 index 00000000..7d2c83fc --- /dev/null +++ b/src/merge/resources/accounting/types/company_info_addresses_item.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +from .address import Address + +CompanyInfoAddressesItem = typing.Union[str, Address] diff --git a/src/merge/resources/accounting/types/company_info_phone_numbers_item.py b/src/merge/resources/accounting/types/company_info_phone_numbers_item.py new file mode 100644 index 00000000..dea8be47 --- /dev/null +++ b/src/merge/resources/accounting/types/company_info_phone_numbers_item.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +from .accounting_phone_number import AccountingPhoneNumber + +CompanyInfoPhoneNumbersItem = typing.Union[str, AccountingPhoneNumber] diff --git a/src/merge/resources/accounting/types/credit_note_line_item_request_project.py b/src/merge/resources/accounting/types/credit_note_line_item_request_project.py index 334b238e..d9727951 100644 --- a/src/merge/resources/accounting/types/credit_note_line_item_request_project.py +++ b/src/merge/resources/accounting/types/credit_note_line_item_request_project.py @@ -2,6 +2,6 @@ import typing -from .contact import Contact +from .project import Project -CreditNoteLineItemRequestProject = typing.Union[str, Contact] +CreditNoteLineItemRequestProject = typing.Union[str, Project] diff --git a/src/merge/resources/accounting/types/credit_note_request_line_items_item.py b/src/merge/resources/accounting/types/credit_note_request_line_items_item.py index 6a4417b3..b81992a1 100644 --- a/src/merge/resources/accounting/types/credit_note_request_line_items_item.py +++ b/src/merge/resources/accounting/types/credit_note_request_line_items_item.py @@ -2,6 +2,6 @@ import typing -from .credit_note_line_item_request import CreditNoteLineItemRequest +from .credit_note_line_item import CreditNoteLineItem -CreditNoteRequestLineItemsItem = typing.Union[str, CreditNoteLineItemRequest] +CreditNoteRequestLineItemsItem = typing.Union[str, CreditNoteLineItem] diff --git a/src/merge/resources/accounting/types/data_passthrough_request.py b/src/merge/resources/accounting/types/data_passthrough_request.py index 67f3359e..5a60bfb6 100644 --- a/src/merge/resources/accounting/types/data_passthrough_request.py +++ b/src/merge/resources/accounting/types/data_passthrough_request.py @@ -6,8 +6,8 @@ from ....core.pydantic_utilities import IS_PYDANTIC_V2 from ....core.unchecked_base_model import UncheckedBaseModel from .data_passthrough_request_method import DataPassthroughRequestMethod +from .data_passthrough_request_request_format import DataPassthroughRequestRequestFormat from .multipart_form_field_request import MultipartFormFieldRequest -from .request_format_enum import RequestFormatEnum class DataPassthroughRequest(UncheckedBaseModel): @@ -46,7 +46,7 @@ class DataPassthroughRequest(UncheckedBaseModel): The headers to use for the request (Merge will handle the account's authorization headers). `Content-Type` header is required for passthrough. Choose content type corresponding to expected format of receiving server. """ - request_format: typing.Optional[RequestFormatEnum] = None + request_format: typing.Optional[DataPassthroughRequestRequestFormat] = None normalize_response: typing.Optional[bool] = pydantic.Field(default=None) """ Optional. If true, the response will always be an object of the form `{"type": T, "value": ...}` where `T` will be one of `string, boolean, number, null, array, object`. diff --git a/src/merge/resources/accounting/types/data_passthrough_request_request_format.py b/src/merge/resources/accounting/types/data_passthrough_request_request_format.py new file mode 100644 index 00000000..13dc95f0 --- /dev/null +++ b/src/merge/resources/accounting/types/data_passthrough_request_request_format.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +from .request_format_enum import RequestFormatEnum + +DataPassthroughRequestRequestFormat = typing.Union[RequestFormatEnum, str] diff --git a/src/merge/resources/accounting/types/expense_line_request_project.py b/src/merge/resources/accounting/types/expense_line_request_project.py index a4a23629..3b00a37e 100644 --- a/src/merge/resources/accounting/types/expense_line_request_project.py +++ b/src/merge/resources/accounting/types/expense_line_request_project.py @@ -2,6 +2,6 @@ import typing -from .contact import Contact +from .project import Project -ExpenseLineRequestProject = typing.Union[str, Contact] +ExpenseLineRequestProject = typing.Union[str, Project] diff --git a/src/merge/resources/accounting/types/expense_report.py b/src/merge/resources/accounting/types/expense_report.py index 9cd03e8d..a191a3aa 100644 --- a/src/merge/resources/accounting/types/expense_report.py +++ b/src/merge/resources/accounting/types/expense_report.py @@ -6,12 +6,14 @@ import pydantic from ....core.pydantic_utilities import IS_PYDANTIC_V2 from ....core.unchecked_base_model import UncheckedBaseModel +from .expense_report_accounting_period import ExpenseReportAccountingPeriod from .expense_report_company import ExpenseReportCompany +from .expense_report_currency import ExpenseReportCurrency +from .expense_report_employee import ExpenseReportEmployee from .expense_report_line import ExpenseReportLine from .expense_report_status import ExpenseReportStatus from .remote_data import RemoteData from .remote_field import RemoteField -from .transaction_currency_enum import TransactionCurrencyEnum class ExpenseReport(UncheckedBaseModel): @@ -51,7 +53,7 @@ class ExpenseReport(UncheckedBaseModel): Human-readable expense report identifier. """ - employee: typing.Optional[str] = pydantic.Field(default=None) + employee: typing.Optional[ExpenseReportEmployee] = pydantic.Field(default=None) """ Identifier for the employee who submitted or is associated with the expense report """ @@ -72,7 +74,7 @@ class ExpenseReport(UncheckedBaseModel): """ lines: typing.Optional[typing.List[ExpenseReportLine]] = None - currency: typing.Optional[TransactionCurrencyEnum] = pydantic.Field(default=None) + currency: typing.Optional[ExpenseReportCurrency] = pydantic.Field(default=None) """ Currency code for the expense report @@ -389,7 +391,7 @@ class ExpenseReport(UncheckedBaseModel): A brief description or purpose for the expense report """ - accounting_period: typing.Optional[str] = pydantic.Field(default=None) + accounting_period: typing.Optional[ExpenseReportAccountingPeriod] = pydantic.Field(default=None) """ The accounting period the report was posted in """ diff --git a/src/merge/resources/accounting/types/expense_report_accounting_period.py b/src/merge/resources/accounting/types/expense_report_accounting_period.py new file mode 100644 index 00000000..d72ba214 --- /dev/null +++ b/src/merge/resources/accounting/types/expense_report_accounting_period.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +from .accounting_period import AccountingPeriod + +ExpenseReportAccountingPeriod = typing.Union[str, AccountingPeriod] diff --git a/src/merge/resources/accounting/types/expense_report_currency.py b/src/merge/resources/accounting/types/expense_report_currency.py new file mode 100644 index 00000000..a8867d20 --- /dev/null +++ b/src/merge/resources/accounting/types/expense_report_currency.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +from .transaction_currency_enum import TransactionCurrencyEnum + +ExpenseReportCurrency = typing.Union[TransactionCurrencyEnum, str] diff --git a/src/merge/resources/accounting/types/expense_report_employee.py b/src/merge/resources/accounting/types/expense_report_employee.py new file mode 100644 index 00000000..5ef3f28c --- /dev/null +++ b/src/merge/resources/accounting/types/expense_report_employee.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +from .employee import Employee + +ExpenseReportEmployee = typing.Union[str, Employee] diff --git a/src/merge/resources/accounting/types/expense_report_line.py b/src/merge/resources/accounting/types/expense_report_line.py index a5b01dfc..2223b994 100644 --- a/src/merge/resources/accounting/types/expense_report_line.py +++ b/src/merge/resources/accounting/types/expense_report_line.py @@ -9,11 +9,11 @@ from .expense_report_line_account import ExpenseReportLineAccount from .expense_report_line_company import ExpenseReportLineCompany from .expense_report_line_contact import ExpenseReportLineContact +from .expense_report_line_currency import ExpenseReportLineCurrency from .expense_report_line_employee import ExpenseReportLineEmployee from .expense_report_line_project import ExpenseReportLineProject from .expense_report_line_tax_rate import ExpenseReportLineTaxRate from .remote_field import RemoteField -from .transaction_currency_enum import TransactionCurrencyEnum class ExpenseReportLine(UncheckedBaseModel): @@ -59,7 +59,7 @@ class ExpenseReportLine(UncheckedBaseModel): The amount of the expense for the line item. """ - currency: typing.Optional[TransactionCurrencyEnum] = pydantic.Field(default=None) + currency: typing.Optional[ExpenseReportLineCurrency] = pydantic.Field(default=None) """ Currency of the expense line (if different from the report currency). diff --git a/src/merge/resources/accounting/types/expense_report_line_currency.py b/src/merge/resources/accounting/types/expense_report_line_currency.py new file mode 100644 index 00000000..52610932 --- /dev/null +++ b/src/merge/resources/accounting/types/expense_report_line_currency.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +from .transaction_currency_enum import TransactionCurrencyEnum + +ExpenseReportLineCurrency = typing.Union[TransactionCurrencyEnum, str] diff --git a/src/merge/resources/accounting/types/expense_report_line_request.py b/src/merge/resources/accounting/types/expense_report_line_request.py index cc0cf8ad..15817037 100644 --- a/src/merge/resources/accounting/types/expense_report_line_request.py +++ b/src/merge/resources/accounting/types/expense_report_line_request.py @@ -9,11 +9,11 @@ from .expense_report_line_request_account import ExpenseReportLineRequestAccount from .expense_report_line_request_company import ExpenseReportLineRequestCompany from .expense_report_line_request_contact import ExpenseReportLineRequestContact +from .expense_report_line_request_currency import ExpenseReportLineRequestCurrency from .expense_report_line_request_employee import ExpenseReportLineRequestEmployee from .expense_report_line_request_project import ExpenseReportLineRequestProject from .expense_report_line_request_tax_rate import ExpenseReportLineRequestTaxRate from .remote_field_request import RemoteFieldRequest -from .transaction_currency_enum import TransactionCurrencyEnum class ExpenseReportLineRequest(UncheckedBaseModel): @@ -48,7 +48,7 @@ class ExpenseReportLineRequest(UncheckedBaseModel): The amount of the expense for the line item. """ - currency: typing.Optional[TransactionCurrencyEnum] = pydantic.Field(default=None) + currency: typing.Optional[ExpenseReportLineRequestCurrency] = pydantic.Field(default=None) """ Currency of the expense line (if different from the report currency). diff --git a/src/merge/resources/accounting/types/expense_report_line_request_currency.py b/src/merge/resources/accounting/types/expense_report_line_request_currency.py new file mode 100644 index 00000000..46c67060 --- /dev/null +++ b/src/merge/resources/accounting/types/expense_report_line_request_currency.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +from .transaction_currency_enum import TransactionCurrencyEnum + +ExpenseReportLineRequestCurrency = typing.Union[TransactionCurrencyEnum, str] diff --git a/src/merge/resources/accounting/types/expense_report_request.py b/src/merge/resources/accounting/types/expense_report_request.py index 00243adf..eb06d9f6 100644 --- a/src/merge/resources/accounting/types/expense_report_request.py +++ b/src/merge/resources/accounting/types/expense_report_request.py @@ -8,10 +8,10 @@ from ....core.unchecked_base_model import UncheckedBaseModel from .expense_report_request_accounting_period import ExpenseReportRequestAccountingPeriod from .expense_report_request_company import ExpenseReportRequestCompany +from .expense_report_request_currency import ExpenseReportRequestCurrency from .expense_report_request_employee import ExpenseReportRequestEmployee from .expense_report_status_enum import ExpenseReportStatusEnum from .remote_field_request import RemoteFieldRequest -from .transaction_currency_enum import TransactionCurrencyEnum class ExpenseReportRequest(UncheckedBaseModel): @@ -55,7 +55,7 @@ class ExpenseReportRequest(UncheckedBaseModel): Total amount of the expense report """ - currency: typing.Optional[TransactionCurrencyEnum] = pydantic.Field(default=None) + currency: typing.Optional[ExpenseReportRequestCurrency] = pydantic.Field(default=None) """ Currency code for the expense report diff --git a/src/merge/resources/accounting/types/expense_report_request_currency.py b/src/merge/resources/accounting/types/expense_report_request_currency.py new file mode 100644 index 00000000..c7f21989 --- /dev/null +++ b/src/merge/resources/accounting/types/expense_report_request_currency.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +from .transaction_currency_enum import TransactionCurrencyEnum + +ExpenseReportRequestCurrency = typing.Union[TransactionCurrencyEnum, str] diff --git a/src/merge/resources/accounting/types/invoice_request.py b/src/merge/resources/accounting/types/invoice_request.py index 5bfa2e9f..7d4a5fb1 100644 --- a/src/merge/resources/accounting/types/invoice_request.py +++ b/src/merge/resources/accounting/types/invoice_request.py @@ -6,11 +6,11 @@ import pydantic from ....core.pydantic_utilities import IS_PYDANTIC_V2 from ....core.unchecked_base_model import UncheckedBaseModel -from .invoice_line_item_request import InvoiceLineItemRequest from .invoice_request_company import InvoiceRequestCompany from .invoice_request_contact import InvoiceRequestContact from .invoice_request_currency import InvoiceRequestCurrency from .invoice_request_employee import InvoiceRequestEmployee +from .invoice_request_line_items_item import InvoiceRequestLineItemsItem from .invoice_request_payment_term import InvoiceRequestPaymentTerm from .invoice_request_payments_item import InvoiceRequestPaymentsItem from .invoice_request_purchase_orders_item import InvoiceRequestPurchaseOrdersItem @@ -451,7 +451,7 @@ class InvoiceRequest(UncheckedBaseModel): """ tracking_categories: typing.Optional[typing.List[typing.Optional[InvoiceRequestTrackingCategoriesItem]]] = None - line_items: typing.Optional[typing.List[InvoiceLineItemRequest]] = None + line_items: typing.Optional[typing.List[InvoiceRequestLineItemsItem]] = None purchase_orders: typing.Optional[typing.List[typing.Optional[InvoiceRequestPurchaseOrdersItem]]] = None integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None diff --git a/src/merge/resources/accounting/types/invoice_request_line_items_item.py b/src/merge/resources/accounting/types/invoice_request_line_items_item.py new file mode 100644 index 00000000..c4d87126 --- /dev/null +++ b/src/merge/resources/accounting/types/invoice_request_line_items_item.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +from .invoice_line_item import InvoiceLineItem + +InvoiceRequestLineItemsItem = typing.Union[str, InvoiceLineItem] diff --git a/src/merge/resources/accounting/types/journal_entry_request.py b/src/merge/resources/accounting/types/journal_entry_request.py index 5c45360e..d00339aa 100644 --- a/src/merge/resources/accounting/types/journal_entry_request.py +++ b/src/merge/resources/accounting/types/journal_entry_request.py @@ -8,10 +8,10 @@ from ....core.unchecked_base_model import UncheckedBaseModel from .journal_entry_request_company import JournalEntryRequestCompany from .journal_entry_request_currency import JournalEntryRequestCurrency +from .journal_entry_request_lines_item import JournalEntryRequestLinesItem from .journal_entry_request_payments_item import JournalEntryRequestPaymentsItem from .journal_entry_request_posting_status import JournalEntryRequestPostingStatus from .journal_entry_request_tracking_categories_item import JournalEntryRequestTrackingCategoriesItem -from .journal_line_request import JournalLineRequest from .remote_field_request import RemoteFieldRequest @@ -370,7 +370,7 @@ class JournalEntryRequest(UncheckedBaseModel): If the transaction is inclusive or exclusive of tax. `True` if inclusive, `False` if exclusive. """ - lines: typing.Optional[typing.List[JournalLineRequest]] = None + lines: typing.Optional[typing.List[JournalEntryRequestLinesItem]] = None journal_number: typing.Optional[str] = pydantic.Field(default=None) """ Reference number for identifying journal entries. diff --git a/src/merge/resources/accounting/types/journal_entry_request_lines_item.py b/src/merge/resources/accounting/types/journal_entry_request_lines_item.py new file mode 100644 index 00000000..f663a1c5 --- /dev/null +++ b/src/merge/resources/accounting/types/journal_entry_request_lines_item.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +from .journal_line import JournalLine + +JournalEntryRequestLinesItem = typing.Union[str, JournalLine] diff --git a/src/merge/resources/accounting/types/patched_contact_endpoint_request.py b/src/merge/resources/accounting/types/patched_contact_endpoint_request.py new file mode 100644 index 00000000..7d59e5c0 --- /dev/null +++ b/src/merge/resources/accounting/types/patched_contact_endpoint_request.py @@ -0,0 +1,21 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +from ....core.pydantic_utilities import IS_PYDANTIC_V2 +from ....core.unchecked_base_model import UncheckedBaseModel +from .patched_contact_request import PatchedContactRequest + + +class PatchedContactEndpointRequest(UncheckedBaseModel): + model: PatchedContactRequest + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/merge/resources/accounting/types/patched_contact_request.py b/src/merge/resources/accounting/types/patched_contact_request.py new file mode 100644 index 00000000..1e14de6d --- /dev/null +++ b/src/merge/resources/accounting/types/patched_contact_request.py @@ -0,0 +1,90 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +from ....core.pydantic_utilities import IS_PYDANTIC_V2 +from ....core.unchecked_base_model import UncheckedBaseModel +from .accounting_phone_number_request import AccountingPhoneNumberRequest +from .address_request import AddressRequest +from .patched_contact_request_status import PatchedContactRequestStatus +from .remote_field_request import RemoteFieldRequest + + +class PatchedContactRequest(UncheckedBaseModel): + """ + # The Contact Object + ### Description + A `Contact` is an individual or business entity to which products and services are sold to or purchased from. The `Contact` model contains both Customers, in which products and services are sold to, and Vendors (or Suppliers), in which products and services are purchased from. + * A `Contact` is a Vendor/Supplier if the `is_supplier` property is true. + * A `Contact` is a customer if the `is_customer` property is true. + + ### Usage Example + Fetch from the `LIST Contacts` endpoint and view a company's contacts. + """ + + name: typing.Optional[str] = pydantic.Field(default=None) + """ + The contact's name. + """ + + is_supplier: typing.Optional[bool] = pydantic.Field(default=None) + """ + Whether the contact is a supplier. + """ + + is_customer: typing.Optional[bool] = pydantic.Field(default=None) + """ + Whether the contact is a customer. + """ + + email_address: typing.Optional[str] = pydantic.Field(default=None) + """ + The contact's email address. + """ + + tax_number: typing.Optional[str] = pydantic.Field(default=None) + """ + The contact's tax number. + """ + + status: typing.Optional[PatchedContactRequestStatus] = pydantic.Field(default=None) + """ + The contact's status + + * `ACTIVE` - ACTIVE + * `ARCHIVED` - ARCHIVED + """ + + currency: typing.Optional[str] = pydantic.Field(default=None) + """ + The currency the contact's transactions are in. + """ + + company: typing.Optional[str] = pydantic.Field(default=None) + """ + The company the contact belongs to. + """ + + addresses: typing.Optional[typing.List[AddressRequest]] = pydantic.Field(default=None) + """ + `Address` object IDs for the given `Contacts` object. + """ + + phone_numbers: typing.Optional[typing.List[AccountingPhoneNumberRequest]] = pydantic.Field(default=None) + """ + `AccountingPhoneNumber` object for the given `Contacts` object. + """ + + integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + remote_fields: typing.Optional[typing.List[RemoteFieldRequest]] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/merge/resources/accounting/types/patched_contact_request_status.py b/src/merge/resources/accounting/types/patched_contact_request_status.py new file mode 100644 index 00000000..2436681f --- /dev/null +++ b/src/merge/resources/accounting/types/patched_contact_request_status.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +from .status_7_d_1_enum import Status7D1Enum + +PatchedContactRequestStatus = typing.Union[Status7D1Enum, str] diff --git a/src/merge/resources/accounting/types/patched_payment_request.py b/src/merge/resources/accounting/types/patched_payment_request.py index 7222862a..c6a47a90 100644 --- a/src/merge/resources/accounting/types/patched_payment_request.py +++ b/src/merge/resources/accounting/types/patched_payment_request.py @@ -9,7 +9,6 @@ from .patched_payment_request_account import PatchedPaymentRequestAccount from .patched_payment_request_accounting_period import PatchedPaymentRequestAccountingPeriod from .patched_payment_request_applied_to_lines_item import PatchedPaymentRequestAppliedToLinesItem -from .patched_payment_request_company import PatchedPaymentRequestCompany from .patched_payment_request_contact import PatchedPaymentRequestContact from .patched_payment_request_currency import PatchedPaymentRequestCurrency from .patched_payment_request_payment_method import PatchedPaymentRequestPaymentMethod @@ -365,7 +364,7 @@ class PatchedPaymentRequest(UncheckedBaseModel): The payment's exchange rate. """ - company: typing.Optional[PatchedPaymentRequestCompany] = pydantic.Field(default=None) + company: typing.Optional[str] = pydantic.Field(default=None) """ The company the payment belongs to. """ diff --git a/src/merge/resources/accounting/types/payment_method.py b/src/merge/resources/accounting/types/payment_method.py index 0a3ec48d..7d4483d9 100644 --- a/src/merge/resources/accounting/types/payment_method.py +++ b/src/merge/resources/accounting/types/payment_method.py @@ -36,7 +36,7 @@ class PaymentMethod(UncheckedBaseModel): The datetime that this object was modified by Merge. """ - method_type: PaymentMethodMethodType = pydantic.Field() + method_type: typing.Optional[PaymentMethodMethodType] = pydantic.Field(default=None) """ The type of the payment method. diff --git a/src/merge/resources/accounting/types/remote_field_api_response.py b/src/merge/resources/accounting/types/remote_field_api_response.py index 68f5ce25..67ae6511 100644 --- a/src/merge/resources/accounting/types/remote_field_api_response.py +++ b/src/merge/resources/accounting/types/remote_field_api_response.py @@ -25,6 +25,7 @@ class RemoteFieldApiResponse(UncheckedBaseModel): credit_note: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="CreditNote", default=None) item: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Item", default=None) purchase_order: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="PurchaseOrder", default=None) + expense_report: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="ExpenseReport", default=None) tracking_category: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field( alias="TrackingCategory", default=None ) diff --git a/src/merge/resources/accounting/types/remote_field_class.py b/src/merge/resources/accounting/types/remote_field_class.py index e5672719..4126b4e7 100644 --- a/src/merge/resources/accounting/types/remote_field_class.py +++ b/src/merge/resources/accounting/types/remote_field_class.py @@ -16,6 +16,7 @@ class RemoteFieldClass(UncheckedBaseModel): remote_key_name: typing.Optional[str] = None description: typing.Optional[str] = None is_custom: typing.Optional[bool] = None + is_common_model_field: typing.Optional[bool] = None is_required: typing.Optional[bool] = None field_type: typing.Optional[FieldTypeEnum] = None field_format: typing.Optional[FieldFormatEnum] = None diff --git a/src/merge/resources/accounting/types/remote_response.py b/src/merge/resources/accounting/types/remote_response.py index af181fc0..db01131f 100644 --- a/src/merge/resources/accounting/types/remote_response.py +++ b/src/merge/resources/accounting/types/remote_response.py @@ -5,7 +5,7 @@ import pydantic from ....core.pydantic_utilities import IS_PYDANTIC_V2 from ....core.unchecked_base_model import UncheckedBaseModel -from .response_type_enum import ResponseTypeEnum +from .remote_response_response_type import RemoteResponseResponseType class RemoteResponse(UncheckedBaseModel): @@ -23,7 +23,7 @@ class RemoteResponse(UncheckedBaseModel): status: int response: typing.Optional[typing.Any] = None response_headers: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None - response_type: typing.Optional[ResponseTypeEnum] = None + response_type: typing.Optional[RemoteResponseResponseType] = None headers: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None if IS_PYDANTIC_V2: diff --git a/src/merge/resources/accounting/types/remote_response_response_type.py b/src/merge/resources/accounting/types/remote_response_response_type.py new file mode 100644 index 00000000..2556417a --- /dev/null +++ b/src/merge/resources/accounting/types/remote_response_response_type.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +from .response_type_enum import ResponseTypeEnum + +RemoteResponseResponseType = typing.Union[ResponseTypeEnum, str] diff --git a/src/merge/resources/accounting/types/transaction.py b/src/merge/resources/accounting/types/transaction.py index 9a014736..885dcd8d 100644 --- a/src/merge/resources/accounting/types/transaction.py +++ b/src/merge/resources/accounting/types/transaction.py @@ -9,6 +9,7 @@ from .remote_data import RemoteData from .transaction_account import TransactionAccount from .transaction_accounting_period import TransactionAccountingPeriod +from .transaction_company import TransactionCompany from .transaction_contact import TransactionContact from .transaction_currency import TransactionCurrency from .transaction_line_item import TransactionLineItem @@ -400,7 +401,7 @@ class Transaction(UncheckedBaseModel): The transaction's exchange rate. """ - company: typing.Optional[str] = pydantic.Field(default=None) + company: typing.Optional[TransactionCompany] = pydantic.Field(default=None) """ The company the transaction belongs to. """ diff --git a/src/merge/resources/accounting/types/patched_payment_request_company.py b/src/merge/resources/accounting/types/transaction_company.py similarity index 65% rename from src/merge/resources/accounting/types/patched_payment_request_company.py rename to src/merge/resources/accounting/types/transaction_company.py index 46869369..fd5f0055 100644 --- a/src/merge/resources/accounting/types/patched_payment_request_company.py +++ b/src/merge/resources/accounting/types/transaction_company.py @@ -4,4 +4,4 @@ from .company_info import CompanyInfo -PatchedPaymentRequestCompany = typing.Union[str, CompanyInfo] +TransactionCompany = typing.Union[str, CompanyInfo] diff --git a/src/merge/resources/accounting/types/vendor_credit.py b/src/merge/resources/accounting/types/vendor_credit.py index 21467ced..b99c8e41 100644 --- a/src/merge/resources/accounting/types/vendor_credit.py +++ b/src/merge/resources/accounting/types/vendor_credit.py @@ -12,7 +12,7 @@ from .vendor_credit_accounting_period import VendorCreditAccountingPeriod from .vendor_credit_company import VendorCreditCompany from .vendor_credit_currency import VendorCreditCurrency -from .vendor_credit_line import VendorCreditLine +from .vendor_credit_lines_item import VendorCreditLinesItem from .vendor_credit_tracking_categories_item import VendorCreditTrackingCategoriesItem from .vendor_credit_vendor import VendorCreditVendor @@ -390,7 +390,7 @@ class VendorCredit(UncheckedBaseModel): The company the vendor credit belongs to. """ - lines: typing.Optional[typing.List[VendorCreditLine]] = None + lines: typing.Optional[typing.List[VendorCreditLinesItem]] = None tracking_categories: typing.Optional[typing.List[typing.Optional[VendorCreditTrackingCategoriesItem]]] = None applied_to_lines: typing.Optional[typing.List["VendorCreditApplyLineForVendorCredit"]] = pydantic.Field( default=None diff --git a/src/merge/resources/accounting/types/vendor_credit_lines_item.py b/src/merge/resources/accounting/types/vendor_credit_lines_item.py new file mode 100644 index 00000000..8ffed559 --- /dev/null +++ b/src/merge/resources/accounting/types/vendor_credit_lines_item.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +from .vendor_credit_line import VendorCreditLine + +VendorCreditLinesItem = typing.Union[str, VendorCreditLine] diff --git a/src/merge/resources/ats/__init__.py b/src/merge/resources/ats/__init__.py index 046d9bc5..b9ff74c4 100644 --- a/src/merge/resources/ats/__init__.py +++ b/src/merge/resources/ats/__init__.py @@ -64,6 +64,8 @@ CommonModelScopeApi, CommonModelScopesBodyRequest, DataPassthroughRequest, + DataPassthroughRequestMethod, + DataPassthroughRequestRequestFormat, DebugModeLog, DebugModelLogSummary, Department, @@ -104,6 +106,7 @@ JobHiringManagersItem, JobInterviewStage, JobInterviewStageJob, + JobJobPostingsItem, JobOfficesItem, JobPosting, JobPostingJob, @@ -166,6 +169,7 @@ RemoteData, RemoteEndpointInfo, RemoteFieldApi, + RemoteFieldApiAdvancedMetadata, RemoteFieldApiCoverage, RemoteFieldApiResponse, RemoteKey, @@ -356,6 +360,8 @@ "CommonModelScopeApi", "CommonModelScopesBodyRequest", "DataPassthroughRequest", + "DataPassthroughRequestMethod", + "DataPassthroughRequestRequestFormat", "DebugModeLog", "DebugModelLogSummary", "Department", @@ -405,6 +411,7 @@ "JobHiringManagersItem", "JobInterviewStage", "JobInterviewStageJob", + "JobJobPostingsItem", "JobOfficesItem", "JobPosting", "JobPostingJob", @@ -475,6 +482,7 @@ "RemoteData", "RemoteEndpointInfo", "RemoteFieldApi", + "RemoteFieldApiAdvancedMetadata", "RemoteFieldApiCoverage", "RemoteFieldApiResponse", "RemoteKey", diff --git a/src/merge/resources/ats/resources/activities/client.py b/src/merge/resources/ats/resources/activities/client.py index 4ce5438b..b3070acf 100644 --- a/src/merge/resources/ats/resources/activities/client.py +++ b/src/merge/resources/ats/resources/activities/client.py @@ -117,7 +117,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ats.activities.list() + client.ats.activities.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -387,7 +389,9 @@ async def list( async def main() -> None: - await client.ats.activities.list() + await client.ats.activities.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ats/resources/applications/client.py b/src/merge/resources/ats/resources/applications/client.py index 36f211ba..e4f5f142 100644 --- a/src/merge/resources/ats/resources/applications/client.py +++ b/src/merge/resources/ats/resources/applications/client.py @@ -127,7 +127,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ats.applications.list() + client.ats.applications.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( candidate_id=candidate_id, @@ -473,7 +475,9 @@ async def list( async def main() -> None: - await client.ats.applications.list() + await client.ats.applications.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ats/resources/attachments/client.py b/src/merge/resources/ats/resources/attachments/client.py index 02e1d145..ba606803 100644 --- a/src/merge/resources/ats/resources/attachments/client.py +++ b/src/merge/resources/ats/resources/attachments/client.py @@ -113,7 +113,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ats.attachments.list() + client.ats.attachments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( candidate_id=candidate_id, @@ -383,7 +385,9 @@ async def list( async def main() -> None: - await client.ats.attachments.list() + await client.ats.attachments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ats/resources/audit_trail/client.py b/src/merge/resources/ats/resources/audit_trail/client.py index 51f2e0df..a9942a91 100644 --- a/src/merge/resources/ats/resources/audit_trail/client.py +++ b/src/merge/resources/ats/resources/audit_trail/client.py @@ -73,7 +73,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ats.audit_trail.list() + client.ats.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( cursor=cursor, @@ -157,7 +159,9 @@ async def list( async def main() -> None: - await client.ats.audit_trail.list() + await client.ats.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ats/resources/candidates/client.py b/src/merge/resources/ats/resources/candidates/client.py index 418b1d66..434b18a1 100644 --- a/src/merge/resources/ats/resources/candidates/client.py +++ b/src/merge/resources/ats/resources/candidates/client.py @@ -121,7 +121,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ats.candidates.list() + client.ats.candidates.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -522,7 +524,9 @@ async def list( async def main() -> None: - await client.ats.candidates.list() + await client.ats.candidates.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ats/resources/departments/client.py b/src/merge/resources/ats/resources/departments/client.py index 549ad189..d543959c 100644 --- a/src/merge/resources/ats/resources/departments/client.py +++ b/src/merge/resources/ats/resources/departments/client.py @@ -91,7 +91,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ats.departments.list() + client.ats.departments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -244,7 +246,9 @@ async def list( async def main() -> None: - await client.ats.departments.list() + await client.ats.departments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ats/resources/eeocs/client.py b/src/merge/resources/ats/resources/eeocs/client.py index 7c83afcb..4a848651 100644 --- a/src/merge/resources/ats/resources/eeocs/client.py +++ b/src/merge/resources/ats/resources/eeocs/client.py @@ -111,7 +111,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ats.eeocs.list() + client.ats.eeocs.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( candidate_id=candidate_id, @@ -299,7 +301,9 @@ async def list( async def main() -> None: - await client.ats.eeocs.list() + await client.ats.eeocs.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ats/resources/interviews/client.py b/src/merge/resources/ats/resources/interviews/client.py index 9330c06e..9acbef5c 100644 --- a/src/merge/resources/ats/resources/interviews/client.py +++ b/src/merge/resources/ats/resources/interviews/client.py @@ -127,7 +127,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ats.interviews.list() + client.ats.interviews.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( application_id=application_id, @@ -412,7 +414,9 @@ async def list( async def main() -> None: - await client.ats.interviews.list() + await client.ats.interviews.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ats/resources/issues/client.py b/src/merge/resources/ats/resources/issues/client.py index 07cdb53b..c429339f 100644 --- a/src/merge/resources/ats/resources/issues/client.py +++ b/src/merge/resources/ats/resources/issues/client.py @@ -108,7 +108,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ats.issues.list() + client.ats.issues.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( account_token=account_token, @@ -263,7 +265,9 @@ async def list( async def main() -> None: - await client.ats.issues.list() + await client.ats.issues.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ats/resources/job_interview_stages/client.py b/src/merge/resources/ats/resources/job_interview_stages/client.py index 1133af8e..9dbb31c6 100644 --- a/src/merge/resources/ats/resources/job_interview_stages/client.py +++ b/src/merge/resources/ats/resources/job_interview_stages/client.py @@ -99,7 +99,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ats.job_interview_stages.list() + client.ats.job_interview_stages.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -267,7 +269,9 @@ async def list( async def main() -> None: - await client.ats.job_interview_stages.list() + await client.ats.job_interview_stages.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ats/resources/job_postings/client.py b/src/merge/resources/ats/resources/job_postings/client.py index eec24b7e..7187c098 100644 --- a/src/merge/resources/ats/resources/job_postings/client.py +++ b/src/merge/resources/ats/resources/job_postings/client.py @@ -106,7 +106,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ats.job_postings.list() + client.ats.job_postings.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -280,7 +282,9 @@ async def list( async def main() -> None: - await client.ats.job_postings.list() + await client.ats.job_postings.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ats/resources/jobs/client.py b/src/merge/resources/ats/resources/jobs/client.py index 73d353e0..1dc28a48 100644 --- a/src/merge/resources/ats/resources/jobs/client.py +++ b/src/merge/resources/ats/resources/jobs/client.py @@ -126,7 +126,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ats.jobs.list() + client.ats.jobs.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( code=code, @@ -268,6 +270,7 @@ def screening_questions_list( ) client.ats.jobs.screening_questions_list( job_id="job_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) """ _response = self._raw_client.screening_questions_list( @@ -399,7 +402,9 @@ async def list( async def main() -> None: - await client.ats.jobs.list() + await client.ats.jobs.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -557,6 +562,7 @@ async def screening_questions_list( async def main() -> None: await client.ats.jobs.screening_questions_list( job_id="job_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) diff --git a/src/merge/resources/ats/resources/linked_accounts/client.py b/src/merge/resources/ats/resources/linked_accounts/client.py index cd72d270..d11c05c4 100644 --- a/src/merge/resources/ats/resources/linked_accounts/client.py +++ b/src/merge/resources/ats/resources/linked_accounts/client.py @@ -109,7 +109,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ats.linked_accounts.list() + client.ats.linked_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( category=category, @@ -235,7 +237,9 @@ async def list( async def main() -> None: - await client.ats.linked_accounts.list() + await client.ats.linked_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ats/resources/offers/client.py b/src/merge/resources/ats/resources/offers/client.py index 910b32ad..4737bf2e 100644 --- a/src/merge/resources/ats/resources/offers/client.py +++ b/src/merge/resources/ats/resources/offers/client.py @@ -113,7 +113,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ats.offers.list() + client.ats.offers.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( application_id=application_id, @@ -306,7 +308,9 @@ async def list( async def main() -> None: - await client.ats.offers.list() + await client.ats.offers.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ats/resources/offices/client.py b/src/merge/resources/ats/resources/offices/client.py index 323998d6..173aa017 100644 --- a/src/merge/resources/ats/resources/offices/client.py +++ b/src/merge/resources/ats/resources/offices/client.py @@ -91,7 +91,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ats.offices.list() + client.ats.offices.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -244,7 +246,9 @@ async def list( async def main() -> None: - await client.ats.offices.list() + await client.ats.offices.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ats/resources/reject_reasons/client.py b/src/merge/resources/ats/resources/reject_reasons/client.py index 36cf953e..107fb931 100644 --- a/src/merge/resources/ats/resources/reject_reasons/client.py +++ b/src/merge/resources/ats/resources/reject_reasons/client.py @@ -91,7 +91,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ats.reject_reasons.list() + client.ats.reject_reasons.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -244,7 +246,9 @@ async def list( async def main() -> None: - await client.ats.reject_reasons.list() + await client.ats.reject_reasons.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ats/resources/scorecards/client.py b/src/merge/resources/ats/resources/scorecards/client.py index 0df3750e..d24fa3cf 100644 --- a/src/merge/resources/ats/resources/scorecards/client.py +++ b/src/merge/resources/ats/resources/scorecards/client.py @@ -117,7 +117,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ats.scorecards.list() + client.ats.scorecards.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( application_id=application_id, @@ -315,7 +317,9 @@ async def list( async def main() -> None: - await client.ats.scorecards.list() + await client.ats.scorecards.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ats/resources/sync_status/client.py b/src/merge/resources/ats/resources/sync_status/client.py index c87a7fcd..7eebd768 100644 --- a/src/merge/resources/ats/resources/sync_status/client.py +++ b/src/merge/resources/ats/resources/sync_status/client.py @@ -57,7 +57,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ats.sync_status.list() + client.ats.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list(cursor=cursor, page_size=page_size, request_options=request_options) return _response.data @@ -117,7 +119,9 @@ async def list( async def main() -> None: - await client.ats.sync_status.list() + await client.ats.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ats/resources/tags/client.py b/src/merge/resources/ats/resources/tags/client.py index 8e447a7d..9aa39684 100644 --- a/src/merge/resources/ats/resources/tags/client.py +++ b/src/merge/resources/ats/resources/tags/client.py @@ -90,7 +90,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ats.tags.list() + client.ats.tags.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -194,7 +196,9 @@ async def list( async def main() -> None: - await client.ats.tags.list() + await client.ats.tags.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ats/resources/users/client.py b/src/merge/resources/ats/resources/users/client.py index b09b7e5b..0046a79f 100644 --- a/src/merge/resources/ats/resources/users/client.py +++ b/src/merge/resources/ats/resources/users/client.py @@ -103,7 +103,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ats.users.list() + client.ats.users.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -281,7 +283,9 @@ async def list( async def main() -> None: - await client.ats.users.list() + await client.ats.users.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ats/types/__init__.py b/src/merge/resources/ats/types/__init__.py index ad1fbf7d..02ad2970 100644 --- a/src/merge/resources/ats/types/__init__.py +++ b/src/merge/resources/ats/types/__init__.py @@ -63,6 +63,8 @@ from .common_model_scope_api import CommonModelScopeApi from .common_model_scopes_body_request import CommonModelScopesBodyRequest from .data_passthrough_request import DataPassthroughRequest +from .data_passthrough_request_method import DataPassthroughRequestMethod +from .data_passthrough_request_request_format import DataPassthroughRequestRequestFormat from .debug_mode_log import DebugModeLog from .debug_model_log_summary import DebugModelLogSummary from .department import Department @@ -105,6 +107,7 @@ from .job_hiring_managers_item import JobHiringManagersItem from .job_interview_stage import JobInterviewStage from .job_interview_stage_job import JobInterviewStageJob +from .job_job_postings_item import JobJobPostingsItem from .job_offices_item import JobOfficesItem from .job_posting import JobPosting from .job_posting_job import JobPostingJob @@ -167,6 +170,7 @@ from .remote_data import RemoteData from .remote_endpoint_info import RemoteEndpointInfo from .remote_field_api import RemoteFieldApi +from .remote_field_api_advanced_metadata import RemoteFieldApiAdvancedMetadata from .remote_field_api_coverage import RemoteFieldApiCoverage from .remote_field_api_response import RemoteFieldApiResponse from .remote_key import RemoteKey @@ -284,6 +288,8 @@ "CommonModelScopeApi", "CommonModelScopesBodyRequest", "DataPassthroughRequest", + "DataPassthroughRequestMethod", + "DataPassthroughRequestRequestFormat", "DebugModeLog", "DebugModelLogSummary", "Department", @@ -324,6 +330,7 @@ "JobHiringManagersItem", "JobInterviewStage", "JobInterviewStageJob", + "JobJobPostingsItem", "JobOfficesItem", "JobPosting", "JobPostingJob", @@ -386,6 +393,7 @@ "RemoteData", "RemoteEndpointInfo", "RemoteFieldApi", + "RemoteFieldApiAdvancedMetadata", "RemoteFieldApiCoverage", "RemoteFieldApiResponse", "RemoteKey", diff --git a/src/merge/resources/ats/types/application.py b/src/merge/resources/ats/types/application.py index 8aad0835..3353858a 100644 --- a/src/merge/resources/ats/types/application.py +++ b/src/merge/resources/ats/types/application.py @@ -103,6 +103,8 @@ class Config: from .candidate import Candidate # noqa: E402, F401, I001 +from .job import Job # noqa: E402, F401, I001 +from .job_posting import JobPosting # noqa: E402, F401, I001 from .offer import Offer # noqa: E402, F401, I001 from .application_candidate import ApplicationCandidate # noqa: E402, F401, I001 from .application_offers_item import ApplicationOffersItem # noqa: E402, F401, I001 diff --git a/src/merge/resources/ats/types/application_request.py b/src/merge/resources/ats/types/application_request.py index ca0a600e..5c75afbb 100644 --- a/src/merge/resources/ats/types/application_request.py +++ b/src/merge/resources/ats/types/application_request.py @@ -85,6 +85,8 @@ class Config: from .application import Application # noqa: E402, F401, I001 from .candidate import Candidate # noqa: E402, F401, I001 +from .job import Job # noqa: E402, F401, I001 +from .job_posting import JobPosting # noqa: E402, F401, I001 from .offer import Offer # noqa: E402, F401, I001 update_forward_refs(ApplicationRequest) diff --git a/src/merge/resources/ats/types/application_request_screening_question_answers_item.py b/src/merge/resources/ats/types/application_request_screening_question_answers_item.py index 810e10fa..70def6b9 100644 --- a/src/merge/resources/ats/types/application_request_screening_question_answers_item.py +++ b/src/merge/resources/ats/types/application_request_screening_question_answers_item.py @@ -2,6 +2,6 @@ import typing -from .screening_question_answer_request import ScreeningQuestionAnswerRequest +from .screening_question_answer import ScreeningQuestionAnswer -ApplicationRequestScreeningQuestionAnswersItem = typing.Union[str, ScreeningQuestionAnswerRequest] +ApplicationRequestScreeningQuestionAnswersItem = typing.Union[str, ScreeningQuestionAnswer] diff --git a/src/merge/resources/ats/types/application_response.py b/src/merge/resources/ats/types/application_response.py index 8f5121a7..ba7953b7 100644 --- a/src/merge/resources/ats/types/application_response.py +++ b/src/merge/resources/ats/types/application_response.py @@ -30,6 +30,8 @@ class Config: from .application import Application # noqa: E402, F401, I001 from .candidate import Candidate # noqa: E402, F401, I001 +from .job import Job # noqa: E402, F401, I001 +from .job_posting import JobPosting # noqa: E402, F401, I001 from .offer import Offer # noqa: E402, F401, I001 update_forward_refs(ApplicationResponse) diff --git a/src/merge/resources/ats/types/candidate.py b/src/merge/resources/ats/types/candidate.py index 38f223dc..071e4a1e 100644 --- a/src/merge/resources/ats/types/candidate.py +++ b/src/merge/resources/ats/types/candidate.py @@ -129,6 +129,8 @@ class Config: from .application import Application # noqa: E402, F401, I001 +from .job import Job # noqa: E402, F401, I001 +from .job_posting import JobPosting # noqa: E402, F401, I001 from .offer import Offer # noqa: E402, F401, I001 from .candidate_applications_item import CandidateApplicationsItem # noqa: E402, F401, I001 diff --git a/src/merge/resources/ats/types/candidate_request.py b/src/merge/resources/ats/types/candidate_request.py index bc8cf926..a7b112b9 100644 --- a/src/merge/resources/ats/types/candidate_request.py +++ b/src/merge/resources/ats/types/candidate_request.py @@ -102,6 +102,8 @@ class Config: from .application import Application # noqa: E402, F401, I001 from .candidate import Candidate # noqa: E402, F401, I001 +from .job import Job # noqa: E402, F401, I001 +from .job_posting import JobPosting # noqa: E402, F401, I001 from .offer import Offer # noqa: E402, F401, I001 update_forward_refs(CandidateRequest) diff --git a/src/merge/resources/ats/types/candidate_response.py b/src/merge/resources/ats/types/candidate_response.py index 56292f9f..2bb8b8cc 100644 --- a/src/merge/resources/ats/types/candidate_response.py +++ b/src/merge/resources/ats/types/candidate_response.py @@ -30,6 +30,8 @@ class Config: from .application import Application # noqa: E402, F401, I001 from .candidate import Candidate # noqa: E402, F401, I001 +from .job import Job # noqa: E402, F401, I001 +from .job_posting import JobPosting # noqa: E402, F401, I001 from .offer import Offer # noqa: E402, F401, I001 update_forward_refs(CandidateResponse) diff --git a/src/merge/resources/ats/types/data_passthrough_request.py b/src/merge/resources/ats/types/data_passthrough_request.py index c9f0a799..5a60bfb6 100644 --- a/src/merge/resources/ats/types/data_passthrough_request.py +++ b/src/merge/resources/ats/types/data_passthrough_request.py @@ -5,9 +5,9 @@ import pydantic from ....core.pydantic_utilities import IS_PYDANTIC_V2 from ....core.unchecked_base_model import UncheckedBaseModel -from .method_enum import MethodEnum +from .data_passthrough_request_method import DataPassthroughRequestMethod +from .data_passthrough_request_request_format import DataPassthroughRequestRequestFormat from .multipart_form_field_request import MultipartFormFieldRequest -from .request_format_enum import RequestFormatEnum class DataPassthroughRequest(UncheckedBaseModel): @@ -20,7 +20,7 @@ class DataPassthroughRequest(UncheckedBaseModel): Create a `DataPassthrough` to get team hierarchies from your Rippling integration. """ - method: MethodEnum + method: DataPassthroughRequestMethod path: str = pydantic.Field() """ The path of the request in the third party's platform. @@ -46,7 +46,7 @@ class DataPassthroughRequest(UncheckedBaseModel): The headers to use for the request (Merge will handle the account's authorization headers). `Content-Type` header is required for passthrough. Choose content type corresponding to expected format of receiving server. """ - request_format: typing.Optional[RequestFormatEnum] = None + request_format: typing.Optional[DataPassthroughRequestRequestFormat] = None normalize_response: typing.Optional[bool] = pydantic.Field(default=None) """ Optional. If true, the response will always be an object of the form `{"type": T, "value": ...}` where `T` will be one of `string, boolean, number, null, array, object`. diff --git a/src/merge/resources/ats/types/data_passthrough_request_method.py b/src/merge/resources/ats/types/data_passthrough_request_method.py new file mode 100644 index 00000000..58874cbf --- /dev/null +++ b/src/merge/resources/ats/types/data_passthrough_request_method.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +from .method_enum import MethodEnum + +DataPassthroughRequestMethod = typing.Union[MethodEnum, str] diff --git a/src/merge/resources/ats/types/data_passthrough_request_request_format.py b/src/merge/resources/ats/types/data_passthrough_request_request_format.py new file mode 100644 index 00000000..13dc95f0 --- /dev/null +++ b/src/merge/resources/ats/types/data_passthrough_request_request_format.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +from .request_format_enum import RequestFormatEnum + +DataPassthroughRequestRequestFormat = typing.Union[RequestFormatEnum, str] diff --git a/src/merge/resources/ats/types/eeoc.py b/src/merge/resources/ats/types/eeoc.py index 8091638f..dbdae892 100644 --- a/src/merge/resources/ats/types/eeoc.py +++ b/src/merge/resources/ats/types/eeoc.py @@ -114,6 +114,8 @@ class Config: from .application import Application # noqa: E402, F401, I001 from .candidate import Candidate # noqa: E402, F401, I001 +from .job import Job # noqa: E402, F401, I001 +from .job_posting import JobPosting # noqa: E402, F401, I001 from .offer import Offer # noqa: E402, F401, I001 update_forward_refs(Eeoc) diff --git a/src/merge/resources/ats/types/event_type_enum.py b/src/merge/resources/ats/types/event_type_enum.py index 6f6f1476..537cea3f 100644 --- a/src/merge/resources/ats/types/event_type_enum.py +++ b/src/merge/resources/ats/types/event_type_enum.py @@ -58,6 +58,7 @@ class EventTypeEnum(str, enum.Enum): CREATED_TEST_API_KEY = "CREATED_TEST_API_KEY" DELETED_TEST_API_KEY = "DELETED_TEST_API_KEY" REGENERATED_PRODUCTION_API_KEY = "REGENERATED_PRODUCTION_API_KEY" + REGENERATED_WEBHOOK_SIGNATURE = "REGENERATED_WEBHOOK_SIGNATURE" INVITED_USER = "INVITED_USER" TWO_FACTOR_AUTH_ENABLED = "TWO_FACTOR_AUTH_ENABLED" TWO_FACTOR_AUTH_DISABLED = "TWO_FACTOR_AUTH_DISABLED" @@ -103,6 +104,7 @@ def visit( created_test_api_key: typing.Callable[[], T_Result], deleted_test_api_key: typing.Callable[[], T_Result], regenerated_production_api_key: typing.Callable[[], T_Result], + regenerated_webhook_signature: typing.Callable[[], T_Result], invited_user: typing.Callable[[], T_Result], two_factor_auth_enabled: typing.Callable[[], T_Result], two_factor_auth_disabled: typing.Callable[[], T_Result], @@ -151,6 +153,8 @@ def visit( return deleted_test_api_key() if self is EventTypeEnum.REGENERATED_PRODUCTION_API_KEY: return regenerated_production_api_key() + if self is EventTypeEnum.REGENERATED_WEBHOOK_SIGNATURE: + return regenerated_webhook_signature() if self is EventTypeEnum.INVITED_USER: return invited_user() if self is EventTypeEnum.TWO_FACTOR_AUTH_ENABLED: diff --git a/src/merge/resources/ats/types/job.py b/src/merge/resources/ats/types/job.py index 81413e39..e3602058 100644 --- a/src/merge/resources/ats/types/job.py +++ b/src/merge/resources/ats/types/job.py @@ -1,10 +1,12 @@ # This file was auto-generated by Fern from our API Definition. +from __future__ import annotations + import datetime as dt import typing import pydantic -from ....core.pydantic_utilities import IS_PYDANTIC_V2 +from ....core.pydantic_utilities import IS_PYDANTIC_V2, update_forward_refs from ....core.unchecked_base_model import UncheckedBaseModel from .job_departments_item import JobDepartmentsItem from .job_hiring_managers_item import JobHiringManagersItem @@ -76,7 +78,7 @@ class Job(UncheckedBaseModel): * `PROFILE` - PROFILE """ - job_postings: typing.Optional[typing.List[typing.Optional[str]]] = pydantic.Field(default=None) + job_postings: typing.Optional[typing.List[typing.Optional["JobJobPostingsItem"]]] = pydantic.Field(default=None) """ IDs of `JobPosting` objects that serve as job postings for this `Job`. """ @@ -133,3 +135,9 @@ class Config: frozen = True smart_union = True extra = pydantic.Extra.allow + + +from .job_posting import JobPosting # noqa: E402, F401, I001 +from .job_job_postings_item import JobJobPostingsItem # noqa: E402, F401, I001 + +update_forward_refs(Job) diff --git a/src/merge/resources/ats/types/job_interview_stage.py b/src/merge/resources/ats/types/job_interview_stage.py index 6925d1e3..7e09aca8 100644 --- a/src/merge/resources/ats/types/job_interview_stage.py +++ b/src/merge/resources/ats/types/job_interview_stage.py @@ -1,10 +1,12 @@ # This file was auto-generated by Fern from our API Definition. +from __future__ import annotations + import datetime as dt import typing import pydantic -from ....core.pydantic_utilities import IS_PYDANTIC_V2 +from ....core.pydantic_utilities import IS_PYDANTIC_V2, update_forward_refs from ....core.unchecked_base_model import UncheckedBaseModel from .job_interview_stage_job import JobInterviewStageJob from .remote_data import RemoteData @@ -66,3 +68,9 @@ class Config: frozen = True smart_union = True extra = pydantic.Extra.allow + + +from .job import Job # noqa: E402, F401, I001 +from .job_posting import JobPosting # noqa: E402, F401, I001 + +update_forward_refs(JobInterviewStage) diff --git a/src/merge/resources/ats/types/job_job_postings_item.py b/src/merge/resources/ats/types/job_job_postings_item.py new file mode 100644 index 00000000..89de73c2 --- /dev/null +++ b/src/merge/resources/ats/types/job_job_postings_item.py @@ -0,0 +1,9 @@ +# This file was auto-generated by Fern from our API Definition. + +from __future__ import annotations + +import typing + +if typing.TYPE_CHECKING: + from .job_posting import JobPosting +JobJobPostingsItem = typing.Union[str, "JobPosting"] diff --git a/src/merge/resources/ats/types/job_posting.py b/src/merge/resources/ats/types/job_posting.py index ec539320..a43467d8 100644 --- a/src/merge/resources/ats/types/job_posting.py +++ b/src/merge/resources/ats/types/job_posting.py @@ -1,12 +1,13 @@ # This file was auto-generated by Fern from our API Definition. +from __future__ import annotations + import datetime as dt import typing import pydantic -from ....core.pydantic_utilities import IS_PYDANTIC_V2 +from ....core.pydantic_utilities import IS_PYDANTIC_V2, update_forward_refs from ....core.unchecked_base_model import UncheckedBaseModel -from .job_posting_job import JobPostingJob from .job_posting_job_posting_urls_item import JobPostingJobPostingUrlsItem from .job_posting_status import JobPostingStatus from .remote_data import RemoteData @@ -47,7 +48,7 @@ class JobPosting(UncheckedBaseModel): The Url object is used to represent hyperlinks for a candidate to apply to a given job. """ - job: typing.Optional[JobPostingJob] = pydantic.Field(default=None) + job: typing.Optional["JobPostingJob"] = pydantic.Field(default=None) """ ID of `Job` object for this `JobPosting`. """ @@ -99,3 +100,9 @@ class Config: frozen = True smart_union = True extra = pydantic.Extra.allow + + +from .job import Job # noqa: E402, F401, I001 +from .job_posting_job import JobPostingJob # noqa: E402, F401, I001 + +update_forward_refs(JobPosting) diff --git a/src/merge/resources/ats/types/job_posting_job.py b/src/merge/resources/ats/types/job_posting_job.py index 764f306f..3d459780 100644 --- a/src/merge/resources/ats/types/job_posting_job.py +++ b/src/merge/resources/ats/types/job_posting_job.py @@ -1,7 +1,9 @@ # This file was auto-generated by Fern from our API Definition. -import typing +from __future__ import annotations -from .job import Job +import typing -JobPostingJob = typing.Union[str, Job] +if typing.TYPE_CHECKING: + from .job import Job +JobPostingJob = typing.Union[str, "Job"] diff --git a/src/merge/resources/ats/types/offer.py b/src/merge/resources/ats/types/offer.py index d0046de7..a41e1f18 100644 --- a/src/merge/resources/ats/types/offer.py +++ b/src/merge/resources/ats/types/offer.py @@ -103,6 +103,8 @@ class Config: from .application import Application # noqa: E402, F401, I001 from .candidate import Candidate # noqa: E402, F401, I001 +from .job import Job # noqa: E402, F401, I001 +from .job_posting import JobPosting # noqa: E402, F401, I001 from .offer_application import OfferApplication # noqa: E402, F401, I001 update_forward_refs(Offer) diff --git a/src/merge/resources/ats/types/paginated_application_list.py b/src/merge/resources/ats/types/paginated_application_list.py index bf13e66f..3ae4a8c3 100644 --- a/src/merge/resources/ats/types/paginated_application_list.py +++ b/src/merge/resources/ats/types/paginated_application_list.py @@ -26,6 +26,8 @@ class Config: from .application import Application # noqa: E402, F401, I001 from .candidate import Candidate # noqa: E402, F401, I001 +from .job import Job # noqa: E402, F401, I001 +from .job_posting import JobPosting # noqa: E402, F401, I001 from .offer import Offer # noqa: E402, F401, I001 update_forward_refs(PaginatedApplicationList) diff --git a/src/merge/resources/ats/types/paginated_candidate_list.py b/src/merge/resources/ats/types/paginated_candidate_list.py index a46dff6b..5ecf773c 100644 --- a/src/merge/resources/ats/types/paginated_candidate_list.py +++ b/src/merge/resources/ats/types/paginated_candidate_list.py @@ -26,6 +26,8 @@ class Config: from .application import Application # noqa: E402, F401, I001 from .candidate import Candidate # noqa: E402, F401, I001 +from .job import Job # noqa: E402, F401, I001 +from .job_posting import JobPosting # noqa: E402, F401, I001 from .offer import Offer # noqa: E402, F401, I001 update_forward_refs(PaginatedCandidateList) diff --git a/src/merge/resources/ats/types/paginated_eeoc_list.py b/src/merge/resources/ats/types/paginated_eeoc_list.py index f797f81f..0073b706 100644 --- a/src/merge/resources/ats/types/paginated_eeoc_list.py +++ b/src/merge/resources/ats/types/paginated_eeoc_list.py @@ -27,6 +27,8 @@ class Config: from .application import Application # noqa: E402, F401, I001 from .candidate import Candidate # noqa: E402, F401, I001 +from .job import Job # noqa: E402, F401, I001 +from .job_posting import JobPosting # noqa: E402, F401, I001 from .offer import Offer # noqa: E402, F401, I001 update_forward_refs(PaginatedEeocList) diff --git a/src/merge/resources/ats/types/paginated_job_interview_stage_list.py b/src/merge/resources/ats/types/paginated_job_interview_stage_list.py index a7014ea4..204fb1a7 100644 --- a/src/merge/resources/ats/types/paginated_job_interview_stage_list.py +++ b/src/merge/resources/ats/types/paginated_job_interview_stage_list.py @@ -1,9 +1,11 @@ # This file was auto-generated by Fern from our API Definition. +from __future__ import annotations + import typing import pydantic -from ....core.pydantic_utilities import IS_PYDANTIC_V2 +from ....core.pydantic_utilities import IS_PYDANTIC_V2, update_forward_refs from ....core.unchecked_base_model import UncheckedBaseModel from .job_interview_stage import JobInterviewStage @@ -21,3 +23,9 @@ class Config: frozen = True smart_union = True extra = pydantic.Extra.allow + + +from .job import Job # noqa: E402, F401, I001 +from .job_posting import JobPosting # noqa: E402, F401, I001 + +update_forward_refs(PaginatedJobInterviewStageList) diff --git a/src/merge/resources/ats/types/paginated_job_list.py b/src/merge/resources/ats/types/paginated_job_list.py index 87040408..c949837c 100644 --- a/src/merge/resources/ats/types/paginated_job_list.py +++ b/src/merge/resources/ats/types/paginated_job_list.py @@ -1,17 +1,18 @@ # This file was auto-generated by Fern from our API Definition. +from __future__ import annotations + import typing import pydantic -from ....core.pydantic_utilities import IS_PYDANTIC_V2 +from ....core.pydantic_utilities import IS_PYDANTIC_V2, update_forward_refs from ....core.unchecked_base_model import UncheckedBaseModel -from .job import Job class PaginatedJobList(UncheckedBaseModel): next: typing.Optional[str] = None previous: typing.Optional[str] = None - results: typing.Optional[typing.List[Job]] = None + results: typing.Optional[typing.List["Job"]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 @@ -21,3 +22,9 @@ class Config: frozen = True smart_union = True extra = pydantic.Extra.allow + + +from .job import Job # noqa: E402, F401, I001 +from .job_posting import JobPosting # noqa: E402, F401, I001 + +update_forward_refs(PaginatedJobList) diff --git a/src/merge/resources/ats/types/paginated_job_posting_list.py b/src/merge/resources/ats/types/paginated_job_posting_list.py index 573ae196..f80a22f8 100644 --- a/src/merge/resources/ats/types/paginated_job_posting_list.py +++ b/src/merge/resources/ats/types/paginated_job_posting_list.py @@ -1,17 +1,18 @@ # This file was auto-generated by Fern from our API Definition. +from __future__ import annotations + import typing import pydantic -from ....core.pydantic_utilities import IS_PYDANTIC_V2 +from ....core.pydantic_utilities import IS_PYDANTIC_V2, update_forward_refs from ....core.unchecked_base_model import UncheckedBaseModel -from .job_posting import JobPosting class PaginatedJobPostingList(UncheckedBaseModel): next: typing.Optional[str] = None previous: typing.Optional[str] = None - results: typing.Optional[typing.List[JobPosting]] = None + results: typing.Optional[typing.List["JobPosting"]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 @@ -21,3 +22,9 @@ class Config: frozen = True smart_union = True extra = pydantic.Extra.allow + + +from .job import Job # noqa: E402, F401, I001 +from .job_posting import JobPosting # noqa: E402, F401, I001 + +update_forward_refs(PaginatedJobPostingList) diff --git a/src/merge/resources/ats/types/paginated_offer_list.py b/src/merge/resources/ats/types/paginated_offer_list.py index 1a4932a6..b7575abc 100644 --- a/src/merge/resources/ats/types/paginated_offer_list.py +++ b/src/merge/resources/ats/types/paginated_offer_list.py @@ -26,6 +26,8 @@ class Config: from .application import Application # noqa: E402, F401, I001 from .candidate import Candidate # noqa: E402, F401, I001 +from .job import Job # noqa: E402, F401, I001 +from .job_posting import JobPosting # noqa: E402, F401, I001 from .offer import Offer # noqa: E402, F401, I001 update_forward_refs(PaginatedOfferList) diff --git a/src/merge/resources/ats/types/paginated_scheduled_interview_list.py b/src/merge/resources/ats/types/paginated_scheduled_interview_list.py index 6aca0c2b..193baa45 100644 --- a/src/merge/resources/ats/types/paginated_scheduled_interview_list.py +++ b/src/merge/resources/ats/types/paginated_scheduled_interview_list.py @@ -27,6 +27,8 @@ class Config: from .application import Application # noqa: E402, F401, I001 from .candidate import Candidate # noqa: E402, F401, I001 +from .job import Job # noqa: E402, F401, I001 +from .job_posting import JobPosting # noqa: E402, F401, I001 from .offer import Offer # noqa: E402, F401, I001 update_forward_refs(PaginatedScheduledInterviewList) diff --git a/src/merge/resources/ats/types/paginated_scorecard_list.py b/src/merge/resources/ats/types/paginated_scorecard_list.py index f42a495c..e8bf292c 100644 --- a/src/merge/resources/ats/types/paginated_scorecard_list.py +++ b/src/merge/resources/ats/types/paginated_scorecard_list.py @@ -27,6 +27,8 @@ class Config: from .application import Application # noqa: E402, F401, I001 from .candidate import Candidate # noqa: E402, F401, I001 +from .job import Job # noqa: E402, F401, I001 +from .job_posting import JobPosting # noqa: E402, F401, I001 from .offer import Offer # noqa: E402, F401, I001 update_forward_refs(PaginatedScorecardList) diff --git a/src/merge/resources/ats/types/paginated_screening_question_list.py b/src/merge/resources/ats/types/paginated_screening_question_list.py index f4306ba8..2455ae4f 100644 --- a/src/merge/resources/ats/types/paginated_screening_question_list.py +++ b/src/merge/resources/ats/types/paginated_screening_question_list.py @@ -1,9 +1,11 @@ # This file was auto-generated by Fern from our API Definition. +from __future__ import annotations + import typing import pydantic -from ....core.pydantic_utilities import IS_PYDANTIC_V2 +from ....core.pydantic_utilities import IS_PYDANTIC_V2, update_forward_refs from ....core.unchecked_base_model import UncheckedBaseModel from .screening_question import ScreeningQuestion @@ -21,3 +23,9 @@ class Config: frozen = True smart_union = True extra = pydantic.Extra.allow + + +from .job import Job # noqa: E402, F401, I001 +from .job_posting import JobPosting # noqa: E402, F401, I001 + +update_forward_refs(PaginatedScreeningQuestionList) diff --git a/src/merge/resources/ats/types/remote_field_api.py b/src/merge/resources/ats/types/remote_field_api.py index 4c66a23b..0756bfc3 100644 --- a/src/merge/resources/ats/types/remote_field_api.py +++ b/src/merge/resources/ats/types/remote_field_api.py @@ -5,8 +5,8 @@ import pydantic from ....core.pydantic_utilities import IS_PYDANTIC_V2 from ....core.unchecked_base_model import UncheckedBaseModel -from .advanced_metadata import AdvancedMetadata from .remote_endpoint_info import RemoteEndpointInfo +from .remote_field_api_advanced_metadata import RemoteFieldApiAdvancedMetadata from .remote_field_api_coverage import RemoteFieldApiCoverage @@ -15,7 +15,7 @@ class RemoteFieldApi(UncheckedBaseModel): remote_key_name: str remote_endpoint_info: RemoteEndpointInfo example_values: typing.Optional[typing.List[typing.Optional[typing.Any]]] = None - advanced_metadata: typing.Optional[AdvancedMetadata] = None + advanced_metadata: typing.Optional[RemoteFieldApiAdvancedMetadata] = None coverage: typing.Optional[RemoteFieldApiCoverage] = None if IS_PYDANTIC_V2: diff --git a/src/merge/resources/ats/types/remote_field_api_advanced_metadata.py b/src/merge/resources/ats/types/remote_field_api_advanced_metadata.py new file mode 100644 index 00000000..e93da936 --- /dev/null +++ b/src/merge/resources/ats/types/remote_field_api_advanced_metadata.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +from .advanced_metadata import AdvancedMetadata + +RemoteFieldApiAdvancedMetadata = typing.Union[AdvancedMetadata, str] diff --git a/src/merge/resources/ats/types/scheduled_interview.py b/src/merge/resources/ats/types/scheduled_interview.py index 1c31538d..68029b8f 100644 --- a/src/merge/resources/ats/types/scheduled_interview.py +++ b/src/merge/resources/ats/types/scheduled_interview.py @@ -117,6 +117,8 @@ class Config: from .application import Application # noqa: E402, F401, I001 from .candidate import Candidate # noqa: E402, F401, I001 +from .job import Job # noqa: E402, F401, I001 +from .job_posting import JobPosting # noqa: E402, F401, I001 from .offer import Offer # noqa: E402, F401, I001 update_forward_refs(ScheduledInterview) diff --git a/src/merge/resources/ats/types/scheduled_interview_request.py b/src/merge/resources/ats/types/scheduled_interview_request.py index b5b12bc5..34e03ee7 100644 --- a/src/merge/resources/ats/types/scheduled_interview_request.py +++ b/src/merge/resources/ats/types/scheduled_interview_request.py @@ -85,6 +85,8 @@ class Config: from .application import Application # noqa: E402, F401, I001 from .candidate import Candidate # noqa: E402, F401, I001 +from .job import Job # noqa: E402, F401, I001 +from .job_posting import JobPosting # noqa: E402, F401, I001 from .offer import Offer # noqa: E402, F401, I001 update_forward_refs(ScheduledInterviewRequest) diff --git a/src/merge/resources/ats/types/scheduled_interview_response.py b/src/merge/resources/ats/types/scheduled_interview_response.py index 280fff51..13022119 100644 --- a/src/merge/resources/ats/types/scheduled_interview_response.py +++ b/src/merge/resources/ats/types/scheduled_interview_response.py @@ -31,6 +31,8 @@ class Config: from .application import Application # noqa: E402, F401, I001 from .candidate import Candidate # noqa: E402, F401, I001 +from .job import Job # noqa: E402, F401, I001 +from .job_posting import JobPosting # noqa: E402, F401, I001 from .offer import Offer # noqa: E402, F401, I001 update_forward_refs(ScheduledInterviewResponse) diff --git a/src/merge/resources/ats/types/scorecard.py b/src/merge/resources/ats/types/scorecard.py index 3e713f87..b2863185 100644 --- a/src/merge/resources/ats/types/scorecard.py +++ b/src/merge/resources/ats/types/scorecard.py @@ -96,6 +96,8 @@ class Config: from .application import Application # noqa: E402, F401, I001 from .candidate import Candidate # noqa: E402, F401, I001 +from .job import Job # noqa: E402, F401, I001 +from .job_posting import JobPosting # noqa: E402, F401, I001 from .offer import Offer # noqa: E402, F401, I001 update_forward_refs(Scorecard) diff --git a/src/merge/resources/ats/types/screening_question.py b/src/merge/resources/ats/types/screening_question.py index 245cbd2a..3ed94283 100644 --- a/src/merge/resources/ats/types/screening_question.py +++ b/src/merge/resources/ats/types/screening_question.py @@ -1,10 +1,12 @@ # This file was auto-generated by Fern from our API Definition. +from __future__ import annotations + import datetime as dt import typing import pydantic -from ....core.pydantic_utilities import IS_PYDANTIC_V2 +from ....core.pydantic_utilities import IS_PYDANTIC_V2, update_forward_refs from ....core.unchecked_base_model import UncheckedBaseModel from .screening_question_job import ScreeningQuestionJob from .screening_question_type import ScreeningQuestionType @@ -84,3 +86,9 @@ class Config: frozen = True smart_union = True extra = pydantic.Extra.allow + + +from .job import Job # noqa: E402, F401, I001 +from .job_posting import JobPosting # noqa: E402, F401, I001 + +update_forward_refs(ScreeningQuestion) diff --git a/src/merge/resources/ats/types/screening_question_answer.py b/src/merge/resources/ats/types/screening_question_answer.py index b6bc1ab2..83c26ecf 100644 --- a/src/merge/resources/ats/types/screening_question_answer.py +++ b/src/merge/resources/ats/types/screening_question_answer.py @@ -1,10 +1,12 @@ # This file was auto-generated by Fern from our API Definition. +from __future__ import annotations + import datetime as dt import typing import pydantic -from ....core.pydantic_utilities import IS_PYDANTIC_V2 +from ....core.pydantic_utilities import IS_PYDANTIC_V2, update_forward_refs from ....core.unchecked_base_model import UncheckedBaseModel from .screening_question_answer_question import ScreeningQuestionAnswerQuestion @@ -58,3 +60,9 @@ class Config: frozen = True smart_union = True extra = pydantic.Extra.allow + + +from .job import Job # noqa: E402, F401, I001 +from .job_posting import JobPosting # noqa: E402, F401, I001 + +update_forward_refs(ScreeningQuestionAnswer) diff --git a/src/merge/resources/ats/types/screening_question_answer_request.py b/src/merge/resources/ats/types/screening_question_answer_request.py index af62b520..21910969 100644 --- a/src/merge/resources/ats/types/screening_question_answer_request.py +++ b/src/merge/resources/ats/types/screening_question_answer_request.py @@ -1,9 +1,11 @@ # This file was auto-generated by Fern from our API Definition. +from __future__ import annotations + import typing import pydantic -from ....core.pydantic_utilities import IS_PYDANTIC_V2 +from ....core.pydantic_utilities import IS_PYDANTIC_V2, update_forward_refs from ....core.unchecked_base_model import UncheckedBaseModel from .screening_question_answer_request_question import ScreeningQuestionAnswerRequestQuestion @@ -44,3 +46,9 @@ class Config: frozen = True smart_union = True extra = pydantic.Extra.allow + + +from .job import Job # noqa: E402, F401, I001 +from .job_posting import JobPosting # noqa: E402, F401, I001 + +update_forward_refs(ScreeningQuestionAnswerRequest) diff --git a/src/merge/resources/crm/__init__.py b/src/merge/resources/crm/__init__.py index cfdb5f13..a13a8aee 100644 --- a/src/merge/resources/crm/__init__.py +++ b/src/merge/resources/crm/__init__.py @@ -43,10 +43,8 @@ CommonModelScopesBodyRequest, Contact, ContactAccount, - ContactOwner, ContactRequest, ContactRequestAccount, - ContactRequestOwner, CountryEnum, CrmAccountResponse, CrmAssociationTypeResponse, @@ -56,6 +54,8 @@ CustomObjectClass, CustomObjectRequest, DataPassthroughRequest, + DataPassthroughRequestMethod, + DataPassthroughRequestRequestFormat, DebugModeLog, DebugModelLogSummary, DirectionEnum, @@ -317,10 +317,8 @@ "CommonModelScopesBodyRequest", "Contact", "ContactAccount", - "ContactOwner", "ContactRequest", "ContactRequestAccount", - "ContactRequestOwner", "ContactsListRequestExpand", "ContactsRetrieveRequestExpand", "CountryEnum", @@ -332,6 +330,8 @@ "CustomObjectClass", "CustomObjectRequest", "DataPassthroughRequest", + "DataPassthroughRequestMethod", + "DataPassthroughRequestRequestFormat", "DebugModeLog", "DebugModelLogSummary", "DirectionEnum", diff --git a/src/merge/resources/crm/resources/accounts/client.py b/src/merge/resources/crm/resources/accounts/client.py index b8b90549..88508090 100644 --- a/src/merge/resources/crm/resources/accounts/client.py +++ b/src/merge/resources/crm/resources/accounts/client.py @@ -115,7 +115,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.accounts.list() + client.crm.accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -409,7 +411,9 @@ def remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.accounts.remote_field_classes_list() + client.crm.accounts.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.remote_field_classes_list( cursor=cursor, @@ -527,7 +531,9 @@ async def list( async def main() -> None: - await client.crm.accounts.list() + await client.crm.accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -871,7 +877,9 @@ async def remote_field_classes_list( async def main() -> None: - await client.crm.accounts.remote_field_classes_list() + await client.crm.accounts.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/crm/resources/association_types/client.py b/src/merge/resources/crm/resources/association_types/client.py index b58c597e..cb747530 100644 --- a/src/merge/resources/crm/resources/association_types/client.py +++ b/src/merge/resources/crm/resources/association_types/client.py @@ -106,6 +106,7 @@ def custom_object_classes_association_types_list( ) client.crm.association_types.custom_object_classes_association_types_list( custom_object_class_id="custom_object_class_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) """ _response = self._raw_client.custom_object_classes_association_types_list( @@ -386,6 +387,7 @@ async def custom_object_classes_association_types_list( async def main() -> None: await client.crm.association_types.custom_object_classes_association_types_list( custom_object_class_id="custom_object_class_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) diff --git a/src/merge/resources/crm/resources/associations/client.py b/src/merge/resources/crm/resources/associations/client.py index 7591b917..e2d95ae8 100644 --- a/src/merge/resources/crm/resources/associations/client.py +++ b/src/merge/resources/crm/resources/associations/client.py @@ -108,6 +108,7 @@ def custom_object_classes_custom_objects_associations_list( client.crm.associations.custom_object_classes_custom_objects_associations_list( custom_object_class_id="custom_object_class_id", object_id="object_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) """ _response = self._raw_client.custom_object_classes_custom_objects_associations_list( @@ -302,6 +303,7 @@ async def main() -> None: await client.crm.associations.custom_object_classes_custom_objects_associations_list( custom_object_class_id="custom_object_class_id", object_id="object_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) diff --git a/src/merge/resources/crm/resources/audit_trail/client.py b/src/merge/resources/crm/resources/audit_trail/client.py index ec2a114a..71e19cdb 100644 --- a/src/merge/resources/crm/resources/audit_trail/client.py +++ b/src/merge/resources/crm/resources/audit_trail/client.py @@ -73,7 +73,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.audit_trail.list() + client.crm.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( cursor=cursor, @@ -157,7 +159,9 @@ async def list( async def main() -> None: - await client.crm.audit_trail.list() + await client.crm.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/crm/resources/contacts/client.py b/src/merge/resources/crm/resources/contacts/client.py index 6359a159..a51b2f47 100644 --- a/src/merge/resources/crm/resources/contacts/client.py +++ b/src/merge/resources/crm/resources/contacts/client.py @@ -122,7 +122,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.contacts.list() + client.crm.contacts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( account_id=account_id, @@ -459,7 +461,9 @@ def remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.contacts.remote_field_classes_list() + client.crm.contacts.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.remote_field_classes_list( cursor=cursor, @@ -581,7 +585,9 @@ async def list( async def main() -> None: - await client.crm.contacts.list() + await client.crm.contacts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -976,7 +982,9 @@ async def remote_field_classes_list( async def main() -> None: - await client.crm.contacts.remote_field_classes_list() + await client.crm.contacts.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/crm/resources/custom_object_classes/client.py b/src/merge/resources/crm/resources/custom_object_classes/client.py index eedd7490..9289295c 100644 --- a/src/merge/resources/crm/resources/custom_object_classes/client.py +++ b/src/merge/resources/crm/resources/custom_object_classes/client.py @@ -95,7 +95,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.custom_object_classes.list() + client.crm.custom_object_classes.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -258,7 +260,9 @@ async def list( async def main() -> None: - await client.crm.custom_object_classes.list() + await client.crm.custom_object_classes.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/crm/resources/custom_objects/client.py b/src/merge/resources/crm/resources/custom_objects/client.py index aeb76cc5..41354143 100644 --- a/src/merge/resources/crm/resources/custom_objects/client.py +++ b/src/merge/resources/crm/resources/custom_objects/client.py @@ -107,6 +107,7 @@ def custom_object_classes_custom_objects_list( ) client.crm.custom_objects.custom_object_classes_custom_objects_list( custom_object_class_id="custom_object_class_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) """ _response = self._raw_client.custom_object_classes_custom_objects_list( @@ -335,7 +336,9 @@ def custom_object_classes_custom_objects_remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_classes_list() + client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.custom_object_classes_custom_objects_remote_field_classes_list( cursor=cursor, @@ -446,6 +449,7 @@ async def custom_object_classes_custom_objects_list( async def main() -> None: await client.crm.custom_objects.custom_object_classes_custom_objects_list( custom_object_class_id="custom_object_class_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -706,7 +710,9 @@ async def custom_object_classes_custom_objects_remote_field_classes_list( async def main() -> None: - await client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_classes_list() + await client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/crm/resources/engagement_types/client.py b/src/merge/resources/crm/resources/engagement_types/client.py index 2535a49e..df7faa0f 100644 --- a/src/merge/resources/crm/resources/engagement_types/client.py +++ b/src/merge/resources/crm/resources/engagement_types/client.py @@ -96,7 +96,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.engagement_types.list() + client.crm.engagement_types.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -226,7 +228,9 @@ def remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.engagement_types.remote_field_classes_list() + client.crm.engagement_types.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.remote_field_classes_list( cursor=cursor, @@ -332,7 +336,9 @@ async def list( async def main() -> None: - await client.crm.engagement_types.list() + await client.crm.engagement_types.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -478,7 +484,9 @@ async def remote_field_classes_list( async def main() -> None: - await client.crm.engagement_types.remote_field_classes_list() + await client.crm.engagement_types.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/crm/resources/engagements/client.py b/src/merge/resources/crm/resources/engagements/client.py index 0bc28fd7..42174adf 100644 --- a/src/merge/resources/crm/resources/engagements/client.py +++ b/src/merge/resources/crm/resources/engagements/client.py @@ -117,7 +117,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.engagements.list() + client.crm.engagements.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -411,7 +413,9 @@ def remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.engagements.remote_field_classes_list() + client.crm.engagements.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.remote_field_classes_list( cursor=cursor, @@ -529,7 +533,9 @@ async def list( async def main() -> None: - await client.crm.engagements.list() + await client.crm.engagements.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -873,7 +879,9 @@ async def remote_field_classes_list( async def main() -> None: - await client.crm.engagements.remote_field_classes_list() + await client.crm.engagements.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/crm/resources/issues/client.py b/src/merge/resources/crm/resources/issues/client.py index e967f73c..a9237e53 100644 --- a/src/merge/resources/crm/resources/issues/client.py +++ b/src/merge/resources/crm/resources/issues/client.py @@ -108,7 +108,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.issues.list() + client.crm.issues.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( account_token=account_token, @@ -263,7 +265,9 @@ async def list( async def main() -> None: - await client.crm.issues.list() + await client.crm.issues.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/crm/resources/leads/client.py b/src/merge/resources/crm/resources/leads/client.py index ba711e50..793ea73b 100644 --- a/src/merge/resources/crm/resources/leads/client.py +++ b/src/merge/resources/crm/resources/leads/client.py @@ -128,7 +128,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.leads.list() + client.crm.leads.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( converted_account_id=converted_account_id, @@ -343,7 +345,9 @@ def remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.leads.remote_field_classes_list() + client.crm.leads.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.remote_field_classes_list( cursor=cursor, @@ -473,7 +477,9 @@ async def list( async def main() -> None: - await client.crm.leads.list() + await client.crm.leads.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -720,7 +726,9 @@ async def remote_field_classes_list( async def main() -> None: - await client.crm.leads.remote_field_classes_list() + await client.crm.leads.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/crm/resources/linked_accounts/client.py b/src/merge/resources/crm/resources/linked_accounts/client.py index 479471b9..80b19ced 100644 --- a/src/merge/resources/crm/resources/linked_accounts/client.py +++ b/src/merge/resources/crm/resources/linked_accounts/client.py @@ -109,7 +109,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.linked_accounts.list() + client.crm.linked_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( category=category, @@ -235,7 +237,9 @@ async def list( async def main() -> None: - await client.crm.linked_accounts.list() + await client.crm.linked_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/crm/resources/notes/client.py b/src/merge/resources/crm/resources/notes/client.py index 5ed1e428..f7fbd530 100644 --- a/src/merge/resources/crm/resources/notes/client.py +++ b/src/merge/resources/crm/resources/notes/client.py @@ -124,7 +124,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.notes.list() + client.crm.notes.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( account_id=account_id, @@ -338,7 +340,9 @@ def remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.notes.remote_field_classes_list() + client.crm.notes.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.remote_field_classes_list( cursor=cursor, @@ -464,7 +468,9 @@ async def list( async def main() -> None: - await client.crm.notes.list() + await client.crm.notes.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -710,7 +716,9 @@ async def remote_field_classes_list( async def main() -> None: - await client.crm.notes.remote_field_classes_list() + await client.crm.notes.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/crm/resources/opportunities/client.py b/src/merge/resources/crm/resources/opportunities/client.py index c11ecf96..9e0e15e0 100644 --- a/src/merge/resources/crm/resources/opportunities/client.py +++ b/src/merge/resources/crm/resources/opportunities/client.py @@ -142,7 +142,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.opportunities.list() + client.crm.opportunities.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( account_id=account_id, @@ -451,7 +453,9 @@ def remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.opportunities.remote_field_classes_list() + client.crm.opportunities.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.remote_field_classes_list( cursor=cursor, @@ -593,7 +597,9 @@ async def list( async def main() -> None: - await client.crm.opportunities.list() + await client.crm.opportunities.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -952,7 +958,9 @@ async def remote_field_classes_list( async def main() -> None: - await client.crm.opportunities.remote_field_classes_list() + await client.crm.opportunities.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/crm/resources/stages/client.py b/src/merge/resources/crm/resources/stages/client.py index fd69a8ba..efe35689 100644 --- a/src/merge/resources/crm/resources/stages/client.py +++ b/src/merge/resources/crm/resources/stages/client.py @@ -96,7 +96,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.stages.list() + client.crm.stages.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -226,7 +228,9 @@ def remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.stages.remote_field_classes_list() + client.crm.stages.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.remote_field_classes_list( cursor=cursor, @@ -332,7 +336,9 @@ async def list( async def main() -> None: - await client.crm.stages.list() + await client.crm.stages.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -478,7 +484,9 @@ async def remote_field_classes_list( async def main() -> None: - await client.crm.stages.remote_field_classes_list() + await client.crm.stages.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/crm/resources/sync_status/client.py b/src/merge/resources/crm/resources/sync_status/client.py index 8f210d28..9a72c5cc 100644 --- a/src/merge/resources/crm/resources/sync_status/client.py +++ b/src/merge/resources/crm/resources/sync_status/client.py @@ -57,7 +57,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.sync_status.list() + client.crm.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list(cursor=cursor, page_size=page_size, request_options=request_options) return _response.data @@ -117,7 +119,9 @@ async def list( async def main() -> None: - await client.crm.sync_status.list() + await client.crm.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/crm/resources/tasks/client.py b/src/merge/resources/crm/resources/tasks/client.py index 4e61ae97..15a16cee 100644 --- a/src/merge/resources/crm/resources/tasks/client.py +++ b/src/merge/resources/crm/resources/tasks/client.py @@ -109,7 +109,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.tasks.list() + client.crm.tasks.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -401,7 +403,9 @@ def remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.tasks.remote_field_classes_list() + client.crm.tasks.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.remote_field_classes_list( cursor=cursor, @@ -511,7 +515,9 @@ async def list( async def main() -> None: - await client.crm.tasks.list() + await client.crm.tasks.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -853,7 +859,9 @@ async def remote_field_classes_list( async def main() -> None: - await client.crm.tasks.remote_field_classes_list() + await client.crm.tasks.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/crm/resources/users/client.py b/src/merge/resources/crm/resources/users/client.py index 1fd91cdb..d5671794 100644 --- a/src/merge/resources/crm/resources/users/client.py +++ b/src/merge/resources/crm/resources/users/client.py @@ -104,7 +104,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.users.list() + client.crm.users.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -277,7 +279,9 @@ def remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.users.remote_field_classes_list() + client.crm.users.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.remote_field_classes_list( cursor=cursor, @@ -387,7 +391,9 @@ async def list( async def main() -> None: - await client.crm.users.list() + await client.crm.users.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -584,7 +590,9 @@ async def remote_field_classes_list( async def main() -> None: - await client.crm.users.remote_field_classes_list() + await client.crm.users.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/crm/types/__init__.py b/src/merge/resources/crm/types/__init__.py index 2579ae68..e39b03a1 100644 --- a/src/merge/resources/crm/types/__init__.py +++ b/src/merge/resources/crm/types/__init__.py @@ -42,10 +42,8 @@ from .common_model_scopes_body_request import CommonModelScopesBodyRequest from .contact import Contact from .contact_account import ContactAccount -from .contact_owner import ContactOwner from .contact_request import ContactRequest from .contact_request_account import ContactRequestAccount -from .contact_request_owner import ContactRequestOwner from .country_enum import CountryEnum from .crm_account_response import CrmAccountResponse from .crm_association_type_response import CrmAssociationTypeResponse @@ -55,6 +53,8 @@ from .custom_object_class import CustomObjectClass from .custom_object_request import CustomObjectRequest from .data_passthrough_request import DataPassthroughRequest +from .data_passthrough_request_method import DataPassthroughRequestMethod +from .data_passthrough_request_request_format import DataPassthroughRequestRequestFormat from .debug_mode_log import DebugModeLog from .debug_model_log_summary import DebugModelLogSummary from .direction_enum import DirectionEnum @@ -268,10 +268,8 @@ "CommonModelScopesBodyRequest", "Contact", "ContactAccount", - "ContactOwner", "ContactRequest", "ContactRequestAccount", - "ContactRequestOwner", "CountryEnum", "CrmAccountResponse", "CrmAssociationTypeResponse", @@ -281,6 +279,8 @@ "CustomObjectClass", "CustomObjectRequest", "DataPassthroughRequest", + "DataPassthroughRequestMethod", + "DataPassthroughRequestRequestFormat", "DebugModeLog", "DebugModelLogSummary", "DirectionEnum", diff --git a/src/merge/resources/crm/types/contact.py b/src/merge/resources/crm/types/contact.py index d5b7019a..b8020219 100644 --- a/src/merge/resources/crm/types/contact.py +++ b/src/merge/resources/crm/types/contact.py @@ -8,7 +8,6 @@ from ....core.unchecked_base_model import UncheckedBaseModel from .address import Address from .contact_account import ContactAccount -from .contact_owner import ContactOwner from .email_address import EmailAddress from .phone_number import PhoneNumber from .remote_data import RemoteData @@ -55,7 +54,7 @@ class Contact(UncheckedBaseModel): The contact's account. """ - owner: typing.Optional[ContactOwner] = pydantic.Field(default=None) + owner: typing.Optional[str] = pydantic.Field(default=None) """ The contact's owner. """ diff --git a/src/merge/resources/crm/types/contact_owner.py b/src/merge/resources/crm/types/contact_owner.py deleted file mode 100644 index 24fc6dc1..00000000 --- a/src/merge/resources/crm/types/contact_owner.py +++ /dev/null @@ -1,7 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -import typing - -from .user import User - -ContactOwner = typing.Union[str, User] diff --git a/src/merge/resources/crm/types/contact_request.py b/src/merge/resources/crm/types/contact_request.py index 12849554..c9dac361 100644 --- a/src/merge/resources/crm/types/contact_request.py +++ b/src/merge/resources/crm/types/contact_request.py @@ -8,7 +8,6 @@ from ....core.unchecked_base_model import UncheckedBaseModel from .address_request import AddressRequest from .contact_request_account import ContactRequestAccount -from .contact_request_owner import ContactRequestOwner from .email_address_request import EmailAddressRequest from .phone_number_request import PhoneNumberRequest from .remote_field_request import RemoteFieldRequest @@ -38,7 +37,7 @@ class ContactRequest(UncheckedBaseModel): The contact's account. """ - owner: typing.Optional[ContactRequestOwner] = pydantic.Field(default=None) + owner: typing.Optional[str] = pydantic.Field(default=None) """ The contact's owner. """ diff --git a/src/merge/resources/crm/types/contact_request_owner.py b/src/merge/resources/crm/types/contact_request_owner.py deleted file mode 100644 index c41de073..00000000 --- a/src/merge/resources/crm/types/contact_request_owner.py +++ /dev/null @@ -1,7 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -import typing - -from .user import User - -ContactRequestOwner = typing.Union[str, User] diff --git a/src/merge/resources/crm/types/data_passthrough_request.py b/src/merge/resources/crm/types/data_passthrough_request.py index c9f0a799..5a60bfb6 100644 --- a/src/merge/resources/crm/types/data_passthrough_request.py +++ b/src/merge/resources/crm/types/data_passthrough_request.py @@ -5,9 +5,9 @@ import pydantic from ....core.pydantic_utilities import IS_PYDANTIC_V2 from ....core.unchecked_base_model import UncheckedBaseModel -from .method_enum import MethodEnum +from .data_passthrough_request_method import DataPassthroughRequestMethod +from .data_passthrough_request_request_format import DataPassthroughRequestRequestFormat from .multipart_form_field_request import MultipartFormFieldRequest -from .request_format_enum import RequestFormatEnum class DataPassthroughRequest(UncheckedBaseModel): @@ -20,7 +20,7 @@ class DataPassthroughRequest(UncheckedBaseModel): Create a `DataPassthrough` to get team hierarchies from your Rippling integration. """ - method: MethodEnum + method: DataPassthroughRequestMethod path: str = pydantic.Field() """ The path of the request in the third party's platform. @@ -46,7 +46,7 @@ class DataPassthroughRequest(UncheckedBaseModel): The headers to use for the request (Merge will handle the account's authorization headers). `Content-Type` header is required for passthrough. Choose content type corresponding to expected format of receiving server. """ - request_format: typing.Optional[RequestFormatEnum] = None + request_format: typing.Optional[DataPassthroughRequestRequestFormat] = None normalize_response: typing.Optional[bool] = pydantic.Field(default=None) """ Optional. If true, the response will always be an object of the form `{"type": T, "value": ...}` where `T` will be one of `string, boolean, number, null, array, object`. diff --git a/src/merge/resources/crm/types/data_passthrough_request_method.py b/src/merge/resources/crm/types/data_passthrough_request_method.py new file mode 100644 index 00000000..58874cbf --- /dev/null +++ b/src/merge/resources/crm/types/data_passthrough_request_method.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +from .method_enum import MethodEnum + +DataPassthroughRequestMethod = typing.Union[MethodEnum, str] diff --git a/src/merge/resources/crm/types/data_passthrough_request_request_format.py b/src/merge/resources/crm/types/data_passthrough_request_request_format.py new file mode 100644 index 00000000..13dc95f0 --- /dev/null +++ b/src/merge/resources/crm/types/data_passthrough_request_request_format.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +from .request_format_enum import RequestFormatEnum + +DataPassthroughRequestRequestFormat = typing.Union[RequestFormatEnum, str] diff --git a/src/merge/resources/crm/types/remote_field_class.py b/src/merge/resources/crm/types/remote_field_class.py index 033ea3b6..76189afe 100644 --- a/src/merge/resources/crm/types/remote_field_class.py +++ b/src/merge/resources/crm/types/remote_field_class.py @@ -17,6 +17,7 @@ class RemoteFieldClass(UncheckedBaseModel): remote_key_name: typing.Optional[str] = None description: typing.Optional[str] = None is_custom: typing.Optional[bool] = None + is_common_model_field: typing.Optional[bool] = None is_required: typing.Optional[bool] = None field_type: typing.Optional[RemoteFieldClassFieldType] = None field_format: typing.Optional[RemoteFieldClassFieldFormat] = None diff --git a/src/merge/resources/filestorage/resources/audit_trail/client.py b/src/merge/resources/filestorage/resources/audit_trail/client.py index aef09b3e..05d30b6f 100644 --- a/src/merge/resources/filestorage/resources/audit_trail/client.py +++ b/src/merge/resources/filestorage/resources/audit_trail/client.py @@ -73,7 +73,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.filestorage.audit_trail.list() + client.filestorage.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( cursor=cursor, @@ -157,7 +159,9 @@ async def list( async def main() -> None: - await client.filestorage.audit_trail.list() + await client.filestorage.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/filestorage/resources/drives/client.py b/src/merge/resources/filestorage/resources/drives/client.py index 580b2c96..655ed370 100644 --- a/src/merge/resources/filestorage/resources/drives/client.py +++ b/src/merge/resources/filestorage/resources/drives/client.py @@ -95,7 +95,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.filestorage.drives.list() + client.filestorage.drives.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -253,7 +255,9 @@ async def list( async def main() -> None: - await client.filestorage.drives.list() + await client.filestorage.drives.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/filestorage/resources/files/client.py b/src/merge/resources/filestorage/resources/files/client.py index b18ef7d9..5910bfb6 100644 --- a/src/merge/resources/filestorage/resources/files/client.py +++ b/src/merge/resources/filestorage/resources/files/client.py @@ -127,7 +127,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.filestorage.files.list() + client.filestorage.files.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -389,7 +391,9 @@ def download_request_meta_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.filestorage.files.download_request_meta_list() + client.filestorage.files.download_request_meta_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.download_request_meta_list( created_after=created_after, @@ -543,7 +547,9 @@ async def list( async def main() -> None: - await client.filestorage.files.list() + await client.filestorage.files.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -838,7 +844,9 @@ async def download_request_meta_list( async def main() -> None: - await client.filestorage.files.download_request_meta_list() + await client.filestorage.files.download_request_meta_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/filestorage/resources/folders/client.py b/src/merge/resources/filestorage/resources/folders/client.py index c2a45b1f..85276beb 100644 --- a/src/merge/resources/filestorage/resources/folders/client.py +++ b/src/merge/resources/filestorage/resources/folders/client.py @@ -115,7 +115,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.filestorage.folders.list() + client.filestorage.folders.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -367,7 +369,9 @@ async def list( async def main() -> None: - await client.filestorage.folders.list() + await client.filestorage.folders.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/filestorage/resources/groups/client.py b/src/merge/resources/filestorage/resources/groups/client.py index 5e112f27..9db5bbc6 100644 --- a/src/merge/resources/filestorage/resources/groups/client.py +++ b/src/merge/resources/filestorage/resources/groups/client.py @@ -95,7 +95,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.filestorage.groups.list() + client.filestorage.groups.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -258,7 +260,9 @@ async def list( async def main() -> None: - await client.filestorage.groups.list() + await client.filestorage.groups.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/filestorage/resources/issues/client.py b/src/merge/resources/filestorage/resources/issues/client.py index c99f2054..888a1f8e 100644 --- a/src/merge/resources/filestorage/resources/issues/client.py +++ b/src/merge/resources/filestorage/resources/issues/client.py @@ -108,7 +108,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.filestorage.issues.list() + client.filestorage.issues.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( account_token=account_token, @@ -263,7 +265,9 @@ async def list( async def main() -> None: - await client.filestorage.issues.list() + await client.filestorage.issues.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/filestorage/resources/linked_accounts/client.py b/src/merge/resources/filestorage/resources/linked_accounts/client.py index fc7fe947..8ab62895 100644 --- a/src/merge/resources/filestorage/resources/linked_accounts/client.py +++ b/src/merge/resources/filestorage/resources/linked_accounts/client.py @@ -109,7 +109,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.filestorage.linked_accounts.list() + client.filestorage.linked_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( category=category, @@ -235,7 +237,9 @@ async def list( async def main() -> None: - await client.filestorage.linked_accounts.list() + await client.filestorage.linked_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/filestorage/resources/sync_status/client.py b/src/merge/resources/filestorage/resources/sync_status/client.py index 34d83f4d..4611a846 100644 --- a/src/merge/resources/filestorage/resources/sync_status/client.py +++ b/src/merge/resources/filestorage/resources/sync_status/client.py @@ -57,7 +57,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.filestorage.sync_status.list() + client.filestorage.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list(cursor=cursor, page_size=page_size, request_options=request_options) return _response.data @@ -117,7 +119,9 @@ async def list( async def main() -> None: - await client.filestorage.sync_status.list() + await client.filestorage.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/filestorage/resources/users/client.py b/src/merge/resources/filestorage/resources/users/client.py index 4616da59..dc0d037e 100644 --- a/src/merge/resources/filestorage/resources/users/client.py +++ b/src/merge/resources/filestorage/resources/users/client.py @@ -95,7 +95,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.filestorage.users.list() + client.filestorage.users.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -253,7 +255,9 @@ async def list( async def main() -> None: - await client.filestorage.users.list() + await client.filestorage.users.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/hris/__init__.py b/src/merge/resources/hris/__init__.py index adaa795d..92364b7a 100644 --- a/src/merge/resources/hris/__init__.py +++ b/src/merge/resources/hris/__init__.py @@ -7,6 +7,7 @@ AccountDetailsAndActions, AccountDetailsAndActionsCategory, AccountDetailsAndActionsIntegration, + AccountDetailsAndActionsStatus, AccountDetailsAndActionsStatusEnum, AccountDetailsCategory, AccountIntegration, @@ -285,6 +286,7 @@ "AccountDetailsAndActions", "AccountDetailsAndActionsCategory", "AccountDetailsAndActionsIntegration", + "AccountDetailsAndActionsStatus", "AccountDetailsAndActionsStatusEnum", "AccountDetailsCategory", "AccountIntegration", diff --git a/src/merge/resources/hris/resources/audit_trail/client.py b/src/merge/resources/hris/resources/audit_trail/client.py index 7f5d6791..4f8aa7d3 100644 --- a/src/merge/resources/hris/resources/audit_trail/client.py +++ b/src/merge/resources/hris/resources/audit_trail/client.py @@ -73,7 +73,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.hris.audit_trail.list() + client.hris.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( cursor=cursor, @@ -157,7 +159,9 @@ async def list( async def main() -> None: - await client.hris.audit_trail.list() + await client.hris.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/hris/resources/bank_info/client.py b/src/merge/resources/hris/resources/bank_info/client.py index baa4ff18..8923a387 100644 --- a/src/merge/resources/hris/resources/bank_info/client.py +++ b/src/merge/resources/hris/resources/bank_info/client.py @@ -124,7 +124,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.hris.bank_info.list() + client.hris.bank_info.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( account_type=account_type, @@ -330,7 +332,9 @@ async def list( async def main() -> None: - await client.hris.bank_info.list() + await client.hris.bank_info.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/hris/resources/benefits/client.py b/src/merge/resources/hris/resources/benefits/client.py index 76ed436e..a6f19dad 100644 --- a/src/merge/resources/hris/resources/benefits/client.py +++ b/src/merge/resources/hris/resources/benefits/client.py @@ -99,7 +99,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.hris.benefits.list() + client.hris.benefits.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -267,7 +269,9 @@ async def list( async def main() -> None: - await client.hris.benefits.list() + await client.hris.benefits.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/hris/resources/companies/client.py b/src/merge/resources/hris/resources/companies/client.py index 3c5355ea..5b756b5f 100644 --- a/src/merge/resources/hris/resources/companies/client.py +++ b/src/merge/resources/hris/resources/companies/client.py @@ -91,7 +91,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.hris.companies.list() + client.hris.companies.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -244,7 +246,9 @@ async def list( async def main() -> None: - await client.hris.companies.list() + await client.hris.companies.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/hris/resources/dependents/client.py b/src/merge/resources/hris/resources/dependents/client.py index 7f2f7710..bfd225ff 100644 --- a/src/merge/resources/hris/resources/dependents/client.py +++ b/src/merge/resources/hris/resources/dependents/client.py @@ -95,7 +95,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.hris.dependents.list() + client.hris.dependents.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -258,7 +260,9 @@ async def list( async def main() -> None: - await client.hris.dependents.list() + await client.hris.dependents.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/hris/resources/employee_payroll_runs/client.py b/src/merge/resources/hris/resources/employee_payroll_runs/client.py index 93dd56df..0ab87bf7 100644 --- a/src/merge/resources/hris/resources/employee_payroll_runs/client.py +++ b/src/merge/resources/hris/resources/employee_payroll_runs/client.py @@ -121,7 +121,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.hris.employee_payroll_runs.list() + client.hris.employee_payroll_runs.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -314,7 +316,9 @@ async def list( async def main() -> None: - await client.hris.employee_payroll_runs.list() + await client.hris.employee_payroll_runs.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/hris/resources/employees/client.py b/src/merge/resources/hris/resources/employees/client.py index 7c0498de..f1f60ae1 100644 --- a/src/merge/resources/hris/resources/employees/client.py +++ b/src/merge/resources/hris/resources/employees/client.py @@ -201,7 +201,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.hris.employees.list() + client.hris.employees.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( company_id=company_id, @@ -612,7 +614,9 @@ async def list( async def main() -> None: - await client.hris.employees.list() + await client.hris.employees.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/hris/resources/employer_benefits/client.py b/src/merge/resources/hris/resources/employer_benefits/client.py index 3201e062..11737216 100644 --- a/src/merge/resources/hris/resources/employer_benefits/client.py +++ b/src/merge/resources/hris/resources/employer_benefits/client.py @@ -91,7 +91,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.hris.employer_benefits.list() + client.hris.employer_benefits.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -244,7 +246,9 @@ async def list( async def main() -> None: - await client.hris.employer_benefits.list() + await client.hris.employer_benefits.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/hris/resources/employments/client.py b/src/merge/resources/hris/resources/employments/client.py index 22371621..581e1875 100644 --- a/src/merge/resources/hris/resources/employments/client.py +++ b/src/merge/resources/hris/resources/employments/client.py @@ -118,7 +118,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.hris.employments.list() + client.hris.employments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -311,7 +313,9 @@ async def list( async def main() -> None: - await client.hris.employments.list() + await client.hris.employments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/hris/resources/groups/client.py b/src/merge/resources/hris/resources/groups/client.py index 454392ad..60d862f2 100644 --- a/src/merge/resources/hris/resources/groups/client.py +++ b/src/merge/resources/hris/resources/groups/client.py @@ -111,7 +111,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.hris.groups.list() + client.hris.groups.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -299,7 +301,9 @@ async def list( async def main() -> None: - await client.hris.groups.list() + await client.hris.groups.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/hris/resources/issues/client.py b/src/merge/resources/hris/resources/issues/client.py index 3839055e..02a8ddc3 100644 --- a/src/merge/resources/hris/resources/issues/client.py +++ b/src/merge/resources/hris/resources/issues/client.py @@ -108,7 +108,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.hris.issues.list() + client.hris.issues.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( account_token=account_token, @@ -263,7 +265,9 @@ async def list( async def main() -> None: - await client.hris.issues.list() + await client.hris.issues.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/hris/resources/linked_accounts/client.py b/src/merge/resources/hris/resources/linked_accounts/client.py index fb325a41..464827a7 100644 --- a/src/merge/resources/hris/resources/linked_accounts/client.py +++ b/src/merge/resources/hris/resources/linked_accounts/client.py @@ -109,7 +109,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.hris.linked_accounts.list() + client.hris.linked_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( category=category, @@ -235,7 +237,9 @@ async def list( async def main() -> None: - await client.hris.linked_accounts.list() + await client.hris.linked_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/hris/resources/locations/client.py b/src/merge/resources/hris/resources/locations/client.py index b8b18833..12fa7031 100644 --- a/src/merge/resources/hris/resources/locations/client.py +++ b/src/merge/resources/hris/resources/locations/client.py @@ -111,7 +111,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.hris.locations.list() + client.hris.locations.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -292,7 +294,9 @@ async def list( async def main() -> None: - await client.hris.locations.list() + await client.hris.locations.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/hris/resources/pay_groups/client.py b/src/merge/resources/hris/resources/pay_groups/client.py index be59663a..abccf33a 100644 --- a/src/merge/resources/hris/resources/pay_groups/client.py +++ b/src/merge/resources/hris/resources/pay_groups/client.py @@ -91,7 +91,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.hris.pay_groups.list() + client.hris.pay_groups.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -244,7 +246,9 @@ async def list( async def main() -> None: - await client.hris.pay_groups.list() + await client.hris.pay_groups.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/hris/resources/payroll_runs/client.py b/src/merge/resources/hris/resources/payroll_runs/client.py index 9de9d3c2..5638f7df 100644 --- a/src/merge/resources/hris/resources/payroll_runs/client.py +++ b/src/merge/resources/hris/resources/payroll_runs/client.py @@ -130,7 +130,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.hris.payroll_runs.list() + client.hris.payroll_runs.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -334,7 +336,9 @@ async def list( async def main() -> None: - await client.hris.payroll_runs.list() + await client.hris.payroll_runs.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/hris/resources/sync_status/client.py b/src/merge/resources/hris/resources/sync_status/client.py index fb1b6a50..aa845f9e 100644 --- a/src/merge/resources/hris/resources/sync_status/client.py +++ b/src/merge/resources/hris/resources/sync_status/client.py @@ -57,7 +57,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.hris.sync_status.list() + client.hris.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list(cursor=cursor, page_size=page_size, request_options=request_options) return _response.data @@ -117,7 +119,9 @@ async def list( async def main() -> None: - await client.hris.sync_status.list() + await client.hris.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/hris/resources/teams/client.py b/src/merge/resources/hris/resources/teams/client.py index f0ba24da..f17a9a47 100644 --- a/src/merge/resources/hris/resources/teams/client.py +++ b/src/merge/resources/hris/resources/teams/client.py @@ -99,7 +99,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.hris.teams.list() + client.hris.teams.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -267,7 +269,9 @@ async def list( async def main() -> None: - await client.hris.teams.list() + await client.hris.teams.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/hris/resources/time_off/client.py b/src/merge/resources/hris/resources/time_off/client.py index ff2cbfb7..5d3d3239 100644 --- a/src/merge/resources/hris/resources/time_off/client.py +++ b/src/merge/resources/hris/resources/time_off/client.py @@ -162,7 +162,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.hris.time_off.list() + client.hris.time_off.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( approver_id=approver_id, @@ -472,7 +474,9 @@ async def list( async def main() -> None: - await client.hris.time_off.list() + await client.hris.time_off.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/hris/resources/time_off_balances/client.py b/src/merge/resources/hris/resources/time_off_balances/client.py index 9b32ead7..6f272e00 100644 --- a/src/merge/resources/hris/resources/time_off_balances/client.py +++ b/src/merge/resources/hris/resources/time_off_balances/client.py @@ -119,7 +119,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.hris.time_off_balances.list() + client.hris.time_off_balances.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -319,7 +321,9 @@ async def list( async def main() -> None: - await client.hris.time_off_balances.list() + await client.hris.time_off_balances.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/hris/resources/timesheet_entries/client.py b/src/merge/resources/hris/resources/timesheet_entries/client.py index 5162fa48..5689a64a 100644 --- a/src/merge/resources/hris/resources/timesheet_entries/client.py +++ b/src/merge/resources/hris/resources/timesheet_entries/client.py @@ -126,7 +126,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.hris.timesheet_entries.list() + client.hris.timesheet_entries.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -393,7 +395,9 @@ async def list( async def main() -> None: - await client.hris.timesheet_entries.list() + await client.hris.timesheet_entries.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/hris/types/__init__.py b/src/merge/resources/hris/types/__init__.py index 43825e60..17c843bd 100644 --- a/src/merge/resources/hris/types/__init__.py +++ b/src/merge/resources/hris/types/__init__.py @@ -6,6 +6,7 @@ from .account_details_and_actions import AccountDetailsAndActions from .account_details_and_actions_category import AccountDetailsAndActionsCategory from .account_details_and_actions_integration import AccountDetailsAndActionsIntegration +from .account_details_and_actions_status import AccountDetailsAndActionsStatus from .account_details_and_actions_status_enum import AccountDetailsAndActionsStatusEnum from .account_details_category import AccountDetailsCategory from .account_integration import AccountIntegration @@ -207,6 +208,7 @@ "AccountDetailsAndActions", "AccountDetailsAndActionsCategory", "AccountDetailsAndActionsIntegration", + "AccountDetailsAndActionsStatus", "AccountDetailsAndActionsStatusEnum", "AccountDetailsCategory", "AccountIntegration", diff --git a/src/merge/resources/hris/types/account_details_and_actions.py b/src/merge/resources/hris/types/account_details_and_actions.py index 551a4fa5..93c874ed 100644 --- a/src/merge/resources/hris/types/account_details_and_actions.py +++ b/src/merge/resources/hris/types/account_details_and_actions.py @@ -8,7 +8,7 @@ from ....core.unchecked_base_model import UncheckedBaseModel from .account_details_and_actions_category import AccountDetailsAndActionsCategory from .account_details_and_actions_integration import AccountDetailsAndActionsIntegration -from .account_details_and_actions_status_enum import AccountDetailsAndActionsStatusEnum +from .account_details_and_actions_status import AccountDetailsAndActionsStatus class AccountDetailsAndActions(UncheckedBaseModel): @@ -23,7 +23,7 @@ class AccountDetailsAndActions(UncheckedBaseModel): id: str category: typing.Optional[AccountDetailsAndActionsCategory] = None - status: AccountDetailsAndActionsStatusEnum + status: AccountDetailsAndActionsStatus status_detail: typing.Optional[str] = None end_user_origin_id: typing.Optional[str] = None end_user_organization_name: str diff --git a/src/merge/resources/hris/types/account_details_and_actions_status.py b/src/merge/resources/hris/types/account_details_and_actions_status.py new file mode 100644 index 00000000..445922f8 --- /dev/null +++ b/src/merge/resources/hris/types/account_details_and_actions_status.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +from .account_details_and_actions_status_enum import AccountDetailsAndActionsStatusEnum + +AccountDetailsAndActionsStatus = typing.Union[AccountDetailsAndActionsStatusEnum, str] diff --git a/src/merge/resources/hris/types/benefit.py b/src/merge/resources/hris/types/benefit.py index fb4a9388..3ceeb1bc 100644 --- a/src/merge/resources/hris/types/benefit.py +++ b/src/merge/resources/hris/types/benefit.py @@ -73,14 +73,14 @@ class Benefit(UncheckedBaseModel): The day and time the benefit ended. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field(default=None) + employer_benefit: typing.Optional[str] = pydantic.Field(default=None) """ - Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). + The employer benefit plan the employee is enrolled in. """ - employer_benefit: typing.Optional[str] = pydantic.Field(default=None) + remote_was_deleted: typing.Optional[bool] = pydantic.Field(default=None) """ - The employer benefit plan the employee is enrolled in. + Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). """ field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None diff --git a/src/merge/resources/ticketing/__init__.py b/src/merge/resources/ticketing/__init__.py index 7264e48f..e2595b11 100644 --- a/src/merge/resources/ticketing/__init__.py +++ b/src/merge/resources/ticketing/__init__.py @@ -132,6 +132,7 @@ StatusFd5Enum, SyncStatus, SyncStatusLastSyncResult, + SyncStatusStatus, Tag, Team, Ticket, @@ -362,6 +363,7 @@ "StatusFd5Enum", "SyncStatus", "SyncStatusLastSyncResult", + "SyncStatusStatus", "Tag", "Team", "Ticket", diff --git a/src/merge/resources/ticketing/resources/accounts/client.py b/src/merge/resources/ticketing/resources/accounts/client.py index 1ecd7ee2..0eb93e75 100644 --- a/src/merge/resources/ticketing/resources/accounts/client.py +++ b/src/merge/resources/ticketing/resources/accounts/client.py @@ -91,7 +91,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ticketing.accounts.list() + client.ticketing.accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -244,7 +246,9 @@ async def list( async def main() -> None: - await client.ticketing.accounts.list() + await client.ticketing.accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ticketing/resources/attachments/client.py b/src/merge/resources/ticketing/resources/attachments/client.py index 8d8155a7..ff82e3cf 100644 --- a/src/merge/resources/ticketing/resources/attachments/client.py +++ b/src/merge/resources/ticketing/resources/attachments/client.py @@ -109,7 +109,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ticketing.attachments.list() + client.ticketing.attachments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -390,7 +392,9 @@ async def list( async def main() -> None: - await client.ticketing.attachments.list() + await client.ticketing.attachments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ticketing/resources/audit_trail/client.py b/src/merge/resources/ticketing/resources/audit_trail/client.py index 59fe3392..40225482 100644 --- a/src/merge/resources/ticketing/resources/audit_trail/client.py +++ b/src/merge/resources/ticketing/resources/audit_trail/client.py @@ -73,7 +73,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ticketing.audit_trail.list() + client.ticketing.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( cursor=cursor, @@ -157,7 +159,9 @@ async def list( async def main() -> None: - await client.ticketing.audit_trail.list() + await client.ticketing.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ticketing/resources/collections/client.py b/src/merge/resources/ticketing/resources/collections/client.py index 16675970..74184c4e 100644 --- a/src/merge/resources/ticketing/resources/collections/client.py +++ b/src/merge/resources/ticketing/resources/collections/client.py @@ -113,7 +113,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ticketing.collections.list() + client.ticketing.collections.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( collection_type=collection_type, @@ -190,6 +192,7 @@ def viewers_list( ) client.ticketing.collections.viewers_list( collection_id="collection_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) """ _response = self._raw_client.viewers_list( @@ -375,7 +378,9 @@ async def list( async def main() -> None: - await client.ticketing.collections.list() + await client.ticketing.collections.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -460,6 +465,7 @@ async def viewers_list( async def main() -> None: await client.ticketing.collections.viewers_list( collection_id="collection_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) diff --git a/src/merge/resources/ticketing/resources/comments/client.py b/src/merge/resources/ticketing/resources/comments/client.py index 06b7d2d6..179ad2a1 100644 --- a/src/merge/resources/ticketing/resources/comments/client.py +++ b/src/merge/resources/ticketing/resources/comments/client.py @@ -111,7 +111,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ticketing.comments.list() + client.ticketing.comments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -358,7 +360,9 @@ async def list( async def main() -> None: - await client.ticketing.comments.list() + await client.ticketing.comments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ticketing/resources/contacts/client.py b/src/merge/resources/ticketing/resources/contacts/client.py index aa5fe595..2b29b8c0 100644 --- a/src/merge/resources/ticketing/resources/contacts/client.py +++ b/src/merge/resources/ticketing/resources/contacts/client.py @@ -37,6 +37,7 @@ def list( created_after: typing.Optional[dt.datetime] = None, created_before: typing.Optional[dt.datetime] = None, cursor: typing.Optional[str] = None, + email_address: typing.Optional[str] = None, expand: typing.Optional[typing.Literal["account"]] = None, include_deleted_data: typing.Optional[bool] = None, include_remote_data: typing.Optional[bool] = None, @@ -61,6 +62,9 @@ def list( cursor : typing.Optional[str] The pagination cursor value. + email_address : typing.Optional[str] + If provided, will only return Contacts that match this email. + expand : typing.Optional[typing.Literal["account"]] Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. @@ -101,12 +105,15 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ticketing.contacts.list() + client.ticketing.contacts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, created_before=created_before, cursor=cursor, + email_address=email_address, expand=expand, include_deleted_data=include_deleted_data, include_remote_data=include_remote_data, @@ -269,6 +276,7 @@ async def list( created_after: typing.Optional[dt.datetime] = None, created_before: typing.Optional[dt.datetime] = None, cursor: typing.Optional[str] = None, + email_address: typing.Optional[str] = None, expand: typing.Optional[typing.Literal["account"]] = None, include_deleted_data: typing.Optional[bool] = None, include_remote_data: typing.Optional[bool] = None, @@ -293,6 +301,9 @@ async def list( cursor : typing.Optional[str] The pagination cursor value. + email_address : typing.Optional[str] + If provided, will only return Contacts that match this email. + expand : typing.Optional[typing.Literal["account"]] Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. @@ -338,7 +349,9 @@ async def list( async def main() -> None: - await client.ticketing.contacts.list() + await client.ticketing.contacts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -347,6 +360,7 @@ async def main() -> None: created_after=created_after, created_before=created_before, cursor=cursor, + email_address=email_address, expand=expand, include_deleted_data=include_deleted_data, include_remote_data=include_remote_data, diff --git a/src/merge/resources/ticketing/resources/contacts/raw_client.py b/src/merge/resources/ticketing/resources/contacts/raw_client.py index f1a96051..2ba84bbb 100644 --- a/src/merge/resources/ticketing/resources/contacts/raw_client.py +++ b/src/merge/resources/ticketing/resources/contacts/raw_client.py @@ -31,6 +31,7 @@ def list( created_after: typing.Optional[dt.datetime] = None, created_before: typing.Optional[dt.datetime] = None, cursor: typing.Optional[str] = None, + email_address: typing.Optional[str] = None, expand: typing.Optional[typing.Literal["account"]] = None, include_deleted_data: typing.Optional[bool] = None, include_remote_data: typing.Optional[bool] = None, @@ -55,6 +56,9 @@ def list( cursor : typing.Optional[str] The pagination cursor value. + email_address : typing.Optional[str] + If provided, will only return Contacts that match this email. + expand : typing.Optional[typing.Literal["account"]] Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. @@ -94,6 +98,7 @@ def list( "created_after": serialize_datetime(created_after) if created_after is not None else None, "created_before": serialize_datetime(created_before) if created_before is not None else None, "cursor": cursor, + "email_address": email_address, "expand": expand, "include_deleted_data": include_deleted_data, "include_remote_data": include_remote_data, @@ -285,6 +290,7 @@ async def list( created_after: typing.Optional[dt.datetime] = None, created_before: typing.Optional[dt.datetime] = None, cursor: typing.Optional[str] = None, + email_address: typing.Optional[str] = None, expand: typing.Optional[typing.Literal["account"]] = None, include_deleted_data: typing.Optional[bool] = None, include_remote_data: typing.Optional[bool] = None, @@ -309,6 +315,9 @@ async def list( cursor : typing.Optional[str] The pagination cursor value. + email_address : typing.Optional[str] + If provided, will only return Contacts that match this email. + expand : typing.Optional[typing.Literal["account"]] Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. @@ -348,6 +357,7 @@ async def list( "created_after": serialize_datetime(created_after) if created_after is not None else None, "created_before": serialize_datetime(created_before) if created_before is not None else None, "cursor": cursor, + "email_address": email_address, "expand": expand, "include_deleted_data": include_deleted_data, "include_remote_data": include_remote_data, diff --git a/src/merge/resources/ticketing/resources/issues/client.py b/src/merge/resources/ticketing/resources/issues/client.py index ea663780..24550de7 100644 --- a/src/merge/resources/ticketing/resources/issues/client.py +++ b/src/merge/resources/ticketing/resources/issues/client.py @@ -108,7 +108,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ticketing.issues.list() + client.ticketing.issues.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( account_token=account_token, @@ -263,7 +265,9 @@ async def list( async def main() -> None: - await client.ticketing.issues.list() + await client.ticketing.issues.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ticketing/resources/linked_accounts/client.py b/src/merge/resources/ticketing/resources/linked_accounts/client.py index afaca7a3..31a9f3db 100644 --- a/src/merge/resources/ticketing/resources/linked_accounts/client.py +++ b/src/merge/resources/ticketing/resources/linked_accounts/client.py @@ -109,7 +109,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ticketing.linked_accounts.list() + client.ticketing.linked_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( category=category, @@ -235,7 +237,9 @@ async def list( async def main() -> None: - await client.ticketing.linked_accounts.list() + await client.ticketing.linked_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ticketing/resources/projects/client.py b/src/merge/resources/ticketing/resources/projects/client.py index be9c4fb2..edb34c7f 100644 --- a/src/merge/resources/ticketing/resources/projects/client.py +++ b/src/merge/resources/ticketing/resources/projects/client.py @@ -93,7 +93,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ticketing.projects.list() + client.ticketing.projects.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -214,6 +216,7 @@ def users_list( ) client.ticketing.projects.users_list( parent_id="parent_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) """ _response = self._raw_client.users_list( @@ -315,7 +318,9 @@ async def list( async def main() -> None: - await client.ticketing.projects.list() + await client.ticketing.projects.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -452,6 +457,7 @@ async def users_list( async def main() -> None: await client.ticketing.projects.users_list( parent_id="parent_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) diff --git a/src/merge/resources/ticketing/resources/roles/client.py b/src/merge/resources/ticketing/resources/roles/client.py index d026ac37..d4c63c42 100644 --- a/src/merge/resources/ticketing/resources/roles/client.py +++ b/src/merge/resources/ticketing/resources/roles/client.py @@ -91,7 +91,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ticketing.roles.list() + client.ticketing.roles.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -244,7 +246,9 @@ async def list( async def main() -> None: - await client.ticketing.roles.list() + await client.ticketing.roles.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ticketing/resources/sync_status/client.py b/src/merge/resources/ticketing/resources/sync_status/client.py index 91bbdd7e..4e7f6d88 100644 --- a/src/merge/resources/ticketing/resources/sync_status/client.py +++ b/src/merge/resources/ticketing/resources/sync_status/client.py @@ -57,7 +57,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ticketing.sync_status.list() + client.ticketing.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list(cursor=cursor, page_size=page_size, request_options=request_options) return _response.data @@ -117,7 +119,9 @@ async def list( async def main() -> None: - await client.ticketing.sync_status.list() + await client.ticketing.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ticketing/resources/tags/client.py b/src/merge/resources/ticketing/resources/tags/client.py index 34dbb860..74abf54f 100644 --- a/src/merge/resources/ticketing/resources/tags/client.py +++ b/src/merge/resources/ticketing/resources/tags/client.py @@ -91,7 +91,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ticketing.tags.list() + client.ticketing.tags.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -244,7 +246,9 @@ async def list( async def main() -> None: - await client.ticketing.tags.list() + await client.ticketing.tags.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ticketing/resources/teams/client.py b/src/merge/resources/ticketing/resources/teams/client.py index 0bf2170e..625edb78 100644 --- a/src/merge/resources/ticketing/resources/teams/client.py +++ b/src/merge/resources/ticketing/resources/teams/client.py @@ -91,7 +91,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ticketing.teams.list() + client.ticketing.teams.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -244,7 +246,9 @@ async def list( async def main() -> None: - await client.ticketing.teams.list() + await client.ticketing.teams.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ticketing/resources/tickets/client.py b/src/merge/resources/ticketing/resources/tickets/client.py index 6862ebf3..f942dea4 100644 --- a/src/merge/resources/ticketing/resources/tickets/client.py +++ b/src/merge/resources/ticketing/resources/tickets/client.py @@ -53,6 +53,7 @@ def list( contact_id: typing.Optional[str] = None, created_after: typing.Optional[dt.datetime] = None, created_before: typing.Optional[dt.datetime] = None, + creator_id: typing.Optional[str] = None, cursor: typing.Optional[str] = None, due_after: typing.Optional[dt.datetime] = None, due_before: typing.Optional[dt.datetime] = None, @@ -108,6 +109,9 @@ def list( created_before : typing.Optional[dt.datetime] If provided, will only return objects created before this datetime. + creator_id : typing.Optional[str] + If provided, will only return tickets created by this creator_id. + cursor : typing.Optional[str] The pagination cursor value. @@ -201,7 +205,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ticketing.tickets.list() + client.ticketing.tickets.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( account_id=account_id, @@ -212,6 +218,7 @@ def list( contact_id=contact_id, created_after=created_after, created_before=created_before, + creator_id=creator_id, cursor=cursor, due_after=due_after, due_before=due_before, @@ -462,6 +469,7 @@ def viewers_list( ) client.ticketing.tickets.viewers_list( ticket_id="ticket_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) """ _response = self._raw_client.viewers_list( @@ -606,7 +614,9 @@ def remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ticketing.tickets.remote_field_classes_list() + client.ticketing.tickets.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.remote_field_classes_list( cursor=cursor, @@ -648,6 +658,7 @@ async def list( contact_id: typing.Optional[str] = None, created_after: typing.Optional[dt.datetime] = None, created_before: typing.Optional[dt.datetime] = None, + creator_id: typing.Optional[str] = None, cursor: typing.Optional[str] = None, due_after: typing.Optional[dt.datetime] = None, due_before: typing.Optional[dt.datetime] = None, @@ -703,6 +714,9 @@ async def list( created_before : typing.Optional[dt.datetime] If provided, will only return objects created before this datetime. + creator_id : typing.Optional[str] + If provided, will only return tickets created by this creator_id. + cursor : typing.Optional[str] The pagination cursor value. @@ -801,7 +815,9 @@ async def list( async def main() -> None: - await client.ticketing.tickets.list() + await client.ticketing.tickets.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -815,6 +831,7 @@ async def main() -> None: contact_id=contact_id, created_after=created_after, created_before=created_before, + creator_id=creator_id, cursor=cursor, due_after=due_after, due_before=due_before, @@ -1094,6 +1111,7 @@ async def viewers_list( async def main() -> None: await client.ticketing.tickets.viewers_list( ticket_id="ticket_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -1264,7 +1282,9 @@ async def remote_field_classes_list( async def main() -> None: - await client.ticketing.tickets.remote_field_classes_list() + await client.ticketing.tickets.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ticketing/resources/tickets/raw_client.py b/src/merge/resources/ticketing/resources/tickets/raw_client.py index a0c646b9..5aac4f88 100644 --- a/src/merge/resources/ticketing/resources/tickets/raw_client.py +++ b/src/merge/resources/ticketing/resources/tickets/raw_client.py @@ -47,6 +47,7 @@ def list( contact_id: typing.Optional[str] = None, created_after: typing.Optional[dt.datetime] = None, created_before: typing.Optional[dt.datetime] = None, + creator_id: typing.Optional[str] = None, cursor: typing.Optional[str] = None, due_after: typing.Optional[dt.datetime] = None, due_before: typing.Optional[dt.datetime] = None, @@ -102,6 +103,9 @@ def list( created_before : typing.Optional[dt.datetime] If provided, will only return objects created before this datetime. + creator_id : typing.Optional[str] + If provided, will only return tickets created by this creator_id. + cursor : typing.Optional[str] The pagination cursor value. @@ -199,6 +203,7 @@ def list( "contact_id": contact_id, "created_after": serialize_datetime(created_after) if created_after is not None else None, "created_before": serialize_datetime(created_before) if created_before is not None else None, + "creator_id": creator_id, "cursor": cursor, "due_after": serialize_datetime(due_after) if due_after is not None else None, "due_before": serialize_datetime(due_before) if due_before is not None else None, @@ -702,6 +707,7 @@ async def list( contact_id: typing.Optional[str] = None, created_after: typing.Optional[dt.datetime] = None, created_before: typing.Optional[dt.datetime] = None, + creator_id: typing.Optional[str] = None, cursor: typing.Optional[str] = None, due_after: typing.Optional[dt.datetime] = None, due_before: typing.Optional[dt.datetime] = None, @@ -757,6 +763,9 @@ async def list( created_before : typing.Optional[dt.datetime] If provided, will only return objects created before this datetime. + creator_id : typing.Optional[str] + If provided, will only return tickets created by this creator_id. + cursor : typing.Optional[str] The pagination cursor value. @@ -854,6 +863,7 @@ async def list( "contact_id": contact_id, "created_after": serialize_datetime(created_after) if created_after is not None else None, "created_before": serialize_datetime(created_before) if created_before is not None else None, + "creator_id": creator_id, "cursor": cursor, "due_after": serialize_datetime(due_after) if due_after is not None else None, "due_before": serialize_datetime(due_before) if due_before is not None else None, diff --git a/src/merge/resources/ticketing/resources/users/client.py b/src/merge/resources/ticketing/resources/users/client.py index 4acf3693..d770ab9e 100644 --- a/src/merge/resources/ticketing/resources/users/client.py +++ b/src/merge/resources/ticketing/resources/users/client.py @@ -105,7 +105,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ticketing.users.list() + client.ticketing.users.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -278,7 +280,9 @@ async def list( async def main() -> None: - await client.ticketing.users.list() + await client.ticketing.users.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ticketing/types/__init__.py b/src/merge/resources/ticketing/types/__init__.py index b40b4709..272465d0 100644 --- a/src/merge/resources/ticketing/types/__init__.py +++ b/src/merge/resources/ticketing/types/__init__.py @@ -133,6 +133,7 @@ from .status_fd_5_enum import StatusFd5Enum from .sync_status import SyncStatus from .sync_status_last_sync_result import SyncStatusLastSyncResult +from .sync_status_status import SyncStatusStatus from .tag import Tag from .team import Team from .ticket import Ticket @@ -306,6 +307,7 @@ "StatusFd5Enum", "SyncStatus", "SyncStatusLastSyncResult", + "SyncStatusStatus", "Tag", "Team", "Ticket", diff --git a/src/merge/resources/ticketing/types/patched_ticket_request.py b/src/merge/resources/ticketing/types/patched_ticket_request.py index 01f0d4a9..d31860df 100644 --- a/src/merge/resources/ticketing/types/patched_ticket_request.py +++ b/src/merge/resources/ticketing/types/patched_ticket_request.py @@ -98,11 +98,6 @@ class PatchedTicketRequest(UncheckedBaseModel): tags: typing.Optional[typing.List[typing.Optional[str]]] = None roles: typing.Optional[typing.List[typing.Optional[str]]] = None - completed_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) - """ - When the ticket was completed. - """ - ticket_url: typing.Optional[str] = pydantic.Field(default=None) """ The 3rd party url of the Ticket. @@ -118,6 +113,11 @@ class PatchedTicketRequest(UncheckedBaseModel): * `LOW` - LOW """ + completed_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) + """ + When the ticket was completed. + """ + integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None remote_fields: typing.Optional[typing.List[RemoteFieldRequest]] = None diff --git a/src/merge/resources/ticketing/types/remote_field_class.py b/src/merge/resources/ticketing/types/remote_field_class.py index 033ea3b6..76189afe 100644 --- a/src/merge/resources/ticketing/types/remote_field_class.py +++ b/src/merge/resources/ticketing/types/remote_field_class.py @@ -17,6 +17,7 @@ class RemoteFieldClass(UncheckedBaseModel): remote_key_name: typing.Optional[str] = None description: typing.Optional[str] = None is_custom: typing.Optional[bool] = None + is_common_model_field: typing.Optional[bool] = None is_required: typing.Optional[bool] = None field_type: typing.Optional[RemoteFieldClassFieldType] = None field_format: typing.Optional[RemoteFieldClassFieldFormat] = None diff --git a/src/merge/resources/ticketing/types/role_ticket_access.py b/src/merge/resources/ticketing/types/role_ticket_access.py index bf10da43..33e407ac 100644 --- a/src/merge/resources/ticketing/types/role_ticket_access.py +++ b/src/merge/resources/ticketing/types/role_ticket_access.py @@ -4,4 +4,4 @@ from .ticket_access_enum import TicketAccessEnum -RoleTicketAccess = typing.Union[str, TicketAccessEnum] +RoleTicketAccess = typing.Union[TicketAccessEnum, str] diff --git a/src/merge/resources/ticketing/types/sync_status.py b/src/merge/resources/ticketing/types/sync_status.py index 4a628c4f..07ab1dc2 100644 --- a/src/merge/resources/ticketing/types/sync_status.py +++ b/src/merge/resources/ticketing/types/sync_status.py @@ -7,8 +7,8 @@ from ....core.pydantic_utilities import IS_PYDANTIC_V2 from ....core.unchecked_base_model import UncheckedBaseModel from .selective_sync_configurations_usage_enum import SelectiveSyncConfigurationsUsageEnum -from .status_fd_5_enum import StatusFd5Enum from .sync_status_last_sync_result import SyncStatusLastSyncResult +from .sync_status_status import SyncStatusStatus class SyncStatus(UncheckedBaseModel): @@ -27,7 +27,7 @@ class SyncStatus(UncheckedBaseModel): next_sync_start: typing.Optional[dt.datetime] = None last_sync_result: typing.Optional[SyncStatusLastSyncResult] = None last_sync_finished: typing.Optional[dt.datetime] = None - status: StatusFd5Enum + status: SyncStatusStatus is_initial_sync: bool selective_sync_configurations_usage: typing.Optional[SelectiveSyncConfigurationsUsageEnum] = None diff --git a/src/merge/resources/ticketing/types/sync_status_status.py b/src/merge/resources/ticketing/types/sync_status_status.py new file mode 100644 index 00000000..78e4cc47 --- /dev/null +++ b/src/merge/resources/ticketing/types/sync_status_status.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +from .status_fd_5_enum import StatusFd5Enum + +SyncStatusStatus = typing.Union[StatusFd5Enum, str] diff --git a/src/merge/resources/ticketing/types/ticket.py b/src/merge/resources/ticketing/types/ticket.py index 0a550a82..6b7963ba 100644 --- a/src/merge/resources/ticketing/types/ticket.py +++ b/src/merge/resources/ticketing/types/ticket.py @@ -126,6 +126,21 @@ class Ticket(UncheckedBaseModel): tags: typing.Optional[typing.List[typing.Optional[str]]] = None roles: typing.Optional[typing.List[typing.Optional[str]]] = None + ticket_url: typing.Optional[str] = pydantic.Field(default=None) + """ + The 3rd party url of the Ticket. + """ + + priority: typing.Optional[TicketPriority] = pydantic.Field(default=None) + """ + The priority or urgency of the Ticket. + + * `URGENT` - URGENT + * `HIGH` - HIGH + * `NORMAL` - NORMAL + * `LOW` - LOW + """ + remote_created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the third party's ticket was created. @@ -146,21 +161,6 @@ class Ticket(UncheckedBaseModel): Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). """ - ticket_url: typing.Optional[str] = pydantic.Field(default=None) - """ - The 3rd party url of the Ticket. - """ - - priority: typing.Optional[TicketPriority] = pydantic.Field(default=None) - """ - The priority or urgency of the Ticket. - - * `URGENT` - URGENT - * `HIGH` - HIGH - * `NORMAL` - NORMAL - * `LOW` - LOW - """ - field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None remote_data: typing.Optional[typing.List[RemoteData]] = None remote_fields: typing.Optional[typing.List[RemoteField]] = None diff --git a/src/merge/resources/ticketing/types/ticket_request.py b/src/merge/resources/ticketing/types/ticket_request.py index ed0e1ec4..e7639ad2 100644 --- a/src/merge/resources/ticketing/types/ticket_request.py +++ b/src/merge/resources/ticketing/types/ticket_request.py @@ -113,11 +113,6 @@ class TicketRequest(UncheckedBaseModel): tags: typing.Optional[typing.List[typing.Optional[str]]] = None roles: typing.Optional[typing.List[typing.Optional[str]]] = None - completed_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) - """ - When the ticket was completed. - """ - ticket_url: typing.Optional[str] = pydantic.Field(default=None) """ The 3rd party url of the Ticket. @@ -133,6 +128,11 @@ class TicketRequest(UncheckedBaseModel): * `LOW` - LOW """ + completed_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) + """ + When the ticket was completed. + """ + integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None remote_fields: typing.Optional[typing.List[RemoteFieldRequest]] = None